GB8567——88的文档格式

GB8567——88

数据要求说明书

1引言

1.1编写目的

说明编写这份数据要求说明书的目的，指出预期的读者。

1.2背景

说明：

a.       待开发软件系统的名称；

b.       b.列出本项目的任务提出者、开发者、用户以及将运行该项软件的计算站（中心）或计算机网络系统。

1.3定义

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

1.4参考资料

列出有关的参考资料，如：

a.       本项目的经核准的计划任务书或合同，上级机关的批文；

b.       属于本项目的其他已发表文件；

c.       本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位。说明能够得到这些文件资料的来源。

2数据的逻辑描述

对数据进行逻辑描述时可把数据分为动态数据和静态数据。所谓静态数据，指在运行过程中主要作为参考的数据，它们在很长的一段时间内不会变化，一般不随运行而改变。所谓动态数据，包括所有在运行中要发生变化的数据以及在运行中要输入、输出的数据。进行描述时应把各数据元素逻辑地分成若干组，列如函数、源数据或对于其应用更为恰当的逻辑分组。给出每一数据元的名称（包括缩写和代码）、定义（或物理意义）度量单位、值域、格式和类型等有关信息。

2.1静态数据

列出所有作为控制或参考用的静态数据元素。

2.2动态输人数据

列出动态输入数据元素（包括在常规运行中或联机操作中要改变的数据）。

2.3动态输出数据

列出动态输出数据元素（包括在常规运行中或联机操作中要改变的数据）。

2.4内部生成数据

列出向用户或开发单位中的维护调试人员提供的内部生成数据。

2.5数据约定

说明对数据要求的制约。逐条列出对进一步扩充或使用方面的考虑而提出的对数据要求的限制（容 量、文卷、记录和数据元的个数的最大值）。对于在设计和开发中确定是临界性的限制更要明确指出。

3数据的采集

3.1要求和范围

按数据元的逻辑分组来说明数据采集的要求和范围，指明数据的采集方法，说明数据采集工作的承担者是用户还是开发者。具体的内容包括：

a.       输入数据的来源，例如是单个操作员、数据输入站，专业的数据输入公司或它们的一个分组；

b.       数据输入（指把数据输入处理系统内部）所用的媒体和硬设备。如果只有指定的输入点的输入才是合法的，则必须对此加以说明；

c.       接受者说明输出数据的接受者；

d.       输出数据的形式和设备列出输出数据的形式和硬设备。无论接受者将接收到的数据是打印输出，还是CRT上的一组字符、一帧图形，或一声警铃，或向开关线圈提供的一个电脉冲，或常用介质如磁盘、磁带、穿孔卡片等，均应具体说明；

e.       数据值的范围给出每一个数据元的合法值的范围；

f.        量纲给出数字的度量单位、增量的步长、零点的定标等。在数据是非数字量的情况下，要给出每一种合法值的形式和含意；

g.       更新和处理的频度给出预定的对输入数据的更新和处理的频度。如果数据的输入是随机的，应给出更新处理的频度的平均值，或变化情况的某种其他度量。

3.2输人的承担者

说明预定的对数据输入工作的承担者。如果输入数据同某一接口软件有关，还应说明该接口软件的来源。

3.3预处理

对数据的采集和预处理过程提出专门的规定，包括适合应用的数据格式、预定的数据通信媒体和对输入的时间要求等。对于需经模拟转换或数字转换处理的数据量，要给出转换方法和转换因子等有关信息，以便软件系统使用这些数据。

3.4影响

说明这些数据要求对于设备、软件、用户、开发单位所可能产生的影响，例如要求用户单位增设某个机构等。

软件需求说明书的编写提示

1引言

1.1编写目的

说明编写这份软件需求说明书的目的，指出预期的读者。

1.2背景

说明：

a．  待开发的软件系统的名称；

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

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

1.3定义

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

1.4参考资料

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

a．  本项目的经核准的计划任务书或合同、上级机关的批文；

b．  属于本项目的其他已发表的文件；

c．  本文件中各处引用的文件、资料、包括所要用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

2任务概述

2.1目标

叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。解释被开发软件与其他有关软件之间的关系。如果本软件产品是一项独立的软件，而且全部内容自含，则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。|

2.2用户的特点

列出本软件的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本软件的预期使甩频度。这些是软件设计工作的重要约束

2.3假定和约束

列出进行本软件开发工作的假定和约束，例如经费限制、开发期限等。

