软件开发文档规范.ppt

《软件开发文档规范.ppt》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、软件开发文档规范×××工程软件专家组何新贵2001年8月前言本标准与GJB2786-96《软件开发》配套使用。×××工程“白皮书”综合了GJB2786-96、GJB438A-97和GJB/Z115-98。本标准允许根据实际情况进行剪裁，以适应实际需要。1.范围1.1主题内容规定应用软件开发文档编制的格式、内容和要求。1.2适用范围适用计算机软件开发过程中的文档编制，特别适用于同GJB2786-96配套使用。2.引用文件（略）3.定义（略）4.一般要求4.1文档种类（一）系统和段设计文件软件开发计划软件需求规格说明接口需求规格说明接口设计文档软件设计文档软件产品

2、规格说明版本说明文档4.1文档种类（二）软件测试计划软件测试说明软件测试报告计算机系统操作员手册软件用户手册软件程序员手册固件保障手计算机资源综合保障手册数据库设计4.一般要求（一）4.2文档的产生根据GJB2786-96中各阶段描述的工作任务而产生相应的文档。详见GJB2786-96。4.一般要求（二）4.3文档的准备*可用书面形式或电子多媒体形式*剪裁说明：种类和内容都可剪裁，内容可用“本节无内容”方式剪裁，以便保留章节号。*页码编制：参见文档模板。*文档控制号：按标准编制或自定义。*自变量：例如3.2.x实际可为3.2.1、3.2.2、...4.

3、一般要求（三）4.4文档的结构软件文档由封面、目录、正文、注释和附录组成。详见标准。5详细要求*详细要求将对16个软件文档分别叙述其格式、内容和要求。*每个文档分为目录和正文两部分。5.1系统和段设计文件1此为一个系统设计文件，描述：系统任务、运行环境、支持环境、系统体系结构、运行情况、系统设计、处理资源、质量因素以及需求的可追踪性等内容；2系统设计把系统的任务分配给硬件、软件和手工操作，并确定其间的内部接口；3由此派生出对软件的要求，故它是进行软件需求分析的基础。5.2软件开发计划（一）1要求按GJB2786-96《软件开发》的一般要求中叙述的五项职能：*软件开

4、发管理；*软件工程；*正式合格性测试；*软件产品评价；*软件配置管理；以及*其它软件开发职能六个方面来制定软件开发计划。5.2软件开发计划（二）2所有软件开发工作都应按“软件开发计划”的规定进行，若要修改，必须经过严格的批准手续。*不但要详细叙述本项目的开发计划，而且要概述与其它有关项目（包括硬件、软件）开发计划的关系，以便协同工作。5.2软件开发计划（三）*由于我国国情，开发计划中有些条目可能编写比较困难，但为了按时保质保量地完成任务，应尽量编制好软件开发计划，并严格执行它。5.2软件开发计划（四）3软件开发管理描述：*项目的组织机构和资源；*进度和里程碑；*风

5、险管理；*安全保密；*与其它承制方的关系和接口；*与其它IV&V机构的关系和接口；5.2软件开发计划（五）3软件开发管理描述：*转承制方的管理；*正式审查；*软件开发库管理；*问题纠正过程管理；*问题/更改报告。5.2软件开发计划（六）4软件工程描述：*开发组织机构和资源；*软件标准和研制程序；*非开发软件的获取和使用；5正式合格性测试描述：*测试组织机构和资源；*测试方法和基本原理；*测试计划的假设条件和约束。5.2软件开发计划（七）6软件产品评价：*评价组织机构和资源；*软件产品评价的规程工具；*转承制方的产品；*软件产品评价记录的格式、内容等；*分节描述每个

6、软件开发产品在各开发阶段的产品评价计划、评价标准（若需修改GJB2786规定的评价标准的话）等；5.2软件开发计划（八）7软件配置管理：*管理组织机构和资源；*配置标识；*配置控制；*配置状况报告；*配置审核；*让签约机构认可规格说明的准备工作；*配置管理的主要里程碑。5.2软件开发计划（九）8其它软件开发职能分节描述各个开发职能：8.x职能名8.x.1组织机构－职能名8.x.2其它资源－职能名8.x.3方法和规程－职能名5.3软件需求规格说明（一）1软件需求规格说明是需求分析的产物，是一项重要的软件开发产品。2软件需求规格说明分为：*工程需求；*合格性需求；*交

7、付准备；三方面来描述。5.3软件需求规格说明（二）3工程需求工程需求要求描述：*CSCI的外部接口需求；*CSCI的功能需求（按功能分节叙述）；*CSCI的内部接口；*CSCI的数据元素要求；*适应性需求；*容量和时间要求；5.3软件需求规格说明（三）工程需求要求描述：*安全要求；*保密要求；*设计约束；*软件质量因素；*人的特性/人的工程需求；*需求可追踪性。5.3软件需求规格说明（四）4合格性需求合格性需求分节证明软件合格的方法和级别和特殊的合格性需求：4.1合格性方法和级别4.2特殊合格性需求5交付准备说明：CSCI介质的类型和特性；介质的标签、包装、处置和

8、分类；其它