软件工程 第4版 作者 张海藩 吕云翔 编著 14.pptVIP

14.2 软件文档 另一方面，文档在团队的开发中起到了重要的协调作用。它告诉每个成员应该做什么，不应该做什么，应该按着怎样的要求去做，以及要遵守哪些规范。此外，还有一些与用户打交道的文档成为用户使用软件产品时最得力的助手。 14.2 软件文档 (1) 及时性。 在一个阶段的工作完成后，此阶段的相关文档应该及时地完成，而且开发人员应该根据工作的变更及时更改文档，保证文档是最新的。可以说，文档的组织和编写是不断细化、不断修改、不断完善的过程。 14.2 软件文档 (2) 完整性。 应该按有关标准或规范，将软件各个阶段的工作成果写入有关文档，极力防止丢失一些重要的技术细节而造成源代码与文档不一致的情况出现，从而影响文档的使用价值。 14.2 软件文档 (3) 实用性。 文档的描述应该采用文字、图形等多种方式，语言准确、简洁、清晰、易懂。 (4) 规范性。 文档编写人员应该按有关规定采用统一的书写格式，包括各类图形、符号等的约定。此外，文档还应该具有连续性、一致性和可追溯性。 14.2 软件文档 (5) 结构化。 文档应该具有非常清晰的结构，内容上脉络要清楚，形式上要遵守标准，让人易读、易理解。 (6) 简洁性。 切忌无意义地扩充文档，内容才是第一位的。充实的文档在于用简练的语言，深刻而全面地对问题展开论述，而不在于文档的字数多少。 14.2 软件文档 14.2 软