3需求规定

3.1对功能的规定

用列表的方式（例如IPO表即输入、处理、输出表的形式），逐项定量和定性地叙述对软件所提出的功能要求，说明输入什么量、经怎样的处理、得到什么输出，说明软件应支持的终端数和应支持的并行操作的用户数。

3.2对性能的规定

3.2.1精度

说明对该软件的输入、输出数据精度的要求，可能包括传输过程中的精度。

3.2.2时间特性要求

说明对于该软件的时间特性要求，如对：

a．  响应时间；

b．  更新处理时间；

c．  数据的转换和传送时间；

d．  解题时间；等的要求。

3.2.3灵活性

说明对该软件的灵活性的要求，即当需求发生某些变化时，该软件对这些变化的适应能力，如：

a．  操作方式上的变化；

b．  运行环境的变化；

c．  同其他软件的接口的变化；

d．  精度和有效时限的变化；

e．  计划的变化或改进。

对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。

3.3输人输出要求

解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报告（正常结果输出、状态输出及异常输出）以及图形或显示报告的描述。

3.4数据管理能力要求

说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求作出估算。

3.5故障处理要求

列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。

3.6其他专门要求

如用户单位对安全保密的要求，对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。

4运行环境规定

4.1设备

列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能，包括：

a．  处理器型号及内存容量；

b．  外存容量、联机或脱机、媒体及其存储格式，设备的型号及数量；

c．  输入及输出设备的型号和数量，联机或脱机；

d．  数据通信设备的型号和数量；

e．  功能键及其他专用硬件

4.2支持软件

列出支持软件,包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。

4.3接口

说明该软件同其他软件之间的接口、数据通信协议等。

4.4控制

说明控制该软件的运行的方法和控制信号，并说明这些控制信号的来源。

模块开发卷宗（GB8567——88）

1标题

软件系统名称和标识符

模块名称和标识符（如果本卷宗包含多于一个的模块，则用这组模块的功能标识代替模块名）

程序编制员签名

卷宗的修改文本序号

修改完成日期

卷宗序号（说明本卷宗在整个卷宗中的序号）

编排日期（说明整个卷宗最近的一次编排日期）

2模块开发情况表

3功能说明

扼要说明本模块（或本组模块）的功能，主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。

4设计说明

说明本模块（或本组模块）的设计考虑，包括：

a．  在系统设计说明书中有关对本模块（或本组模块）设计考虑的叙述，包括本模块在软件系统中所处的层次，它同其他模块的接口；

b．  在程序设计说明书中有关对本模块（或本组模块）的设计考虑，包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等；

c．  在编制目前已通过全部测试的源代码时实际使用的设计考虑。

5原代码清单

要给出所产生的本模块（或本组模块）的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。

6测试说明

说明直接要经过本模块（或本组模块）的每一项测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。

7复审的结论

把实际测试的结果，同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。

可行性研究报告

1引言

1.1编写目的

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

1.2背景

说明：

A.       所建议开发的软件系统的名称；

B.       本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；

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

1.3定义

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

1.4参考资料

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

1.        本项目的经核准的计划任务书或合同、上级机关的批文；

2.        属于本项目的其他已发表的文件；

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

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

2可行性研究的前提

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

2.1要求

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

A.       功能；

B.       性能；

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

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

E.        处理流程和数据流程用图表的方式表示出最基本的数据流程和处理流程，并辅之以叙述；

F.        在安全与保密方面的要求；

G.       同本系统相连接的其他系统；

H.       完成期限。

2.2目标

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

A.       人力与设备费用的减少；

B.       处理速度的提高；

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

D.       管理信息服务的改进；

E.        自动决策系统的改进；

F.        人员利用率的改进。

2.3条件、假定和限制

说明对这项开发中给出的条件、假定和所受到的限制，如：

a． 所建议系统的运行寿命的最小值；

b．进行系统方案选择比较的时间；

c． 经费、投资方面的来源和限制；

d．法律和政策方面的限制；

e． 硬件、软件、运行环境和开发环境方面的条件和限制；

f．  可利用的信息和资源；

g． 系统投入使用的最晚时间。

2.4进行可行性研究的方法

说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的。摘要说明所使用的基本方法 和策略，如调查、加权、确定模型、建立基准点或仿真等。

2.5评价尺度

说明对系统进行评价时所使用的主要尺度，如费用的多少、各项功能的优先次序、开发时间的长短 及使用中的难易程度。

