软件开发文档规范.ppt

1 软件开发文档规范 工程软件专家组何新贵2001年8月 2 前言 本标准与gjb2786 96 软件开发 配套使用 工程 白皮书 综合了gjb2786 96 gjb438a 97和gjb z115 98 本标准允许根据实际情况进行剪裁 以适应实际需要 3 1 范围 1 1主题内容规定应用软件开发文档编制的格式 内容和要求 1 2适用范围适用计算机软件开发过程中的文档编制 特别适用于同gjb2786 96配套使用 4 2 引用文件 略 3 定义 略 4 一般要求 5 4 1文档种类 一 系统和段设计文件软件开发计划软件需求规格说明接口需求规格说明接口设计文档软件设计文档软件产品规格说明版本说明文档 6 4 1文档种类 二 软件测试计划软件测试说明软件测试报告计算机系统操作员手册软件用户手册软件程序员手册固件保障手计算机资源综合保障手册数据库设计 7 4 一般要求 一 4 2文档的产生根据gjb2786 96中各阶段描述的工作任务而产生相应的文档 详见gjb2786 96 8 4 一般要求 二 4 3文档的准备 可用书面形式或电子多媒体形式 剪裁说明 种类和内容都可剪裁 内容可用 本节无内容 方式剪裁 以便保留章节号 页码编制 参见文档模板 文档控制号 按标准编制或自定义 自变量 例如3 2 x实际可为3 2 1 3 2 2 9 4 一般要求 三 4 4文档的结构软件文档由封面 目录 正文 注释和附录组成 详见标准 10 5详细要求 详细要求将对16个软件文档分别叙述其格式 内容和要求 每个文档分为目录和正文两部分 11 5 1系统和段设计文件 1此为一个系统设计文件 描述 系统任务 运行环境 支持环境 系统体系结构 运行情况 系统设计 处理资源 质量因素以及需求的可追踪性等内容 2系统设计把系统的任务分配给硬件 软件和手工操作 并确定其间的内部接口 3由此派生出对软件的要求 故它是进行软件需求分析的基础 12 5 2软件开发计划 一 1要求按gjb2786 96 软件开发 的一般要求中叙述的五项职能 软件开发管理 软件工程 正式合格性测试 软件产品评价 软件配置管理 以及 其它软件开发职能六个方面来制定软件开发计划 13 5 2软件开发计划 二 2所有软件开发工作都应按 软件开发计划 的规定进行 若要修改 必须经过严格的批准手续 不但要详细叙述本项目的开发计划 而且要概述与其它有关项目 包括硬件 软件 开发计划的关系 以便协同工作 14 5 2软件开发计划 三 由于我国国情 开发计划中有些条目可能编写比较困难 但为了按时保质保量地完成任务 应尽量编制好软件开发计划 并严格执行它 15 5 2软件开发计划 四 3软件开发管理描述 项目的组织机构和资源 进度和里程碑 风险管理 安全保密 与其它承制方的关系和接口 与其它iv v机构的关系和接口 16 5 2软件开发计划 五 3软件开发管理描述 转承制方的管理 正式审查 软件开发库管理 问题纠正过程管理 问题 更改报告 17 5 2软件开发计划 六 4软件工程描述 开发组织机构和资源 软件标准和研制程序 非开发软件的获取和使用 5正式合格性测试描述 测试组织机构和资源 测试方法和基本原理 测试计划的假设条件和约束 18 5 2软件开发计划 七 6软件产品评价 评价组织机构和资源 软件产品评价的规程工具 转承制方的产品 软件产品评价记录的格式 内容等 分节描述每个软件开发产品在各开发阶段的产品评价计划 评价标准 若需修改gjb2786规定的评价标准的话 等 19 5 2软件开发计划 八 7软件配置管理 管理组织机构和资源 配置标识 配置控制 配置状况报告 配置审核 让签约机构认可规格说明的准备工作 配置管理的主要里程碑 20 5 2软件开发计划 九 8其它软件开发职能分节描述各个开发职能 8 x职能名8 x 1组织机构 职能名8 x 2其它资源 职能名8 x 3方法和规程 职能名 21 5 3软件需求规格说明 一 1软件需求规格说明是需求分析的产物 是一项重要的软件开发产品 2软件需求规格说明分为 工程需求 合格性需求 交付准备 三方面来描述 22 5 3软件需求规格说明 二 3工程需求工程需求要求描述 csci的外部接口需求 csci的功能需求 按功能分节叙述 csci的内部接口 csci的数据元素要求 适应性需求 容量和时间要求 23 5 3软件需求规格说明 三 工程需求要求描述 安全要求 保密要求 设计约束 软件质量因素 人的特性 人的工程需求 需求可追踪性 24 5 3软件需求规格说明 四 4合格性需求合格性需求分节证明软件合格的方法和级别和特殊的合格性需求 4 1合格性方法和级别4 2特殊合格性需求5交付准备说明 csci介质的类型和特性 介质的标签 包装 处置和分类 其它特殊的交付要求 25 5 4接口需求规格说明 一 1本文档将描述csci的各个外部接口的需求 2当外部接口不多 也不复杂时 也可把此文档合并到软件需求规格说明 26 5 4接口需求规格说明 二 3接口说明3 1接口示意图3 x接口名分节描述该接口 3 x 1接口需求包括说明 并发 顺序执行 通信协议 优先级 27 5 4接口需求规格说明 三 3接口说明3 1接口示意图3 x接口名分节描述该接口 3 x 2数据要求详细说明跨接口数据的来源 目的 度量单位 值域 精度和分辨率等 28 5 5接口设计文档 一 1本文档将描述csci的各个外部接口的设计 2当外部接口不多 也不复杂时 也可把此文档合并到软件设计文档 29 5 5接口设计文档 二 3接口设计3 1接口示意图3 x接口名分节描述该接口的设计 3 x 1数据元素在数据元素定义表中对跨接口数据元素详细提供来源 目的 度量单位 值域 精度和分辨率 数据类型 表示格式 优先级等信息 30 5 5接口设计文档 三 3 x 2消息描述标识接口间的每个消息 并描述数据元素对消息的功用 3 x 3接口优先级规定消息通过该接口的相对优先级次序 3 x 4通信协议分节描述与该接口相连的通信协议 31 5 6软件设计文档 一 1本文档将描述csci的概要设计和详细设计 2当csci较复杂时 也可把此文档分为软件概要设计文档和软件详细设计文档 32 5 6软件设计文档 二 3概要设计描述csci的概要设计 3 1csci概述3 1 1csci结构用结构图描述csci的结构和外部接口 3 1 2系统状态和模式除系统状态和模式外 还应描述相应的控制流和数据流 3 1 3内存和进程时间分配 33 5 6软件设计文档 三 3 2csci设计说明分节说明其每个csc的设计说明 3 2 xcsc名及标识号利用下层csc间的控制流和数据流描述该csc的概要设计 也可用其它描述方式 3 2 x y下一层csc名及标识号往下逐层描述csc的概要设计 复杂的csci可能有多层csc 34 5 6软件设计文档 四 4详细设计分节描述csci中每个csc的详细设计 4 xcsc名及标识号用其csu间的控制流和数据流描述csu间关系 描述csc的外部接口 并分小节逐个描述其中的每个csu 4 x ycsu名及标识号描述功能 并分下列小小节描述各种设计信息 35 5 6软件设计文档 五 4 x y 1 csu名 的设计需求及约束描述该csu的设计需求及约束 4 x y 2 csu名 的设计用流程图 pdl等设计工具描述该csu的详细设计信息 详见标准 5csci数据描述csci的所有全局数据元素和外部接口数据元素 36 5 6软件设计文档 六 6csci数据文件分节描述csci的每个共享数据文件 6 1csc csu数据文件交叉引用为csc csu使用下列数据文件提供一张引用表 37 5 6软件设计文档 七 6 2描述信息6 2 x数据文件名及标识号陈述数据文件的用途 大小 存取方法 记录结构和大小 数据表示 类型 单位 值域 精度和分辨率等 7需求的可追踪性用图表表示各个csu一直到规格说明中的需求 每个需求都需有相应的csu来实现 38 5 7软件产品规格说明 一 1范围1 1标识1 2系统概述1 3文档概述2引用文档 39 5 7软件产品规格说明 二 3要求3 1软件设计写出或引用软件设计文档 3 2csci源代码列表列出或引用源代码列表 并给出其中每个csc和csu在列表中位置的索引 3 3编译程序 汇编程序列出所用的编译程序 汇编程序 3 3测量资源 40 5 8版本说明文档 一 1范围1 1标识1 2系统概述1 3文档概述2引用文档3版本说明3 1发放的材料清单物理介质和新版本的文档 它是操作 装入或生成csci的依据 41 5 8版本说明文档 二 3 2csci内容清单软件清单和说明 3 3更改安装从上一版以来的所有更改清单和影响索引 3 4修改数据初始版本的特殊数据和修改情况 42 5 8版本说明文档 三 3 5接口兼容性陈述更改对系统和配置项接口的影响 3 6引用文档摘要列出所有与初始版本有关的文档 3 7更改总结总结3 3所述每个更改的影响 3 8安装说明3 9可能的问题和已知的错误 43 5 9软件测试计划 一 1范围1 1标识1 2系统概述1 3文档概述1 4与其它计划的关系2引用文档 44 5 9软件测试计划 二 3软件测试环境3 1软件项操作系统 编译程序测试工具 3 2硬件和固件项3 3权限测试环境有关的专利和使用权限 3 4安装 测试与控制安装 测试与控制软件测试环境的计划 45 5 9软件测试计划 三 4正式合格性测试4 x csci名称和项目唯一标识号 4 x 1总体测试要求4 x 2测试类4 x 3测试级4 x 4测试定义4 x 4 y 测试名称和项目唯一标识号 4 x 5测试进度5数据记录 整理和分析 46 5 10软件测试说明 一 1范围1 1标识1 2系统概述1 3文档概述2引用文档 47 5 10软件测试说明 二 3正式合格性测试准备3 x 测试名称和项目唯一标识号 3 x 1 测试名称 进度3 x 2 测试名称 测试准备过程3 x 2 1硬件要求3 x 2 2软件准备3 x 2 3其它测试准备 48 5 10软件测试说明 三 4正式合格性测试说明4 x 测试名称和项目唯一标识号 4 x y 测试用例名称和项目唯一标识号 4 x y 1 测试用例的名称 需求可追踪性4 x y 2 测试用例的名称 初始化4 x y 3 测试用例的名称 测试输入4 x y 4 测试用例的名称 期望测试结果 49 5 10软件测试说明 四 4 x y 5 测试用例的名称 评估测试结果的标准4 x y 6 测试用例的名称 测试过程4 x y 7 测试用例的名称 前提和约束 50 5 11软件测试报告 一 1范围1 1标识1 2系统概述1 3文档概述2引用文档 51 5 11软件测试报告 二 3测试概述3 1 正式合格性测试名称及项目的唯一标识号 3 1 1 正式合格性测试名称 小结3 1 2 正式合格性测试名称 测试记录 52 5 11软件测试报告 三 4测试结果4 x 正式合格性测试的名称和项目的唯一标识号 测试结果4 x y 测试用例名称和项目的唯一标识号 4 x y 1 测试用例名称 测试结果4 x y 2 测试用例名称 测试过程中的差异情况 53 5 11软件测试报告 四 5csci评估和建议5 1csci评估5 2改进建议 54 5 12计算机系统操作员手册 一 1范围1 1标识1 2系统概述1 3文档概述2引用文档3计算机系统操作3 1计算机系统准备和关机 55 5 12计算机系统操作员手册 二 3 1 1通电和断电3 1 2启动3 1 3关机3 2操作过程3 2 1输入和输出过程3 2 2监督过程故障和失效指示 联机干预等 3 2 3恢复过程 56 5 12计算机系统操作员手册 三 3 2 4脱机程序过程3 2 5其它过程4诊断4 1诊断特征概要陈述故障信息语法和故障隔离分级 4 2诊断过程4 2 x 过程名 4 3诊断工具集4 3 x 诊断工具名 57 5 13软件用户手册 一 1范围1 1标识1 2系统概述1 3文档概述2引用文档3执行过程该执行过程应包括 3 1初始化 58 5 13软件用户手册 二 3 2用户输入3 3系统输入3 4终止终止软件的操作及判断是否正常终止 3 5重新启动3 6输出描述预期输出和错误输出 4出错信息 59 5 14软件程序员手册 一 1范围1 1标识1 2系统概述1 3文档概述2引用文档 60 5 14软件程序员手册 二 3软件编程环境3 1设备配置宿主机和目标机的部件和配置3 2操作信息宿主机和目标机的操作特性 能力和限制3 3编译 汇编和连接设备和软件 61 5 14软件程序员手册 三 4编程信息4 1编程特征4 2程序指令4 3输入和输出控制的编程4 4附加的或专用的技术4 5编程示例4 6错误检测和诊断功能 62 5 15固件保障手册 一 1范围1 1标识1 2系统概述1 3文档概述2引用文档 63 5 15固件保障手册 二 3固件设备信息3 1设备说明3 2安装和修理过程3 3安全保密性3 4限制操作限制和环境限制 64 5 15固件保障手册 三 4编程设备及其过程4 1编程用的硬件编程和重新编程用的硬设备4