为什么要书写文档

很常见的情况是，开发人员对于书写文档有种种非议，但是一个正规的软件项目，即使
带来了表面上的工作效率降低，也必须花费精力书写文档，为什么呢？
任何时候，只要是两个人以上参与项目，都离不开口头交流，但是每个人在传递这个口
头交流的内容的时候，都会把原来的意思歪曲一点点，人类的记忆能力就是这样的。一个软
件项目永远离不开口头交流，我们不必要去停止这种交流方式，但是当开发人员比较多的时
候，就可能带来很多麻烦，某些情况需要大家都知道，需要其他人员与之交互等等，解决的
办法就是把所有的情况记录下来，或者是要强调书写文档。利用文档记录有五个好处：
1）拓展人脑所掌握的记忆范围
在任何一个大到必须编写文档的项目中，信息的含量都会超过一个人可以掌握的规模，
书面文字可以供将来参考，而不会像记忆一样慢慢的褪去。
2）为项目团队所有成员提供相同的信息
书面文档阅读的时候内容是相同的，所有的人员都阅读相同的材料，这是任何人对人的
口头交流无法达到的效果。
3）减少项目人员流动的困难
项目中发生人事变动是正常的，当老成员离开，新成员加入的时候，任何口头交流都很
难让人很快地掌握情况，一份很好的文档可以让他花更少的时间融入到团队中去。
4）保护智力资产
在大多数情况下，项目中只有少数的人理解问题域，他们知道是否需要变更，软件是否
存在某些漏洞，内心中对软件是不是有什么新观点。如果这些人把他们掌握的信息以正规的
方式记录下来，项目对他们的依赖就会减小，如果他们获得了更好的机会，他们的智力资产
也不会被带走。
5）帮助书写人员更好的理解问题域
以书面形式描述设计方案，将促使相关人员花精力以比口头交流更标准和更准确的方式
表达。人们在写作过程中可以发现自己对某些问题的理解存在漏洞，甚至概念上也是不完整
的。难怪人们说：“文档本身并不重要，重要的是写文档的过程。”当然，这样写出来的文档
对别人也是重要的。
很多公司实际上是很严肃地对待文档的，但他们并没有从文档中得到好处，相反在实践
中口头交流仍然是主要手段，其关键原因是所书写的文档并不是为了开发而是为了应付检
查。从格式上看很漂亮，内容面面俱到，但在文档组织上把信息分散到各个地方，不容易查
找，使文档提供的好处尽失。如果我们希望项目开发小组很好的使用文档中的信息，就需要
考虑什么内容是开发小组最关注的，怎么组织文档才是对开发来说最容易查找，如何编写才
是最容易阅读和有效的