《计算机软件产品开发文件编制指南》

附录五国家标准《计算机软件产品开发文件编制指南》

国家标准《计算机软件产品开发文件编制指南》（GB8567—88）是一份指导性文件。它建议在软件的开发过程申编下述14个文件：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。该指南给出了这14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。下面详细介绍这14种文件的编写目的与内容要求。

l、可行性研究报告

可行性研究报告的目的是：说明该软件开发项目的实现在技术上、经济上和社会条上的可行性，论述为了合理地达到开发目标而可能选择的各种方案，说明并论证所选定的方案。可行性研究报告的编写内容见表l。

表l可行性研究报告

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.可行性研究的前提

2.1要求

2.2目标

2.3条件、假定和

2.4进行可行性研究的方法

2.5评价尺度

3.对现有系统的分析

3.1数据流程和处理流程

3.2工作负荷

3.3消费开支

3.4人员

3.5设备

3.6局限性

4.所建议的系统

4.1对所建议系统的说明

4.2数据流程和处理流程

4.3改进之处

4.4影响

4.4.1对设备的影响

4.4.2对软件的影响

4.4.3对用户单位机构的影响

4.4.4对系统运行的影响 4.4.5对开发的影响 4.4.6对地点和设施的影响 4.5局限性 4.6技术条件方面的可行性 5.可选择的其他系统方案 5.1可选择的系统方案1 5.2可选择的系统方案2 6.投资及收益分析 6.1支出 6.1.1基本建设投资 6.1.2其他一次性支出 6.1.3非一次性支出 6.2收益 6.2.1一次性收益 量的收益 6.3收益/投资比 6.4投资回收周期 6.5敏感性分析 7.社会条件方面的可行性 7.1法律方面的可行性 7.2使用方面的可行性 8.结论

2、项目开发计划

编制项目开发计划的目的是用文件的形式，并在开发过程中各项工作的负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便根据本计划开展和检查项目的开发工作。编制内容要求如表2所示。

表2项目开发计划

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.项目概述

2.1工作内容

2.2主要参加人员

2.3产品及成果

2.4验收标准

2.5完成项目的最迟期限 2.6本计划的审批者与批准者 3.实施总计划 3.1工作任务的分析 3.2接口人员 3.3进度 3.4预算 3.5关键问题 4.支持条件 4.1计算机统支持 4.2需要用户承担的工作 4.3需由外单位提供的条件 5.专题计划要点

3、软件需求说明书

软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解，使之成为整个软件开发工作的基础。其内容要求见表3。

表3软件需求说明书

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.任务概述

2.1目标

2.2用户的特点

2.3假定的约束

3.需求规定

3.1对功能的规定

3.2对性能的规定

3.3输入输出要求 3.4数据管理要求 3.5故障处理要求 3.6其他专门要求 4.运行环境规定 4.1设备 4.2支撑软件 4.3接口 4.4控制

4、数据要求说明书

数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息，其内容要求列于表4中。

表4数据要求说明书

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.数据的逻辑描述

2.1静态数据

2.2动态输入数据

2.3动态输出数据 2.4内部生成数据 2.5数据约定 3.数据的采集 3.1要求的范围 3.2输入的承担者 3.3处理 3.4影响

5、概要设计说明书

概要设计说明书又称为总体设计说明书，编制目的是说明对项目系统的设计考虑，包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等，为程序的详细设计提供基础。其内容要求见表5。

表5概要设计说明书

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.总体设计

2.1运行环境

2.2基本设计概念和处理流程

2.3结构

2.4功能需求与程序的关系

2.5人工处理过程

2.6尚未解决的问题

3.接口设计

3.1用户接口

3.2外部接口 3.3内部接口 4.运行设计 4.1运行模块组合 4.2运行控制 4.3运行时间 5.系统数据结构设计 5.1逻辑结构设计要点 5.2物理结构设计要点 5.3数据结构设计要点 6.系统出错处理设计 6.1出错信息 6.2补救措施 6.3系统维护设计

6、详细设计说明书

详细设计说明书又称为程序设计说明，编制目的是说明一个软件系统各个层次中的每一个程序（模块）的设计考虑。如果软件系统比较简单，层次少，本文件可以不单独编写，有关内容可并入概要设计说明书。详细设计说明书的内容要求见表6。

表6详细设计说明书

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.程序系统的组织结构

3.程序1（结构符）设计说明

3.1程序描述

3.2功能

3.3性能

3.4输入项

3.5输出项 3.6算法 3.7流程逻辑 3.8接口 3.9存储分配 3.10注释设计 3.11条件 3.12测试设计 3.13尚未解决的问题 4.程序2（标识符）设计说明书

