怎么写项目文档

如果从代码的质量（见“章老师说”公众号历史文章，《代码的艺术》中“一流代码的特性”）考察，我估计中国互联网圈合格的程序员不会超过20%。

如果从项目文档的角度考察，中国互联网圈合格的程序员大概不会超过10%。和代码比起来，项目文档是一个更加严重的问题 -- 几乎所有人都会认为代码是一个软件项目的产出；而只有很少的人会同意，文档也是一个软件项目的重要（甚至是不可或缺的）产出。

记得和某外国公司的同行（也是中国人）聊起这个话题。

“你们需要写设计文档吗?”，我问。

“当然了，而且设计文档一定会经过严格的review”,对方答。

“那你在这里一定会感觉震惊的，很多即使是基础架构的系统都没有严格的设计文档”。当我告诉对方这个情况的时候，我也很清楚，这绝对不是一家公司的个案，而是一个普遍的情况。

为什么会出现这样的局面？

这个问题困扰了我差不多20年，到今天，还在困扰我。

看着这么多不会写文档的同行，我感到的是忧虑。为他们的career path感觉忧虑。“你会遭遇中年危机的！”我多次这样说。

我知道这么小小的一篇文章并不会改变什么。如果能够使一个做程序员的同行能够建立一点儿正确的意识，如果使一个做管理的同行不再认为写文档是浪费时间，那也就可以了。

谢谢关注微信公众号 章老师说

教育、学习、思考、实践，为了一个更好的中国