达到何种级别的质量水平;
何时产生何种文档;
如何保存、维护文档以及如何进行通信。
如果一个软件合同是有效的,应要求文档满足所接受的标准,并规定所提供的文档类型、每种文档的质量水平以及评审和通过的规程。
6 制订文档编制策略
文档策略是由上级(资深)管理者新任务并支持的,对下级开发单位或开发人员提供指导。策略规定主要的方向不是做什么或如何做的详细说明。
一般说来,文档编制策略陈述要明确,并通告到每个人且理解它,进而使策略被他们贯彻实施。
支持有效文档策略的基本条件:
a) 文档需要覆盖整个软件生存期
在项目早期几个阶段就要求有文档,而且在贯穿软件开发过程中必须是可用的和可维护的。在开发完成后,文档应满足软件的使用、维护、增强、转换或传输。
b) 文档应是可管理的
指导和控制文档的获得维护,管理者和发行专家应准备文档产品、进度、可靠性、资源,质量保证和评审规程的详细计划大纲。
c) 文档应适合于它的读者
读者可能是管理者、分析员、无计算机经验的专业人员、维护人员、文书人员等。根据任务的执行,他们要求不同的材料表示和不同的详细程度。针对不同的读者,发行专家应负责设计不同类型的文档。
d) 文档效应应贯穿到软件的整个开发过程中
在软件开发的整个过程中,应充分体现文档的作用和限制,即文档应指导全部开发过程。
e) 文档标准应被标识和使用
应尽可能地采纳现行的标准,若没有合适的现行标准,必要时应研制适用的标准或指南。
f) 应规定支持工具
工具有助于开发和维护软件产品,包括文档。因此尽可能地使用工具是经济的、可行的。
附录A中的检查表为制定策略条款或评估现有策略条款的有效性和完整性提供帮助。
7 制订文档编制标准和指南
在一个机构内部,应采用一些标准和指南:
——软件生存期模型;
——文档类型和相互关系;
——文档质量。
这些标准和指南决定如何实现文档任务,将提供一些准则以评价机构内所产生的软件文档的完整性、可用性和适合性。
尽可能地采用现行的国家和国际标准,若现行的标准不适用,机构应制订自己的标准。
7.1 选择软件生存期模型
现有的一些软件生存期模型,对于不同的阶段有不同的词汇,从软件文档的观点来看,采用哪种模型都无关紧要,只要阶段和相应的文档是清晰定义的、已计划的,并且对于任何具体软件项目是能遵循的。因此,管理者应选择一个软件生存期模型并保证该模型在他们机构内是适用的。
管理者将会发现所进行的阶段和相应任务的定义有助于监控软件项目的进展。相应于特定阶段生成的文档可用作该阶段的评审、通过和完成的检验点,而这种检验应在下一阶段开始前进行。
7.2 规定文档类型和内容
下面给出软件文档主要类型的大纲,这个大纲不是详尽的或最后的,但适合作为主要类型软件文档的检验表。而管理者应规定何时定义他们的标准文档类型。
软件文档归入如下三种类别:
a) 开发文档——描述开发过程本身;
b) 产品文档——描述开发过程的产物;
c) 管理文档——记录项目管理的信息。
7.2.1 开发文档
开发文档是描述软件开发过程,包括软件需求、软件设计、软件测试、保证软件质量的一类文档,开发文档也包括软件的详细技术描述(程序逻辑、程序间相互关系、数据格式和存储等)。
开发文档起到如下五种作用:
a) 它们是软件开发过程中包含的所有阶段之间的通信工具,它们记录生成软件需求、设计、编码和测试的详细规定和说明;
b) 它们描述开发小组的职责。通过规定软件、主题事项、文档编制、质量保证人员以及包含在开发过程中任何其他事项的角色来定义做直截了当、如何做和何时做;
c) 它们用作检验点而允许管理者评定开发进度。如果开发文档丢失、不完整或过时,管理者将失去跟踪和控制软件项目的一个重要工具;
d) 它们形成了维护人员所要求的基本的软件支持文档。而这些支持文档可作为产品文档的一部分;
e) 它们记录软件开发的历史。
基本的开发文档是:
——可行性研究和项目任务书;
——需求规格说明;
——功能规格说明;
——设计规格说明,包括程序和数据规格说明;
——开发计划;
——软件集成和测试计划;
——质量保证计划、标准、进度;
安全和测试信息。
7.2.2 产品文档
产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。
产品的文档起到如下三种作用:
a) 为使用和运行软件产品的任何人规定培训和参考信息;
b) 使得那些未参加开发本软件的程序员维护它;
c) 促进软件产品的市场流通或提高可接受性。
产品文档用于下列类型的读者:
——用户 ——他们利用软件输入数据、检索信息和解决问题;
——运行者 ——他们在计算机系统上运行软件;
——维护人员 ——他们维护、增强或变更软件。
产品文档包括如下内容:
——用于管理者的指南和资料,他们监督软件的使用;
——宣传资料 通告软件产品的可用性并详细说明它的功能、运行环境等;
——一般信息 对任何有兴趣的人描述软件产品。
基本的产品文档包括:
——培训手册;
—
www.suxue6.com —参考手册和用户指南;——软件支持手册;
——产品手册和信息广告。
7.2.3 管理文档
这种文档建立在项目管理信息的基础上,诸如:
——开发过程的每个阶段的进度和进度变更的记录;
——软件变更情况的记录;
——相对于开发的判定记录;
——职责定义。
这种文档从管理的角度规定涉及软件生存的信息。
相关文档的详细规定和编写格式见GB 8567。