软件开发文档规范.ppt
- 文档编号:2197637
- 上传时间:2022-10-27
- 格式:PPT
- 页数:69
- 大小:110.50KB
软件开发文档规范.ppt
《软件开发文档规范.ppt》由会员分享,可在线阅读,更多相关《软件开发文档规范.ppt(69页珍藏版)》请在冰豆网上搜索。
软件开发文档规范工程软件专家组工程软件专家组何新贵何新贵2001年年8月月前言前言本标准与本标准与GJB2786-96软件开发配套软件开发配套使用。
使用。
工程工程“白皮书白皮书”综合了综合了GJB2786-96、GJB438A-97和和GJB/Z115-98。
本标准允许根据实际情况进行剪裁,以本标准允许根据实际情况进行剪裁,以适应实际需要。
适应实际需要。
1.范围范围1.1主题内容主题内容规定应用软件开发文档编制的格式、规定应用软件开发文档编制的格式、内容和要求。
内容和要求。
1.2适用范围适用范围适用计算机软件开发过程中的文档编适用计算机软件开发过程中的文档编制,特别适用于同制,特别适用于同GJB2786-96配套使用。
配套使用。
2.引用文件(略)引用文件(略)3.定义(略)定义(略)4.一般要求一般要求4.1文档种类
(一)文档种类
(一)系统和段设计文件系统和段设计文件软件开发计划软件开发计划软件需求规格说明软件需求规格说明接口需求规格说明接口需求规格说明接口设计文档接口设计文档软件设计文档软件设计文档软件产品规格说明软件产品规格说明版本说明文档版本说明文档4.1文档种类
(二)文档种类
(二)软件测试计划软件测试计划软件测试说明软件测试说明软件测试报告软件测试报告计算机系统操作员手册计算机系统操作员手册软件用户手册软件用户手册软件程序员手册软件程序员手册固件保障手固件保障手计算机资源综合保障手册计算机资源综合保障手册数据库设计数据库设计4.一般要求
(一)一般要求
(一)4.2文档的产生文档的产生根据根据GJB2786-96中各阶段描述的工作任务中各阶段描述的工作任务而产生相应的文档。
详见而产生相应的文档。
详见GJB2786-96。
4.一般要求
(二)一般要求
(二)4.3文档的准备文档的准备*可用书面形式或电子多媒体形式可用书面形式或电子多媒体形式*剪裁说明:
种类和内容都可剪裁,内容可用剪裁说明:
种类和内容都可剪裁,内容可用“本节无内容本节无内容”方式剪裁,以便保留章节号。
方式剪裁,以便保留章节号。
*页码编制:
参见文档模板。
页码编制:
参见文档模板。
*文档控制号:
按标准编制或自定义。
文档控制号:
按标准编制或自定义。
*自变量:
例如自变量:
例如3.2.x实际可为实际可为3.2.1、3.2.2、.4.一般要求(三)一般要求(三)4.4文档的结构文档的结构软件文档由封面、目录、正文、注释软件文档由封面、目录、正文、注释和附录组成。
和附录组成。
详见标准。
详见标准。
5详细要求详细要求*详细要求将对详细要求将对16个软件文档分别叙述个软件文档分别叙述其格式、内容和要求。
其格式、内容和要求。
*每个文档分为目录和正文两部分。
每个文档分为目录和正文两部分。
5.1系统和段设计文件系统和段设计文件1此为一个系统设计文件,描述:
系统任此为一个系统设计文件,描述:
系统任务、运行环境、支持环境、系统体系结务、运行环境、支持环境、系统体系结构、运行情况、系统设计、处理资源、构、运行情况、系统设计、处理资源、质量因素以及需求的可追踪性等内容;质量因素以及需求的可追踪性等内容;2系统设计把系统的任务分配给硬件、软系统设计把系统的任务分配给硬件、软件和手工操作,并确定其间的内部接口;件和手工操作,并确定其间的内部接口;3由此派生出对软件的要求,故它是进行由此派生出对软件的要求,故它是进行软件需求分析的基础。
软件需求分析的基础。
5.2软件开发计划
(一)软件开发计划
(一)1要求按要求按GJB2786-96软件开发的一般要求软件开发的一般要求中叙述的五项职能:
中叙述的五项职能:
*软件开发管理;软件开发管理;*软件工程;软件工程;*正式合格性测试;正式合格性测试;*软件产品评价;软件产品评价;*软件配置管理;以及软件配置管理;以及*其它软件开发职能其它软件开发职能六个方面来制定软件开发计划。
六个方面来制定软件开发计划。
5.2软件开发计划
(二)软件开发计划
(二)2所有软件开发工作都应按所有软件开发工作都应按“软件开发计划软件开发计划”的的规定进行,若要修改,必须经过严格的批准手规定进行,若要修改,必须经过严格的批准手续。
续。
*不但要详细叙述本项目的开发计划,而且要不但要详细叙述本项目的开发计划,而且要概述与其它有关项目(包括硬件、软件)开概述与其它有关项目(包括硬件、软件)开发计划的关系,以便协同工作。
发计划的关系,以便协同工作。
5.2软件开发计划(三)软件开发计划(三)*由于我国国情,开发计划中有些条目可能编由于我国国情,开发计划中有些条目可能编写比较困难,但为了按时保质保量地完成任写比较困难,但为了按时保质保量地完成任务,应尽量编制好软件开发计划,并严格执务,应尽量编制好软件开发计划,并严格执行它。
行它。
5.2软件开发计划(四)软件开发计划(四)3软件开发管理描述:
软件开发管理描述:
*项目的组织机构和资源;项目的组织机构和资源;*进度和里程碑;进度和里程碑;*风险管理;风险管理;*安全保密;安全保密;*与其它承制方的关系和接口;与其它承制方的关系和接口;*与其它与其它IV&V机构的关系和接口;机构的关系和接口;5.2软件开发计划(五)软件开发计划(五)3软件开发管理描述:
软件开发管理描述:
*转承制方的管理;转承制方的管理;*正式审查;正式审查;*软件开发库管理;软件开发库管理;*问题纠正过程管理;问题纠正过程管理;*问题问题/更改报告。
更改报告。
5.2软件开发计划(六)软件开发计划(六)4软件工程描述:
软件工程描述:
*开发组织机构和资源;开发组织机构和资源;*软件标准和研制程序;软件标准和研制程序;*非开发软件的获取和使用;非开发软件的获取和使用;5正式合格性测试描述:
正式合格性测试描述:
*测试组织机构和资源;测试组织机构和资源;*测试方法和基本原理;测试方法和基本原理;*测试计划的假设条件和约束。
测试计划的假设条件和约束。
5.2软件开发计划(七)软件开发计划(七)6软件产品评价:
软件产品评价:
*评价组织机构和资源;评价组织机构和资源;*软件产品评价的规程工具;软件产品评价的规程工具;*转承制方的产品;转承制方的产品;*软件产品评价记录的格式、内容等;软件产品评价记录的格式、内容等;*分节描述每个软件开发产品在各开发阶段分节描述每个软件开发产品在各开发阶段的产品评价计划、评价标准(若需修改的产品评价计划、评价标准(若需修改GJB2786规定的评价标准的话)等;规定的评价标准的话)等;5.2软件开发计划(八)软件开发计划(八)7软件配置管理:
软件配置管理:
*管理组织机构和资源;管理组织机构和资源;*配置标识;配置标识;*配置控制;配置控制;*配置状况报告;配置状况报告;*配置审核;配置审核;*让签约机构认可规格说明的准备工作;让签约机构认可规格说明的准备工作;*配置管理的主要里程碑。
配置管理的主要里程碑。
5.2软件开发计划(九)软件开发计划(九)8其它软件开发职能其它软件开发职能分节描述各个开发职能:
分节描述各个开发职能:
8.x职能名职能名8.x.1组织机构职能名组织机构职能名8.x.2其它资源职能名其它资源职能名8.x.3方法和规程职能名方法和规程职能名5.3软件需求规格说明
(一)软件需求规格说明
(一)1软件需求规格说明是需求分析的产物,软件需求规格说明是需求分析的产物,是一项重要的软件开发产品。
是一项重要的软件开发产品。
2软件需求规格说明分为:
软件需求规格说明分为:
*工程需求;工程需求;*合格性需求;合格性需求;*交付准备;交付准备;三方面来描述。
三方面来描述。
5.3软件需求规格说明
(二)软件需求规格说明
(二)3工程需求工程需求工程需求要求描述:
工程需求要求描述:
*CSCI的外部接口需求;的外部接口需求;*CSCI的功能需求(按功能分节叙述);的功能需求(按功能分节叙述);*CSCI的内部接口;的内部接口;*CSCI的数据元素要求;的数据元素要求;*适应性需求;适应性需求;*容量和时间要求;容量和时间要求;5.3软件需求规格说明(三)软件需求规格说明(三)工程需求要求描述:
工程需求要求描述:
*安全要求;安全要求;*保密要求;保密要求;*设计约束;设计约束;*软件质量因素;软件质量因素;*人的特性人的特性/人的工程需求;人的工程需求;*需求可追踪性。
需求可追踪性。
5.3软件需求规格说明(四)软件需求规格说明(四)4合格性需求合格性需求合格性需求分节证明软件合格的方法和合格性需求分节证明软件合格的方法和级别和特殊的合格性需求:
级别和特殊的合格性需求:
4.1合格性方法和级别合格性方法和级别4.2特殊合格性需求特殊合格性需求5交付准备交付准备说明:
说明:
CSCI介质的类型和特性;介质的类型和特性;介质的标签、包装、处置和分类;介质的标签、包装、处置和分类;其它特殊的交付要求。
其它特殊的交付要求。
5.4接口需求规格说明
(一)接口需求规格说明
(一)1本文档将描述本文档将描述CSCI的各个外部接口的各个外部接口的需求。
的需求。
2当外部接口不多,也不复杂时,也可当外部接口不多,也不复杂时,也可把此文档合并到软件需求规格说明。
把此文档合并到软件需求规格说明。
5.4接口需求规格说明
(二)接口需求规格说明
(二)3接口说明接口说明3.1接口示意图接口示意图3.x接口名接口名分节描述该接口:
分节描述该接口:
3.x.1接口需求接口需求包括说明:
并发包括说明:
并发/顺序执行;通信协议;顺序执行;通信协议;优先级。
优先级。
5.4接口需求规格说明(三)接口需求规格说明(三)3接口说明接口说明3.1接口示意图接口示意图3.x接口名接口名分节描述该接口:
分节描述该接口:
3.x.2数据要求数据要求详细说明跨接口数据的来源、目的、详细说明跨接口数据的来源、目的、度量单位、值域、精度和分辨率等。
度量单位、值域、精度和分辨率等。
5.5接口设计文档
(一)接口设计文档
(一)1本文档将描述本文档将描述CSCI的各个外部接口的各个外部接口的设计。
的设计。
2当外部接口不多,也不复杂时,也当外部接口不多,也不复杂时,也可把此文档合并到软件设计文档。
可把此文档合并到软件设计文档。
5.5接口设计文档
(二)接口设计文档
(二)3接口设计接口设计3.1接口示意图接口示意图3.x接口名接口名分节描述该接口的设计:
分节描述该接口的设计:
3.x.1数据元素数据元素在数据元素定义表中对跨接口数据元在数据元素定义表中对跨接口数据元素详细提供来源、目的、度量单位、值域、素详细提供来源、目的、度量单位、值域、精度和分辨率、数据类型、表示格式、优精度和分辨率、数据类型、表示格式、优先级等信息。
先级等信息。
5.5接口设计文档(三)接口设计文档(三)3.x.2消息描述消息描述标识接口间的每个消息,并描述数据元标识接口间的每个消息,并描述数据元素对消息的功用。
素对消息的功用。
3.x.3接口优先级接口优先级规定消息通过该接口的相对优先级次序。
规定消息通过该接口的相对优先级次序。
3.x.4通信协议通信协议分节描述与该接口相连的通信协议。
分节描述与该接口相连的通信协议。
5.6软件设计文档
(一)软件设计文档
(一)1本文档将描述本文档将描述CSCI的概要设计和详的概要设计和详细设计。
细设计。
2当当CSCI较复杂时,也可把此文档分较复杂时,也可把此文档分为软件概要设计文档和软件详细设为软件概要设计文档和软件详细设计文档。
计文档。
5.6软件设计文档
(二)软件设计文档
(二)3概要设计概要设计描述描述CSCI的概要设计。
的概要设计。
3.1CSCI概述概述3.1.1CSCI结构结构用结构图描述用结构图描述CSCI的结构和外部接口。
的结构和外部接口。
3.1.2系统状态和模式系统状态和模式除系统状态和模式外,还应描述相应的除系统状态和模式外,还应描述相应的控制流和数据流。
控制流和数据
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 开发 文档 规范