软件工程国家标准.docx
《软件工程国家标准.docx》由会员分享，可在线阅读，更多相关《软件工程国家标准.docx（25页珍藏版）》请在冰豆网上搜索。
软件工程国家标准
GB8567－88软件开发主要文档编写规范
本附录中列出了《计算机软件产品开发文件编制指南》GB8567－88中主要软件文档的编写说明，供编写时参考。
这些文档主要是：
可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。
一、可行性研究报告
l引言
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.自动决策系统的改进。
f.人员利用率的改进。
2.3条件、假定和限制
说明对这项开发中给出的条件、假定和所受到的限制，如
a.所建议系统的运行寿命的最小值。
b.进行系统方案选择比较的时间。
c.经费、投资方面的来源和限制。
d.法津和政策方面的限制。
e.硬件、软件、运行环境和开发环境方面的条件和限制。
f.可利用的信息和资源。
g.系统投入使用的最晚时间。
2.4进行可行性研究的方法
说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的。
摘要说明所使用的基本方法和策略，如调查、加权、确定模型、建立基准点或仿真等。
2.5评价尺度
说明对系统进行评价时所使用的主要尺度．如费用的多少、各项功能的优先次序、开发时间的长短及使用中的难易程度。
3对现有系统的分析
这里的现有系统是指当前实际使用的系统。
这个系统可能是计算机系统，也可能是一个机械系统甚至是一个人工系统。
分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。
3.l处理流程和数据流程
说明现有系统的基本处理流程和数据流程。
此流程可用图表即流程图的形式表示，并加以叙述。
3.2工作负荷
列出现有系统所承担的工作及工作量。
3.3费用开支
列出由于运行现有系统所引起的费用开支，如人力、设备、空间、支持性服务、材料等项开支以及开支总额。
3.4人员
列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。
3.5设备
列出现有系统所使用的各种设备。
3.6局限性
列出本系统的主要的局限性，例如处理时间赶不上需要，响应不及时，数据存储能力不足。
处理功能不够等。
并且要说明，为什么对现有系统的改进维护已经不能解决问题。
4所建议的系统
本章将用来说明所建议系统的目标和要求将如何被满足。
4.l对所建议系统的说明
概括地说明所建议系统，并说明在第2节中列出的那些要求将如何得到满足，说明所使用的基本方法及理论根据。
4.2处理流程和数据流程
给出所建议系统的处理流程和数据流程
4.3改进之处
按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.l.1基本建设投资
包括采购、开发和安装下列各项所需的费用，如：
a.房屋和设施。
b.ADP设备。
c.数据通讯设备。
d.环境保护设备。
e.安全与保密设备。
f．ADP操作系统和应用的软件。
g.数据库管理软件。
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.l法律方面的可行性
法律方面的可行性问题增多，如合同责任、侵犯专利权、侵犯版权等方面的陷阱，软件人员通常是不熟悉的，有可能陷入，务必要注意研究。
7.2使用方面的可行性
例如从用户单位的行政管理、工作制度等方面来看，是否能够使用该软件系统；从用户单位的工作人员的素质来看，是否能满足使用该软件系统的要求等等，都是要考虑。
8结论
在进行可行性研究报告的编制时，必须有一个研究的结论。
结论可以是：
a．可以立即开始进行。
b．需要推迟到某些条件（例如资金、人力、设备等）落实之后才能开始进行。
c.需要对开发目标进行某些修改之后才能开始进行。
d．不能进行或不必进行（例如因技术不成熟、经济上不合算等）。
二、项目开发计划
l引言
1.1编写目的
说明编写这份项目开发计划的目的并指出预期的读者。
1.2背景
说明：
a．待开发软件系统的名称。
b．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。
c.该软件系统同其他系统或其他机构的基本的相互来往关系。
1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资斜
列出用得着的参考资料，如：
a．本项目的经核准的计划任务书或合同、上级机关的批文。
b．属于本项目的其他已发表的文件。
c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2.项目概述
2.1工作内客
简要地说明在本项目的开发中需进行的各项主要工作。
2.2主要参加人员
扼要说明参加本项目开发工作的主要人员的情况，包括他们的技术水平。
2.3产品
2.3.1程序
列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式。
并通过引用有关文件，逐项说明其功能和能力。
2.3.2文件
列出需移交给用户的每种文件的名称及内容要点。
2.3.3服务
列出需向用户提供的各项服务。
如培训安装、维护和运行支持等。
应逐项规定开始日期、所提供支持的级别和服务的期限。
2.3.4非移交的产品
说明开发集体应向本单位交出但不必向用户移交的产品（文件甚至某些程序）。
2.4验收标准
对于上述这些应交出的产品和服务，逐项说明或引用资料说明验收标准。
2.5完成项目的推迟期限
2.6本计划的批准者和批准日期
3.实施计划
3.1工作任务的分工与人员分工
对于项目开发中需完成的各项工作，从需求分析、设计、实现、测试直到维护，包括文件的编制、审批、打印、分发工作，用户培训工作，软件安装工作等，按层次进行分解，指明每项任务的负责人和参加人员。
3.2接口人员
说明负责接口工作的人员及他们的职责，包括：
a．负责本项目同用户的接口人员。
b．负责本项目同本单位各管理机构，如合同计划管理部门、财务部门、质量管理部门等的接口人员。
c.负责本项目同各分合同负责单位的接口人员等。
3.3进度
对于需求分析、设计、编码实现、测试、移交、培训和安装等工作，给出每项工作任务的预定开始日期、完成日期及所需资源，规定各项工作任务完成的先后顺序以及表征每项工作任务完成的标志性事件（即所谓的“里程碑”）。
3.4预算
逐项列出本开发项目所需要的劳务（包括人员的数量和时间）以及经费的预算（包括办公费、差旅费、机时费、资料费、通讯设备和专用设备的租金等）和来源。
3.5关健问题
逐项列出能够影响整个项目成败的关键问题、技术难点和风险，指出这些同题对项目的影响。
4.支持条件
说明为支持本项目的开发所需要的各种条件和设施。
4.1计算机系统支持
逐项列出开发中和运行时所需的计算机系统支持，包括计算机、外围设备、通讯设备、模拟器、编译（或汇编）程序、操作系统、数据管理程序包、数据存储能力和测试支持能力等，逐项列出有关到货日期、使用时间的要求。
4.2需由用户承担的工作
逐项列出需要用户承担的工作和完成期限。
包括需由用户提供的条件及提供时间。
4.3由外单位提供的条件
逐项列出需要外单位分合同承包者承担的工作和完成的时间，包括需要由外单位提供的条件和提供的时间。
5.专题计划要点
说明本项目开发中需制订的各个专题计划（如分合同计划、开发人员培训计划、测试计划、安全保密计划、质量保证计划、配置管理计划、用户培训计划、系统安装计划等〕的要点。
三、软件需求说明书
l引言
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．计划的变化或改进。
f.对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。
3.3输入输出要求
解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。
对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报告（正常结果输出、状态输出及异常输出）以及图形或显示报告的描述。
3.4数据管理能力要求
说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求做出估算。
3.5故障处理要求
列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。
3.6其它专门要求
如用户单位对安全保密的要求，对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。
4运行环境规定
4.l设备
列出运行该软件所需要的硬设备。
说明其中的新型设备及其专门功能，包括：
a.处理器型号及内存容量。
b.外存容量、联机或脱机、媒体及其存储格式，设备的型号及数量。
c.输入及输出设备的型号和数量，联机或脱机。
d.数据通信设备的型号和数量。
e.功能键及其他专用硬件。
4.2支持软件
列出支持软件，包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。
4.3接口
说明该软件同其他软件之间的接口、数据通信协议等。
4.4控制
说明控制该软件的运行的方法和控制信号．并说明这些控制信号的来源。
四、概要设计说明书
l引言
1.1编写目的
说明编写这份概要设计说明书的目的，指出预期的读者。
1.2背景
说明：
a．待开发的软件系统的名称。
b.本项目的任务提出者、开发者、用户及运行该软件的计算中心或计算机网络。
1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资斜
列出用得着的参考资料，如：
a．本项目的经核准的计划任务书或合同、上级机关的批文。
b．属于本项目的其他已发表的文件。
c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2总体设计
2.1需求规定
说明对本系统的主要的输入输出项目、处理的功能性能要求。
2.2运行环境
简要说明对本系统的运行环境（包括硬件环境和支持环境）的规定。
2.3基本设计概念和处理流程
说明本系统的基本设计概念和处理流程，尽量使用图表的形式。
2.4结构
用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。
2.5功能需求与程序的关系
本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系，如表2.1所示。
表2.1各项功能需求功能的实现与各块程序的分配关系
功能需求
程序1
程序2
…
程序m
功能需求1
√
功能需求2
√
┇
功能需求n
√
√
2.6人工处理过程
说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。
2.7尚未解决的问题
说明概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
3.接口设计
3.1用户接口
说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。
3.2外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。
3.3内部接口
说明本系统之内的各个系统元素之间的接口的安排。
4运行设计
4.1运行模块组合
说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。
4.2运行控制
说明每一种外界的运行控制的方式方法和操作步骤。
4.3运行时间
说明每种运行模块组合将占用各种资源的时间。
5系统数据结构设计
5.1逻辑结构设计要点
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。
5.2物理结构设计要点
给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。
5.3数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式，如表2.2所示。
表2.2各个数据结构与访问这些数据结构的形式
功能需求
程序1
程序2
…
程序m
数据结构1
√
数据结构2
√
√
┇
数据结构n
√
√
6系统出错处理设计
6.1出错信息
用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。
6.2补救措施
说明故障出现后可能采取的变通措施，包括：
a．后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对磁盘媒体的一种后备技术。
b.降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录。
c.恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。
6.3系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。
各个程序之间的对应关系，可采用矩阵图的形式。
五、详细设计说明书
l引言
1.1编写目的
说明编写这份详细设计说明书的目的，指出预期的读者。
1.2背景
说明：
a．待开发的软件系统的名称。
b.本项目的任务提出者、开发者、用户及运行该软件的计算中心或计算机网络。
1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资斜
列出用得着的参考资料，如：
a．本项目的经核准的计划任务书或合同、上级机关的批文。
b．属于本项目的其他已发表的文件。
c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2程序系统的结构
用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。
3程序1（标识符）设计说明
从本条开始逐个地给出各个层次中的每个程序的设计说明。
以下给出的提纲是针对一般情况的。
对于一个具体的模块，尤其是
升级会员 