为啥开发的文档能力是核心竞争力之一

在开发团队里面一般产品的文档能力会比较强，很多开发的文档能力都非常弱，在我看来文档能力是一个程序员核心竞争力之一，文档能力强才能实现能力的快速发展。为什么语文在中小学课程里面比重那么大，因为语言能力是一个人发展的基础，同理，文档能力就是开发过程当中的语言能力。

文档能力强的优势

文档能力强，则团队之间沟通会顺畅，而且不容易出现理解偏差。产品做文档关注的是功能设计，而开发做文档关注的是实现逻辑和结构，两个团队的侧重点不同。好的开发文档是可以准确的反应代码情况的，如果软件实现结构或者逻辑有问题，很容易在文档中就发现问题。我一直都希望程序员在编码之前能够先做个设计，把自己的思路通过流程图和其它图表展示出来，这样我就可以帮助他们发现其中设计问题以及需要关注的地方，比如哪些地方需要加入重试机制，哪些需要保证数据库的事务特性，数据表设计的是否合理，是否以后会出现性能瓶颈。这个做法的最大好处是把错误消灭在萌芽阶段，可以大大的提升开发效率，而且也可以让时间预估变得更加准确。但就这样一个思路，在实际操作的时候很难贯彻下去，因为程序员不知道怎么表达自己的思路。

本人感觉导致这种问题的原因有两个，一个是多数程序员习惯直线思维，想一步做一步，二是国内绝大多数公司不重视这方面能力的培养，而且管理层喜欢频繁施压，造成整个团队单纯求速度。这种拔苗助长的做法往往导致后期软件问题多多，真正是欲速而不达，后期浪费几倍的时间。而且因为制度问题，出现劣币驱逐良币的情况发现，下图就是一个程序员讲，写了文档导致容易被替换，反而容易丢掉工作。

如果前期有结构设计文档，则可以进行团队的集体评审，前端后台可以大大减少理解误差，产品开发测试都可以互相多重验证思路，尽量减少沟通理解偏差导致的结构设计问题，很多错误在后期发现往往是致命的，而且是花费多倍时间来弥补的。

文档能力对程序员自身也有巨大的好处，通过这种方式，可以理清自己的思路，让自己的思维变得更加缜密，让自己更加容易接受高手的指点，因为高手没有时间去看你的代码，你自己需要学会清晰表达自己的思路。这种文档可以当作一种知识积累的手段，可以时常去温习这些文档，避免忘记重要的知识点。我面试过很多人，有很多人在讲解项目的时候，思路极为混乱，一个可能性是自己没有真正做过，一个可能性就是自己没有总结，导致后来都忘记了，如果是后者，白白丧失了很多机会。

文档能力的基础条件

实现上面的文档沟通能力是需要一定基础条件的，而且不是一下子就能实现的，所以导致前期训练阶段会比较耗时间，这可能也是很多团队不愿意执行的原因。

要实现这个目标，团队需要一个优秀的教练，就和特种部队需要优秀教练一样。教练的作用就是制定团队培训计划，同时在文档方面给予指导，建立起团队的文档规范，需要在讨论会中对文档进行点评，促进文档质量的不断提升。文档能力是需要在实战中逐步培养起来的，是不能通过几节课就达到目标的。

团队成员需要学会全局思考能力，需要能够准确的表达自己的思路。在我们团队开始做这个工作的时候，很多程序员的流程图结构图和实际存在偏差，而且图形非常不直观，组织也非常没有逻辑性，连我这样资深的人员都很难理解到底是在表达什么意思。

流程图和结构图需要在团队之间建立起共识，建立起规范，让大家交流时候使用的是相通的语言，而不是各说各的，陷入一种互相抬杠的局面。

举例对比优质文档和劣质文档

下面截图是一些可读性差的流程图，排版不好看不清，编排组织混乱。

调整后的结构图，把模块进行和概括表达，总体架构变得简单清晰。

这个结构图还有一个缺陷没有表达出本次调整修改的部分，通过颜色就可以清晰的表达出来，比如指定某种边框颜色。图表表达是一门学问，我们需要用最简的结构表达出最多的信息。

下面截图是团队一个后台的文档，对业务逻辑表达使用了文字，没有使用流程图，导致非常不直观，非常难阅读，一眼看上去都是混乱。

下图是阿里资深后台专家的文档，非常清晰直观，而且很简洁。

怎么样锻炼自己的文档能力

不要把做文档当成一个任务，需要养成一种习惯。在团队讨论会上，我发现平时做日报好的人，第一次写文档就非常清晰有条理，写日报不好的人，文档也不好。所以文档能力展示出了一个人的工作习惯是否有条例，是否缜密。

如果文档能力不强，不要怕花时间，学习一种本事都是需要花时间的，文档能力不行，开始当然是需要花时间的呀。文档能力差的人常常托词自己工作太忙，没有时间来做这个，但下班以后很快就离开了公司，显然，很多人态度上是不够重视的。我批评他们说，文档是给你自己做的，不是给公司做的，差的文档能力会始终限制一个程序员思维能力的发展。

总结

重视文档能力，就是为自己的提升打开新的一道门，文档是开发者的语言。如果喜欢这篇文章，就请关注我，持续发送干货，同时也帮我转发一下啦。