一般说来,文档编制策略陈述要明确,并通告到每个人且理解它,进而使策略被他们贯彻实施。
支持有效文档策略的基本条件:
a) 文档需要覆盖整个软件生存期
在项目早期几个阶段就要求有文档,而且在贯穿软件开发过程中必须是可用的和可维护的。在开发完成后,文档应满足软件的使用、维护、增强、转换或传输。
b) 文档应是可管理的
指导和控制文档的获得维护,管理者和发行专家应准备文档产品、进度、可靠性、资源,质量保证和评审规程的详细计划大纲。
c) 文档应适合于它的读者
读者可能是管理者、分析员、无计算机经验的专业人员、维护人员、文书人员等。根据任务的执行,他们要求不同的材料表示和不同的详细程度。针对不同的读者,发行专家应负责设计不同类型的文档。
d) 文档效应应贯穿到软件的整个开发过程中
在软件开发的整个过程中,应充分体现文档的作用和限制,即文档应指导全部开发过程。
e) 文档标准应被标识和使用
应尽可能地采纳现行的标准,若没有合适的现行标准,必要时应研制适用的标准或指南。
f) 应规定支持工具
工具有助于开发和维护软件产品,包括文档。因此尽可能地使用工具是经济的、可行的。