7、数据库设计说明书

数据库设计说明书的编制目的是对于设计中的数据的所有标识、逻辑结

表7数据库设计说明书

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.外部设计

2.1标识符和状态

2.2使用它的程序

2.3约定

2.4专门指导 2.4支撑软件 3.结构设计 3.1概念结构设计 3.2逻辑 3.3物理结构设计 4.运用设计 4.1数据字典设计 4.2安全保密设计

构和物理结构做出具体的设计规定。内容要求见表7。

8、用户手册

用户手册的编制是使用非专业术语的语言，充分地描述该软件系统所具有的功能及基本的使用方法。使用户通过本手册能够了解该软件的用途，并能够确定在什么情况下、如何使用它。具体的内容要求见表8。

表8用户手册

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.用途

2.1功能

2.2性能

3.运行环境

3.1硬环境

3.2支撑软件

3.3数据结构 4.使用过程 4.1安全与初始化 4.2输入 4.3输出 4.4文卷查询 4.5出错处理与恢复 4.6终端操作

9、操作手册

操作手册的编制是为了向操作人员提供该软件每个运行的具体过程的有关知识，包括操作方法的细节。内容要求见表9。

表9操作手册

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.软件概述

2.1软件的结构

2.2程序表

2.3文卷表

3.安装与初始化

4.运行说明

4.1运行表

4.2运行步骤 4.3运行1(标识符)说明 4.4运行2(标识符)说明 …… 5.非常规过程 6.远程过程

10、模块开发卷宗

模块开发卷宗是在模块开发过程中逐步编写出来的。每完成一个模块或一组密切相关的模块，复审时编写出一份，应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总低层次开发的进度和结果；以便于对整个系统开发工作进行管理的复审，并为将来的维护提供有用的技术信息。具体内容要求见表10。

11、测试计划

表10模块开发卷宗

1.标题

2.模块开发情况表(见附表S10.10a)

3.功能说明

4.设计说明

5.源代码清单 6.测试说明 7.复审的结论

表10a模块开发情况表

模块标识符
模块的描述性名称
代码 设计	计划开始日期
	实际开始日期
	计划完成日期
	实际完成日期
模块 测试	计划开始日期
	实际开始日期
	计划完成日期
	实际完成日期
组装 测试	计划开始日期
	实际开始日期
	计划完成日期
	实际完成日期
代码复查日期/签字
源代码行数
目标模块大小
项目负责人批准日期/签字

这里所说的测试是指整个软件系统的组装测试和确认测试，本文件的编制是为了提供一个对该软件的测试计划，包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整体性方法及评价准则。具体内容见表11。

表11测试计划

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.计划

2.1软件说明

2.2测试内容

2.3测试1(标识符)

2.4测试2(标识符) …… 3.测试设计说明 3.1测试1(标识符) 3.2测试2(标识符) …… 4.评价准则 4.1范围 4.2数据整理 4.3尺度

12、测试分析报告

测试分析报告的编写是为了把组装测试和确认测试的结果、发现的问题以及分析结果写出成文件形式加以保存，具体编写内容要求见表12。

表12测试分析报告

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.测试概要

3.测试结果及发现

3.1测试1(标识符)

3.2测试2(标识符)

……

4.对软件功能的结论

4.1功能1(标识符) 4.2功能2(标识符) …… 5.分析摘要 5.1能力 5.2缺陷和 5.3建议 5.4评价 6.测试资源消耗

13、开发进度月报

开发进度月报的编制目的是及时向有关管理部汇报项目开发的进度和情况,以便及时发现和处理开发过程中出现的问题。一般来说，开发进度月报是以项目组为单位每月编写的，具体内容要求见表13。

表13开发进度月报

1.标题

2.工程进度与状态

2.1进度

2.2态度

3.资源耗用与状态

3.1资源耗用

3.2状态 4.经费支出与状态 4.1经费支出 4.2状态 5.下个月的工作计划 6.建议

14、项目开发总结报告

项目开发总结报告的编制是为了总结本项目开发工作的经验，说明实际取得的开发成果以及对整个开发工作的各个方面的评价，具体内容要求见表14。

表14项目开发总结报告

1.引言

1.1编写目的

1.2背景

1.3定义

1.4参考资料

2.实际开发结果

2.1产品

2.2主要功能和性能

2.3基本流程

2.4进度 2.5费用 3.开发工作评价 3.1对生产效率的评价 3.2对产品质量的评价 3.3对技术方法的评价 3.4出错原因的分析 4.经验与教训