③清晰性
文档编写应力求简明,如有可能,配以适当的图 表,以增强其清晰性。
④完整性
任何一个文档都应当是完整的、独立的,它应自成体系 。例如,前言部分应作一般性介绍,正文给出中心内容 ,必要时还有附录,列出参考资料等。同一课题的几个文档之间可能 有些部分相同,这些重复是必要的。例如,同一项目的用户手册和操作
册中关于本项目功能、性能、实现环境等方面的描述是没有差别 的。特别要避免在文档中出现转引其它文档内容的情况。比如,一些段落并未具体描述,而用"见××文档××节"的方式,这将给 读者带来许多不便。
⑤灵活性
各个不同的软件项目,其规模和复杂程度有着许 多实际差别,不能一律看待。图6所列文档是针对中等规模的软件而言的。对于较小的或比较简单的项目,可做适当调整或合 并。比如,可将用户手册和操作手册合并成用户操作手册;软件需求说明书可包括对数据的要求,从而去掉数据要求说明书;概要设 计说明书与详细设计说明书合并成软件设计说明书等。
⑥可追溯性
由于各开发阶段编制的文档与各阶段完成的工作有着紧密的关系,前后两个阶段生成的文档,随着开发工作的逐步 扩展,具有一定的继承关系。在一个项目各开发阶段之间提供文档 必定存在着可追溯的关系。例如,某一项软件需求,必定在设计说明 书,测试计划以至用户手册中有所体现。必要时应能做到跟踪追查。