技术经理成长复盘-文档
Posted Sam_Deep_Thinking
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了技术经理成长复盘-文档相关的知识，希望对你有一定的参考价值。
概述
我是直到最近才深深体会到好的文档确实非常的重要，好的文档是团队的一种知识沉淀，是判断一个团队是否成熟其中一个关键标志。知识库的水准基本可以衡量这个团队的水准如何了。很多业务和技术知识点，非常的分散，都藏着各个组员的脑子里了，这会有几个问题：
- 新人入职的时候，你只能在白板上，不断告知他业务是怎么样的，在这种业务场景下，我们当前的技术设计是如何匹配的，这个对新入融入速度非常有影响的；
- 人的记忆是短暂的，过段时间，就会把自己认为已经深刻理解的知识点，忘记的差不多了，只能通过看代码才能慢慢的回忆起来；
- 当有问题发生的时候，你只能不断去问人，有可能是得一下子问好几个人，才能有个完整性的答案，极大的降低了解决问题的速度，真的是费时费力，效率低下，我们只不过是想整体性的了解一下而已，都得费好大劲；
好的文档多了，便会形成一个知识库，从长期来看，对团队和公司是非常有利的。打造一个好的知识库，是绝对正确的决策，必须长期投入和坚持去做。过了几年后，你会发现可能你做的唯一一件有价值的事情，便是有了一个好的知识库。
图文
我个人是不太喜欢，一打开文档，扑面而来的就是一张张的业务、技术架构图，图很多但文字基本没有，且图还画的很复杂不容易看懂。
- 图，有几个作用，一个是大家在一起分析问题的时候，会比文字更加的直观和清晰。另外一个是比较容易展现主脉络和元素之间的主要依赖关系，对于只想知道整体主流程的，不关心细节的，图的表现力会强很多；
- 文字，像描述背景，问题、细节的，文字会更加的合适；
- 图文结合，只有图或者只有文字，表现力都不如图文结合。
对于技术团队来说，你想说清楚某个业务，大的框架可以是如下的格式：
- 用图文描述清楚当前业务；
- 用图文描述在当前的业务场景下，技术设计是如何支撑业务的；
- 说清楚当这块业务出现问题的时候，具体的影响是什么，以及如何处理，这个也是非常关键的，是可以直接提高处理问题的速度的，同时也让阅读文档的人认识到，这块业务出问题，影响范围到底多大，能从整体上去考虑需求PRD、运营和技术设计等。
描述业务的时候，可以按照自己当前的理解，先写一版，然后多跟组员、产品、测试、运营沟通，必要的时候，去看代码。想办法补齐场景，具备完整性。后面当有新的需求涉及到这块业务的，也记得及时的更新上去，这个维护的成本是少不了的。在描述业务的时候，不要去使用任何技术的字眼，就是业务。
描述技术如何支持业务的时候，是可以详细一些的，从大方向的技术方案，到表设计，都可以描述出来。同时在业务不变的情况下，技术架构变了，也是要及时维护上去的。
一旦某个模块业务的文档写好了，除了对自己本团队有用外，其他职能小组过来询问这块业务的时候，你就是一个动作就好了，把文档扔过去，可以尽量减少一些没必要的干扰。我是遇到过这种情况的，某个业务团队的人同一个问题，问了我不下6次，且每次问的人还都是不同的，真的非常影响我自己的工作效率。当时要是有个良好的文档，那该多好呀。
不要被绑架了
不能只是只有某一两个人懂某块模块的业务和技术，出了事，只有固定的几个人知道怎么处理。这样的话，就相当于被绑架了，要是这几个人都不联系不到呢，出了问题，有时候就会一些摸不着北。有好的靠谱的文档，就会有好的知识库，就能比较有效的解决这个问题。
有了好的知识库，做好沉淀和分享，还能提高组织机动性的效果，随时可以派人支持其他的业务模块，增大组织处理需求的吞吐量。虽然都在谈组织要能机动，但是机动前，最好是有分享或者文档，让大家平时都对其他业务模块有了解过，贸然的就去做不熟悉的业务模块，风险高且未必有效率。
降低人员流动带来的影响
在互联网公司里，人才流动还是比较快的，可能一个三五年下来，团队的人都换的差不多了，因此有一个知识传承的问题需要去解决。要重视知识沉淀，降低人员流动带来的传承问题。虽然构建一个良好的知识文档库，是一个费时费力且麻烦的工作，但是团队领导者必须清楚意识到做这块的重要性，需要耐心的持续的去做，做好这件事情无论是对新入、老人、团队、部门还是公司都是长期有利的事情。
小结
好的文档知识库，能传承知识，能提高解决问题的效率，也能提到沟通的效率，同时写文档的过程中，也是一个思考和复盘的过程对团队而言，是一件非常重要且需要长期去做的事情。
欢迎关注本专栏
感谢。
以上是关于技术经理成长复盘-文档的主要内容，如果未能解决你的问题，请参考以下文章