每一位程序员都应该提高文档编写能力

在软件界，程序员不愿写文档和写不好文档已经成为普遍现象：

• 一是不愿写
  为什么不愿写呢？程序员们的理由很多，最主要的一条是：写文档浪费时间，有写文档的时间代码都写完了！当然，还有一个不能说的原因：懒惰啊。
• 二是写不好
  当然，偶尔他们也会写文档，但写的文档实现在是惨不忍睹…别以为只有一般程序员菜鸟才会这样，即便是工作好几年的老司机、部门经理、一些所谓的架构师也会如此！

类似的场景，你是否遇见过：

• 某公司部门经理兼架构师，带着20来人的团队，写个开发文档，反复修改好几次，还是能省则省，惜墨如金；并且文档几乎全是文字，只有一张简单的流程图，让再改直接告诉你不知道如何改了，问你想做成啥样？…
• 某工作好几年的老司机写的说明文档，除了截图还是截图几乎不写文字，排版混乱、逻辑混乱、文字（句子）不通顺等等…

其实，成为PPT架构师固然不好，但成为只会码程序，无法向同事、老板、客户有效解释、阐述你的意图、计划的技术人，你觉得好吗？

一个项目通常要包含的文档：

1、项目实施（开发）计划和方案
2、软件需求规格说明书
3、软件设计说明书（概要设计、详细设计）
4、数据库设计文档
5、测试文档（测试计划、测试报告，包括功能测试、性能测试及安全性测试等）
6、管理员操作手册
7、安装部署手册
8、用户使用手册
9、试运行报告
10、用户培训文档（培训计划、培训报告）
11、项目开发总结报告

对照着上面的清单，你看看写过几个？上面加粗的那些内容，通常都是技术经理、架构师、主力程序员来完成的，其他部分各公司分工不同，会各有差别。

所谓 “磨刀不误砍柴工”，如果一个项目有较为清晰、有效的文档，既有利于控制风险、方便交流、后续维护，也有利于分工合作、计划的推进、进度控制。

如果想成为架构师或或将来走上管理岗位，文档编写能力也是必备的素质；否则，你带的项目只要稍微大点，失去控制是大概率事件；团队成员难以管理、考核也是大概率事件。

访问最新文章，请关注微信公众号：