3对现有系统的分析

这里的现有系统是指当前实际使用的系统，这个系统可能是计算机系统，也可能是一个机械系统甚 至是一个人工系统。

分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。

3.1处理流程和数据流程

说明现有系统的基本的处理流程和数据流程。此流程可用图表即流程图的形式表示，并加以叙述。

3.2工作负荷

列出现有系统所承担的工作及工作量。

3.3费用开支

列出由于运行现有系统所引起的费用开支，如人力、设备、空间、支持性服务、材料等项开支以及开 支总额。

3.4人员

列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。

3.5设备

列出现有系统所使用的各种设备。

3.6局限性

列出本系统的主要的局限性，例如处理时间赶不上需要，响应不及时，数据存储能力不足，处理功能 不够等。并且要说明，为什么对现有系统的改进性维护已经不能解决问题。

4所建议的系统

本章将用来说明所建议系统的目标和要求将如何被满足。

4.1对所建议系统的说明

概括地说明所建议系统，并说明在第2章中列出的那些要求将如何得到满足，说明所使用的基本方法及理论根据。

4.2处理流程和数据流程

给出所建议系统的处理流程和数据流程。

4.3改进之处

按2.2条中列出的目标，逐项说明所建议系统相对于现存系统具有的改进。

4.4影响

说明在建立所建议系统时，预期将带来的影响，包括：

4.4.1对设备的影响

说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改。

4.4.2对软件的影响

说明为了使现存的应用软件和支持软件能够同所建议系统相适应。而需要对这些软件所进行的修改和补充。

4.4.3对用户单位机构的影响

说明为了建立和运行所建议系统，对用户单位机构、人员的数量和技术水平等方面的全部要求。

4.4.4对系统运行过程的影响

说明所建议系统对运行过程的影响，如：

a． 用户的操作规程；

b．运行中心的操作规程；

c． 运行中心与用户之间的关系；

d．源数据的处理；

e． 数据进入系统的过程；

f．  对数据保存的要求，对数据存储、恢复的处理；

g． 输出报告的处理过程、存储媒体和调度方法；

h． 系统失效的后果及恢复的处理办法。

4.4.5对开发的影响

说明对开发的影响，如：

a.       为了支持所建议系统的开发，用户需进行的工作；

b.      为了建立一个数据库所要求的数据资源；

c.       为了开发和测验所建议系统而需要的计算机资源；

d.      所涉及的保密与安全问题。

4.4.6对地点和设施的影响

说明对建筑物改造的要求及对环境设施的要求。

4.4.7对经费开支的影响

扼要说明为了所建议系统的开发，设计和维持运行而需要的各项经费开支。

4.5局限性

说明所建议系统尚存在的局限性以及这些问题未能消除的原因。

4.6技术条件方面的可行性

本节应说明技术条件方面的可行性，如：

a． 在当前的限制条件下，该系统的功能目标能否达到；

b．利用现有的技术，该系统的功能能否实现；

c． 对开发人员的数量和质量的要求并说明这些要求能否满足；

d．在规定的期限内，本系统的开发能否完成。

5可选择的其他系统方案

扼要说明曾考虑过的每一种可选择的系统方案，包括需开发的和可从国内国外直接购买的，如果没有供选择的系统方案可考虑，则说明这一点。

5.1可选择的系统方案1

参照第4章的提纲，说明可选择的系统方案1，并说明它未被选中的理由。

5.2可选择的系统方案2

按类似5.1条的方式说明第2个乃至第n个可选择的系统方案。

......

6投资及效益分析

 6.1支出

对于所选择的方案，说明所需的费用。如果已有一个现存系统，则包括该系统继续运行期间所需的费用。

6.1.1基本建设投资

包括采购、开发和安装下列各项所需的费用，如：

1. 房屋和设施；
2. ADP设备；
3. 数据通讯设备；
4. 环境保护设备；
5. 安全与保密设备；
6. ADP操作系统的和应用的软件；
7. 数据库管理软件。

6.1.2其他一次性支出

包括下列各项所需的费用，如：

a． 研究（需求的研究和设计的研究）；

b．开发计划与测量基准的研究；

c． 数据库的建立；

d．ADP软件的转换；

e． 检查费用和技术管理性费用；

f．  培训费、旅差费以及开发安装人员所需要的一次性支出；

g． 人员的退休及调动费用等。

6.1.3非一次性支出

列出在该系统生命期内按月或按季或按年支出的用于运行和维护的费用，包括：

