4、软件开发中纸质文档的适量把控

软件开发中纸质文档的适量把控

1. 文档陷阱与风险

在软件开发过程中，存在一些常见的文档陷阱需要我们警惕。
- 为文档而文档 ：若平时不习惯大量生成文档，却盲目投入到密集的文档制作流程中，只为了产出更多文档，这并非明智之举。一方面，人们只有看到文档真正能让事情变好而非变糟时，才会认可文档的价值；另一方面，如果不试验哪些文档对特定情况有用，哪些无用，就可能生成错误的文档。
- 未及时修改文档 ：随着项目推进，未能对所有文档进行修改以反映项目变化也是一个陷阱。有些文档（如白板上的草图）仅在短期内有助于开发者思考问题，无用时扔掉无妨，但关键是要确保过时的文档及时被丢弃。

创建无用文档会带来两大主要风险：
|风险类型|具体描述|
| ---- | ---- |
|资源浪费|投入资源创建无人关注的文档，造成资源的浪费。|
|误导他人|因文档无用而未及时更新，其中过时或错误的信息会误导后续人员。|

2. 无用文档的症状

当出现以下症状时，表明正在生成无用文档，或者未能从文档创建工作中获益：
1. 项目末期创建文档 ：文档在项目接近尾声时才创建，仅作为“文档资料”，而非用于支持设计过程。这种文档在开发过程中无法带来益处，不过若客户因特定原因要求将其作为软件交付物的一部分，则另当别论。
2. 文档缺乏关联性 ：设计包中的文档未与其他文档关联起来。例如，未对比状态图中的状态与实现的 case 语句元素，以确保状态没有意外遗漏或添加。
3.