92、嵌入式软件开发文档的生成与管理

嵌入式软件开发文档的生成与管理

1. 团队协作与文档的替代关系

有人认为紧密的团队协作可以成功替代文档的创建，在一定程度上这是正确的。例如，一个小团队紧密合作，其效率可能等同于一个能在开发过程中记住所有细节的开发者。采用交叉检查式的开发方式，如结对编程，在实际实现阶段可能可以减少一些文档工作。然而，对于大型、长期的项目，可扩展性仍然是一个重要问题。

当团队解散、开发完成后，代码仍需继续维护时，问题就出现了。对于仅存活几周或几个月的应用程序，这可能没问题，因为开发者不会立刻忘记知识。但随着时间推移，开发者可能会忘记细节、更换工作、退休、中彩票、遭遇意外等，无法提供未记录下来的所有细节。许多嵌入式系统需要运行数年甚至数十年，在这样的时间尺度上，缺乏文档的弊端就会显现出来。

2. 确定文档生成量的方法

很难给出一个精确的公式来确定应该生成多少文档，但让开发团队制定一个文档生成计划，至少可以使决策更明智。需要在纸上明确文档的项目和详细程度，这是软件开发计划的重要组成部分。至少需要一个简单的文档列表，以及每个文档应包含的内容。例如，“所有客户需求应逐项列出”和“每个组件都应有设计”。

以下是一些决定文档生成量的建议：
- 假设原开发者离职后你接手项目，你希望有多少文档？
- 假设你每小时都要面对客户因软件故障导致其业务中断而发出的抱怨，同时你即将带着家人去度一个承诺已久且机票不可退的假期，你需要多少文档来解决问题？
- 从下一节的列表开始，根据实际情况添加或删除元素。生成的所有文档必须包含（或几乎包含）这些修改后列表中的所有元素。
- 可以设置文档长度的上限，以减少过多文档带来的问题。
- 可以决