【畅言】程序员既要写好代码，又要写好文档

发表于

allowtransparency="true" frameborder="0" scrolling="no" src="http://hits.sinajs.cn/A1/weiboshare.html?url=http%3A%2F%2Fwww.youkuaiyun.com%2Farticle%2F2014-08-12%2F2821148&type=3&count=&appkey=&title=%E7%A8%8B%E5%BA%8F%E5%91%98%E6%98%AF%E5%90%A6%E5%BA%94%E8%AF%A5%E6%B3%A8%E9%87%8D%E6%96%87%E6%A1%A3%E7%9A%84%E7%BC%96%E5%86%99%EF%BC%9F%E8%BF%99%E6%98%AF%E4%B8%80%E4%B8%AA%E7%9C%8B%E4%BC%BC%E5%BE%88%E5%B0%8F%E4%BD%86%E5%8D%B4%E6%AF%94%E8%BE%83%E9%87%8D%E8%A6%81%E7%9A%84%E9%97%AE%E9%A2%98%E3%80%82%E8%BD%AF%E4%BB%B6%E9%99%A4%E4%BA%86%E7%A8%8B%E5%BA%8F%E5%92%8C%E6%95%B0%E6%8D%AE%E5%A4%96%EF%BC%8C%E8%BF%98%E5%8C%85%E6%8B%AC%E6%96%87%E6%A1%A3%E3%80%82%E5%85%B6%E6%AC%A1%EF%BC%8C%E5%A6%82%E6%9E%9C%E7%A8%8B%E5%BA%8F%E5%91%98%E5%8F%AA%E6%98%AF%E4%BC%9A%E5%86%99%E7%A8%8B%E5%BA%8F%EF%BC%8C%E4%B8%8D%E8%83%BD%E5%9C%A8%E6%96%87%E6%A1%A3%E4%B8%AD%E6%81%B0%E5%BD%93%E4%B8%94%E4%BC%98%E9%9B%85%E5%9C%B0%E6%8F%8F%E8%BF%B0%E8%87%AA%E5%B7%B1%E7%9A%84%E6%83%B3%E6%B3%95%EF%BC%8C%E9%82%A3%E4%B9%88%E5%B0%B1%E7%9C%9F%E7%9A%84%E6%98%AF%E2%80%9C%E7%A0%81%E5%86%9C%E2%80%9D%E4%BA%86%E3%80%82&pic=&ralateUid=&language=zh_cn&rnd=1429627003736" width="22" height="16" data-garbage="true"> 摘要：程序员是否应该注重文档的编写？这是一个看似很小但却比较重要的问题。软件除了程序和数据外，还包括文档。其次，如果程序员只是会写程序，不能在文档中恰当且优雅地描述自己的想法，那么就真的是“码农”了。

最近，优快云在举办“2014 优快云博文大赛”活动。我看本次活动中的一些参赛作品条理清晰、文笔流畅、语言优美，大都出自程序员之手。我不禁想到一个问题：程序员是否应该注重文档的编写？

写文档的重要性

对于软件相关行业，在学校或单位大家也许都已经注意到了，除了要编写的程序、绘制设计图之外，还有一个重要的工作便是写文档。为什么要写文档呢？因为我们要把自己做的东西展示出来，不光展示给同行看，可能还要展示给其他岗位上的工作人员看，甚至展示给用户看。如果我们只是会写程序，不会在文档中恰当且优雅地描述自己的想法，那么就真正的成为“码农”了。

我注意了一下，周围的同事会写高质量文档的确实很少。李开复老师在《浪潮之巅》的序言中说到：“我认识很多顶尖的工程师，但具备强大叙事能力的优秀工程师，我认识的可以说是凤毛麟角。”确实，我所认识的同事，能够在文档中清晰地表达自己想法的也很少。

有关文档书写，我印象很深的问题有如下几个方面：

1. 我们每天都会收发很多邮件，我仔细看了一下，很多邮件里面的内容要么语句不通顺、要么有很多错别字、要么误用或没有标点符号。很多时候，从不同的角度理解，一封邮件有很多不同的意思，让人感觉不知道它究竟要表达一个什么意思，这样极大地降低了工作的效率。
2. 除了代码之外，项目也会包含了大量的文档。打开大部分文档，看到的第一眼，我就有这几种感觉：排版不工整、格式不正确、语句不通顺、错别字连篇。一看就知道作者没有认真写文档，并且语句的表达和组织能力也不强。
3. 在项目小组成员讨论的时候，大家几乎都在说怎样把程序写好，而没有提到在文档书写方面应如何努力去改进。大家似乎一致认为开发人员的职责就是把程序写好，其它什么的都是其次的。

有关计算机软件的传统定义为：软件是计算机系统中与硬件相依存的另一部分，软件包括程序、数据及其相关文档的完整集合。注意，这里面就提到了“相关文档”，如果文档没有写好，那么软件也不能算是优秀的软件。事实上，软件功能健全，而由于文档原因出现故障的情况还时有发生。

一般说来，在软件开发过程中，不同阶段涉及到的主要文档如下图所示：

可见，在软件的不同阶段，需要编写不同的文档。在计划阶段，需要编写详细设计文档、单元测试方案文档和集成测试方案文档等；在开发阶段，也是这几个文档，不过是修订版，因为我们在实际开发过程中，会发现之前设计不合理的地方或者是考虑不周的地方，这就需要对之前的文档进行修改；在测试阶段，要编写单元测试报告、集成测试报告和系统测试报告等；在软件的发布阶段，要编写安装手册、用户手册、升级指导书等，这些文档主要是面向现场支持人员和用户的，因此要尽量写得通俗易懂，千万不要有模棱两可的情况存在，否则就只有等待用户的投诉了。

要想写好文档，我们需要首先纠正一个观念：文档不重要。要把文档放在与程序同等重要的位置。

如何写出高质量文档？

那么，我们如何才能写出高质量的文档呢？我认为可以从如下几个方面着手：

1. 改变文档为辅的观念，在平常的工作中，对于自己编写的每一份文档，均认真对待。
2. 对于邮件的编写，要把自己想说的话准确地表达出来，在发送邮件之前，再看一下内容是否完整、是否还有错别字、语句是否通顺等。
3. 在编写文档的过程中，要严格参照项目组规定的模板来完成。在写完文档之后，对文档进行语法检查，以纠正错别字和有语法错误的地方。一般说来，有语法错误的语句下面会有一条绿色的波浪线。在提交文档之前，再通读一下整个文档，看是否还有疏漏和不足。
4. 在工作之余，可以读一些能够提高语言表达能力和写作能力的书籍或文章，看一下别人是怎样清晰地阐述自己思想的。例如，经常阅读优快云上面优秀博主的博文就是一个提高自己写作能力的好办法。

总的说来，和做其它事情一样，书写文档也反映了一个人的态度问题。写出高质量的文档，不仅可以提升个人的形象（如果你看到一篇好文档，是不是也对作者有较高的评价？），还能够提升产品在客户心中的形象。如此分析，多花些心思来书写文档真的是很有必要。