7.1  文档化的重要性

7.1 文档化的重要性

软件文档也称为软件文件，是一种重要的软件工程技术资料，如技术文档、设计文档、操作规范等，如图7-1所示。

图7-1 系统文档结构

文档在项目开发中的作用主要如下。

①产品规格设计的可视化。

②项目管理的依据。

③技术交流的语言。

④提高评审的品质与效率。

⑤培训与维护的资料。

⑥项目品质的保证。

软件文档的本质作用是连接软件开发方、管理人员、客户及计算机的桥梁和纽带，使它们构成一个相互影响、相互作用的整体。各阶段软件文档是前阶段工作成果的体现，也是后阶段工作的依据。软件管理人员可通过这些软件文档了解软件开发计划、进度、资源使用和成果等。

软件产品有自身的品质特性要求，作为其重要组成部分的文档，同样也有其自身品质特性，如图7-2所示。

图7-2 文档品质特性

根据图7-2所示的文档品质特性，在完成文档设计后进行自我评审时要注意以下几点。

①格式是否正确（排版、空格、编号、各种线）。

②打印格式下的各种画线是否完整，有无文字显示不清，文字是否超出打印范围。

③用词是否统一（术语是否一致）。

④有无重复设计。

⑤有无多余设计。

⑥前后逻辑顺序是否矛盾。

⑦必要文档信息是否齐全。

⑧内容是否清晰易懂（不要有歧义，说明要详细）。