92、嵌入式软件开发文档的重要性与创建指南

嵌入式软件开发文档的重要性与创建指南

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

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

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

2. 确定文档数量的建议

很难给出一个精确的公式来确定应该生成多少文档。但开发团队制定一个文档创建计划，至少可以让决策更加明智。具体来说，需要在纸上明确文档（文档资料）的项目和详尽程度。这是软件开发计划的重要组成部分，至少需要一份简单的文档列表以及每个文档应包含的内容。

以下是一些决定文档数量是否足够的建议：
- 换位思考 ：假设原开发者离职后，你接手项目，你希望有多少文档？再假设你面临客户每小时都在催促修复导致其业务瘫痪的 bug，而你明天早上又有不可退款的机票，要带家人去承诺已久的度假。
- 定制列表 ：从后续章节的列表开始，根据实际情况添加或删除元素。所有生成的文档必须包含（或几乎包含）这些修改后列表中的所有元素。
-