人月神话阅读笔记03

不同用户需要不同级别的文档。某些用户仅仅偶尔使用程序，有些用户必须依赖程序，还有一些用户必须根据环境和目的的变动对程序进行修改。在需要什么样的文档一段从使用程序，验证程序和修改程序三个方面来谈如何写文档，文档内容应该包含哪些核心要素。使用程序方面的文档发生在程序编写前，要描述清楚程序的目的，范围，场景，输入，输出等各项重要内容。每一个发布的程序需要附加验证说明，即准备我们常做的测试用例，这个发生在验证测试阶段。最后，调整程序或者修复程序需要更多的信息。显然，这要求了解全部的细节，并且这些细节已经记录在注释良好的列表中。

流程图是被吹捧得最过分的一种程序文档。事实上，很多程序甚至不需要流程图，很少有程序需要一页纸以上的流程图。现实中，流程图被鼓吹的程度远大于它们的实际作用。