计算机软件产品开发文件编制管理的般要求.docVIP

计算机软件产品开发文件编制、管理的 一般要求 1 引言 随着信息技术的高速发展，我们公司研制开发的软件产品的数量与日俱增，即使是以硬件为主体的产品也无不与软件有着密切联系。按软件工程的技术和方法规范软件开发过程，加强软件开发全过程的质量控制，是保证软件开发质量的关键。 软件技术文档是计算机软件的重要组成部分，单有编程而没有与之配套的技术文档,不能称为计算机软件。在开发的相应阶段及时形成软件文档并通过评审是非常重要的：软件文档是软件开发、设计、实现的依据和准则；是对软件开发过程及开发成果进行有效管理的手段；是对软件进行评审、验证和确认的依据；是使用、维护、修改的指南。软件文档应按有关标准和规范的要求进行编写，软件文档的完整性及质量应是衡量软件开发成果和其质量的重要标志之一。 软件开发应按软件生存周期的六个阶段进行：可行性与计划研究阶段（立项）；需求分析阶段；设计阶段；实现阶段；测试阶段；运行与维护阶段。应及时按各阶段形成相应文档并进行阶段性评审，确认后再进行下一阶段的工作，使开发各阶段的质量和进度处于受控状态，及时发现、解决和纠正开发各阶段存在的问题和潜在的缺陷，使软件产品在生存周期内的质量得到保证。 2 范围 本要求为承担软件开发的组织提供编制、管理软件文档的一般方法，适用于计算机软件文档的编制与管理。 注：软件文档就是指软件文件,这里只是沿用了计算机行业的一种习惯叫法。 3 引用标准 GB/T 8567 计算机软件产品开发文件编制指南 GB 9385 计算机软件需求说明编制指南 GB 9386 计算机软件测试文件编制指南 GB 11457—1995 软件工程术语 GB/T 15532—1995计算机软件单元测试 GB/T 1900.3(ISO9000-3) 质量管理和质量保证标准,第三部分：GB/T19001（ISO9001）在软件开发，供应和维护中的使用指南 GJB437 军用软件开发规范(可参照) GJB 军用软件文档编制规范(可参照) 4 文档分类和组成 4.1 文档分类 一般分为两类:一类是开发过程中填写的标志软件开发进程的工作表格，如：开发计划，进度月报。另一类是开发各阶段应编制的体现软件技术内容及指导软件开发的技术性和管理性文件。 4.2 文档的组成 软件开发过程中一般编制14种文档见表1 4.2.1 文档的剪裁和合并 一项软件在开发过程中,可根据项目的规模大小和复杂程度对14项文件进行剪裁和合并。 a) 软件规模分级 软件的规模按源程序的行数可分为四级： 小规模软件：源程序行数小于5000的软件； 中规模软件：源程序行数为10，000～50,000的软件； 大规模软件： 源程序行数为100，000～500，000的软件； 特大规模软件： 源程序行数为大于500，000的软件。 b) 文件的剪裁与合并见表2 表2 按项目规模大小对14种文件的剪裁与合并、 小 规 模 中 规 模 大 规 模 特 大 规 模 软件需求说明与 开发计划 项目开发计划 软件需求说明 测试计划 可行性研究报告项目开发计划 软件需求说明 数据要求说明 测试计划 可根据14种文件按实际需要量进一步细分。 软件设计说明 软件设计说明 概要设计说明 详细设计说明 数据库设计说明 使用说明 使用说明 用户手册 操作手册 测试分析报告 模块开发卷宗 测试分析报告 模块开发卷宗 测试分析报告 项目开发总结 开发进度月报 项目开发总结 开发进度月报 项目开发总结 表1 软件生存周期各阶段中的文件编制 阶 使 文 用 档 段 者 名 称 可 行性研究与计划 需求分 析 设 计 实 现 测 试 使用与维护 管理 开发人员 可行性研究报告 管理 开发人员 项目发开发计划 开发人员 软件需求说明书 开发人员 数据要求说明书 开发人员 测试计划 （大纲） 开发 维护人员 概要设计说明书 开发 维护人员 详细设计说明书 开发 维护人员 数据设计说明书 维护人员 模块开发卷宗 用户 用户手册 用户 操作手册 维护人员 测试分析报告 管理人员 开发进度月报 管理人员 项目开发总结 4.2.2 文件的详细程度