软件设计文档国家标准GB.pdf

..

-

软件设计文档国家标准GB8567-88

一、文档编写标准化

在整个工程开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、准确性、

清晰性、完整性、灵活性和可追溯性。

完备的文档对软件的开发及使用起了很大的作用。一般要求编写好十三种文档。

1、可行性分析报告

说明该软件开发工程的实现在技术上、经济上和社会因素上的可行性，评述为了合理地到达

开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。

2、工程开发方案

为软件工程实施方案制订出具体方案，应该包括各局部工作的负责人员、开发的进度、开发

经费的预算、所需的硬件及软件资源等。

3、软件需求说明书〔软件规格说明书〕

对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人

员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的根底。该

说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。

4、概要设计说明书

是概要设计阶段的工作总结。主要包括功能分配、模块划分、程序总体构造、输入输出以及

接口设计、运行设计、数据构造设计和出错处理等，为详细设计作好准备。

5、详细设计说明书

着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

6、用户操作手册

详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。

7、测试方案

包括测试容、进度、条件、人员、测试用例的选取原那么、测试结果允许的偏差围等。

8、测试分析报告

测试方案的执行情况，对测试结果的分析，提出测试结论。

9、开发进度月报

按月提交的工程进展情况报告。包括方案与实际执行情况的比照、阶段成果、遇到的问题、

解决的方法以及下一步的打算。

10、工程开发总结报告

工程完成以后，总结实际执行情况。如进度、成果、资源利用、本钱和投入的人力，对工程

开发作出评价，总结经历与教训。

11、软件维护手册

主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。

12、软件问题报告

记录软件出现问题的日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。

13、软件修改报告

软件产品投入使用后，发现了需修改、更正的问题，要将出现的问题、修改意见、修改可能

出现影响作出详细描述，提交审批。

二、可行性分析报告的撰写要求

可行性研究报告的编写容要求如下：

1引言

..word.zl-

..

-

1．1编写目的

说明编写本可行性研究报告的目的，指出预期的读者。

1．2背景

说明：

a．所建议开发的软件系统的名称；

b．本工程的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；

C．该软件系统同其他系统或其他机构的根本的相互来往关系。

1．3定义

列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

1．4参考资料

列出用得着的参考资料，如：

a．本工程的经核准的方案任务书或合同、上级机关的批文；

b．属于本工程的其他已发表的文件；

C．本文件中各处引用的文件、资料，包括所需用到的软件开发标准。|

列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的

来源。

2可行性研究的前提

说明对所建议的开发工程进展可行性研究的前提，如要求、目标、假定、限制等。

2．1要求

说明对所建议开发的软件的根本要求，如：

a．功能；

b．性能；

C．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分

发对象；

d．输入说明系统的输入，包括数据的来源、类型、数量、数据的组织以及提供的频度；

e．处理流程和数据流程用图表的方式表示出最根本的数据流程和处理流程，并辅之以表达；

f．在平安与方面的要求；

g．同本系统相连接的其他系统；

h．完成期限。

2．2目标

说明所建议系统的主要开发目标，如：

a．人力与设备费用的减少；

b．处理速度的提高；

C．控制精度或生产能力的提高；

d．管理信息效劳的改良；

e．自动决策系统的