4、如何把握文档数量的度

如何把握文档数量的度

在软件开发过程中，文档的使用是一个关键环节。适量的文档能够为设计提供有力支持，然而过多的文档则可能造成资源浪费。接下来，我们将深入探讨如何确定合适的文档数量，避免无用文档的产生。

1. 概述

在软件开发中完全不生成文档（包括电子文档）并非明智之举，但单纯为了有文档而增加文档数量也不一定是好事。我们需要根据自身情况，仔细考量合适的文档数量。

1.1 保留有用文档的重要性

避免无用文档的难点在于准确判断哪些文档是真正无用的。人们很容易在未客观评估的情况下，就宣称某份文档无用。例如，负责创建文档的人可能更愿意花时间编写代码或者按时下班。

真正有用的文档在避免问题和优化开发流程方面能起到重大作用。但创建文档需要投入时间和资金，所以我们要确保生成的每份文档都有价值。如果文档无用，要么想办法让它变得有用，要么直接舍弃。多数情况下，让文档变得有用是更好的选择，但有时舍弃文档也是最佳策略，关键在于准确判断具体情况。

1.2 可能出现的症状

当出现以下症状时，说明你生成的文档可能是无用的，或者未能从创建文档的努力中获得益处：
- 项目后期创建文档 ：文档在项目接近尾声时才创建，仅作为“记录”而非用于支持设计过程。这种文档在开发过程中无法发挥作用，不过如果客户因特定原因要求交付此类文档，则另当别论。
- 文档未关联 ：设计包中的文档未与其他文档建立关联。例如，没有将状态图中的状态与实现代码中的 case 语句元素进行对比，以确保状态没有意外遗漏或添加。
- 文档未及时更