件开发文档规范.pptVIP

软件开发文档规范 ×××工程软件专家组 何新贵 2001年8月 前言 本标准与GJB 2786-96《软件开发》配套使用。 ×××工程“白皮书”综合了GJB 2786-96、GJB 438A-97和GJB/Z 115-98。 本标准允许根据实际情况进行剪裁，以适应实际需要。 1. 范围 1.1 主题内容 规定应用软件开发文档编制的格式、内容和要求。 1.2 适用范围 适用计算机软件开发过程中的文档编制，特别适用于同GJB 2786-96配套使用。 2. 引用文件（略）3. 定义（略）4. 一般要求 4.1 文档种类（一） 系统和段设计文件 软件开发计划 软件需求规格说明 接口需求规格说明 接口设计文档 软件设计文档 软件产品规格说明 版本说明文档 4.1 文档种类（二） 软件测试计划 软件测试说明 软件测试报告 计算机系统操作员手册 软件用户手册 软件程序员手册 固件保障手 计算机资源综合保障手册 数据库设计 4. 一般要求（一） 4.2 文档的产生 根据GJB 2786-96中各阶段描述的工作任务而产生相应的文档。详见GJB 2786-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 要求按GJB 2786-96《软件开发》的一般要求中叙述的五项职能： * 软件开发管理； * 软件工程； * 正式合格性测试； * 软件产品评价； * 软件配置管理；以及 * 其它软件开发职能 六个方面来制定软件开发计划。 5.2 软件开发计划（三） * 由于我国国情，开发计划中有些条目可能编 写比较困难，但为了按时保质保量地完成任 务，应尽量编制好软件开发计划，并严格执 行它。 5.2 软件开发计划（四） 3 软件开发管理描述： * 项目的组织机构和资源； * 进度和里程碑； * 风险管理； * 安全必威体育官网网址； * 与其它承制方的关系和接口； * 与其它IVV机构的关系和接口； 5.3 软件需求规格说明（一） 1 软件需求规格说明是需求分析的产物，是一项重要的软件开发产品。 2 软件需求规格说明分为： * 工程需求； * 合格性需求； * 交付准备； 三方面来描述。 5.3 软件需求规格说明（二） 3 工程需求 工程需求要求描述： * CSCI的外部接口需求； * CSCI的功能需求（按功能分节叙述）； * CSCI的内部接口； * CSCI的数据元素要求； * 适应性需求； * 容量和时间要求； 5.4 接口需求规格说明（一） 1 本文档将描述CSCI的各个外部接口的需求。 2 当外部接口不多，也不复杂时，也可把此文档合并到软件需求规格说明。 5.4 接口需求规格说明（二） 3 接口说明 3.1 接口示意图 3.x 接口名 分节描述该接口： 3.x.1 接口需求 包括说明：并发/顺序执行；通信协议； 优先级。 5.5 接口设计文档（一） 1 本文档将描述CSC