a． 设备的租金和维护费用；

b．软件的租金和维护费用；

c． 数据通讯方面的租金和维护费用；

d．人员的工资、奖金；

e． 房屋、空间的使用开支；

f．  公用设施方面的开支；

g． 保密安全方面的开支；

h． 其他经常性的支出等。

6.2收益

对于所选择的方案，说明能够带来的收益，这里所说的收益，表现为开支费用的减少或避免、差错的减少、灵活性的增加、动作速度的提高和管理计划方面的改进等，包括；

6.2.1一次性收益

说明能够用人民币数目表示的一次性收益，可按数据处理、用户、管理和支持等项分类叙述，如：

a． 开支的缩减包括改进了的系统的运行所引起的开支缩减，如资源要求的减少，运行效率的改进，数据进入、存贮和恢复技术的改进，系统性能的可监控，软件的转换和优化，数据压缩技术的采用，处理的集中化／分布化等；

b．价值的增升包括由于一个应用系统的使用价值的增升所引起的收益，如资源利用的改进，管理和运行效率的改进以及出错率的减少等；

c． 其他如从多余设备出售回收的收入等。

6.2.2非一次性收益

说明在整个系统生命期内由于运行所建议系统而导致的按月的、按年的能用人民币数目表示的收益，包括开支的减少和避免。

6.2.3不可定量的收益

逐项列出无法直接用人民币表示的收益，如服务的改进，由操作失误引起的风险的减少，信息掌握情况的改进，组织机构给外界形象的改善等。有些不可捉摸的收益只能大概估计或进行极值估计（按最好和最差情况估计）。

6.3收益／投资比

求出整个系统生命期的收益／投资比值。

6.4投资回收周期

求出收益的累计数开始超过支出的累计数的时间。

6.5敏感性分析

所谓敏感性分析是指一些关键性因素如系统生命期长度、系统的工作负荷量、工作负荷的类型与这些不同类型之间的合理搭配、处理速度要求、设备和软件的配置等变化时，对开支和收益的影响最灵敏的范围的估计。在敏感性分析的基础上做出的选择当然会比单一选择的结果要好一些。

7社会因素方面的可行性

本章用来说明对社会因素方面的可行性分析的结果，包括：

7.1法律方面的可行性

法律方面的可行性问题很多，如合同责任、侵犯专利权、侵犯版权等方面的陷井，软件人员通常是不熟悉的，有可能陷入，务必要注意研究。

7.2使用方面的可行性

例如从用户单位的行政管理、工作制度等方面来看，是否能够使用该软件系统；从用户单位的工作人员的素质来看，是否能满足使用该软件系统的要求等等，都是要考虑的。

8结论

在进行可行性研究报告的编制时，必须有一个研究的结论。结论可以是：

a． 可以立即开始进行；

b．需要推迟到某些条件（例如资金、人力、设备等）落实之后才能开始进行；

c． 需要对开发目标进行某些修改之后才能开始进行；

d．不能进行或不必进行（例如因技术不成熟、经济上不合算等）。

详细设计说明书

1引言

1.1编写目的

说明编写这份详细设计说明书的目的，指出预期的读者。

1.2背景

说明：

a．  待开发软件系统的名称；

b．  本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。

1.3定义

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

1.4参考资料

列出有关的参考资料，如：

a．  本项目的经核准的计划任务书或合同、上级机关的批文；

b．  属于本项目的其他已发表的文件；

c．  本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。

2程序系统的结构

用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间 的层次结构关系。

3程序1（标识符）设计说明

从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。

3.1程序描述

给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如 是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发处理等）。

3.2功能

说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。

3.3性能

说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。

3.4输人项

给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。

3.5输出项

给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。

3.6算法

详细说明本程序所选用的算法，具体的计算公式和计算步骤。

3.7流程逻辑

用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。

3.8接口

用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。

3.9存储分配

根据需要，说明本程序的存储分配。

3.10注释设计

说明准备在本程序中安排的注释，如：

a．  加在模块首部的注释；

b．  加在各分枝点处的注释；

c．  对各变量的功能、范围、缺省条件等所加的注释；

d．  对使用的逻辑所加的注释等等。

3.11限制条件

说明本程序运行中所受到的限制条件。

3.12测试计划

说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。

3.13尚未解决的问题

说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。

4程序2（标识符）设计说明

用类似F．3的方式，说明第2个程序乃至第N个程序的设计考虑。

......