GB8567-88软件开发主要文档编写规范(1)

1引言 (2)1.1编写目的 (2)1.2背景 (2)1.3定义 (2)1.4参考资料 (2)2程序系统的结构 (2)3程序1（标识符）设计说明 (2)3.1程序描述 (3)3.2功能 (3)3.3性能 (3)3.4输人项 (3)3.5输出项 (3)3.6算法 (3)3.7流程逻辑 (3)3.8接口 (3)3.9存储分配 (4)3.10注释设计 (4)3.11限制条件 (4)3.12测试计划 (4)3.13尚未解决的问题 (4)4程序2（标识符）设计说明 (4)详细设计说明书1引言1.1编写目的说明编写这份详细设计说明书的目的，指出预期的读者。

1.2背景说明：a．待开发软件系统的名称；b．本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。

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

1.4参考资料列出有关的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用到的文件资料，包括所要用到的软件开发标准。

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

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

3程序1（标识符）设计说明从本章开始，逐个地给出各个层次中的每个程序的设计考虑。

以下给出的提纲是针对一般情况的。

对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。

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

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

231 GB 8567－88软件开发主要文档编写规范本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－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. 控制精度或生产能力的提高。

232 d ．管理信息服务的改进。

1引言1 目的一项计算机软件的筹划、研制及实现，构成一个软件开发项目。

一个软件开发项目的进行，一般需要 在人力和自动化资源等方面作重大的投资。

为了保证项目开发的成功，最经济地花费这些投资，并且便 于运行和维护，在开发工作的每一阶段，都需要编制二定的文件。

这些文件连同计算机程序及数据一起， 构成为计算机软件。

文件是计算机软件中不可缺少的组成部分，它的作用是： a ．作为开发人员在一定阶段内的工作成果和结束标志；b ．向管理人员提供软件开发过程中的进展和情况，把软件开发过程中的一些“不可见的”事物转 换成“可见的”文字资料。

以便管理人员在各个阶段检查开发计划的实施进展，使之能够判断原定目标是 否已达到，还将继续耗用资源的种类和数量； C ．记录开发过程中的技术信息，便于协调以后的软件开发、使用和修改；d ．提供对软件的有关运行、维护和培训的信息，便于管理人员、开发人员、操作人员和用户之间相 互了解彼此的工作；e ．向潜在用户报导软件的功能和性能，使他们能判定该软件能否服务于自己的需要。

换言之，本指南认为：文件的编制必须适应计算机软件整个生存周期的需要。

计算机软件所包含的文件有两类：一类是开发过程中填写的各种图表，可称之为工作表格；另一类 则是应编制的技术资料或技术管理资料，可称之为文件。

本指南规定软件文件的编制形式，并提供对这 些规定的解释。

本指南的目的是使得所编制的软件文件确实能够起到软件文件应该发挥的作用。

22 范围本指南是一份指导性文件。

本指甫建议，在一项计算机软件的开发过程中，一般地说，应该产生十四 种文件。

这十四种文件是： 可行性研究报告； 项目开发计划； 软件需求说明书； 数据要求说明书； 概要设计说明书； 详细设计说明书； 数据库设计说明书； 用户手册； 操作手册； 模块开发卷宗； 测试计划； 测试分析报告； 开发进度月报； 项目开发总结报告。

本指南将给出开发过程中建议产生的这十四种文件的编制指导，同时，本指南也是这十四种文件的 编写质量的检验准则。

GB8567－88软件开发主要文档编写规范GB8567－88软件开发主要文档编写规范233GB 8567－88软件开发主要文档编写规范本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。

这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。

一、 可行性研究报告l 引言1.1 编写目的说明：说明本可行性研究报告的编写目的，指出预期的读者。

1.2 背景说明：a ．所建议开发的软件系统的名称。

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

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

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

2341.4 参考资料列出用得着的参考资料，如：a ．本项目的经核准的计划任务书或合同、上级机关的批文。

b ．属干本项目的其他已发表的文件。

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

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

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

2.1 要求说明对所建议开发软件的基本要求，如：a ．功能。

b ．性能。

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

d. 输入说明。

系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频235度。

e ．处理流程和数据流程。

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

f. 在安全与保密方面的要求。

g. 同本系统相连接的其他系统。

h. 完成期限。

2.2 目标说明所建议系统的主要开发目标，如：a. 人力与设备费用的减少。

b. 处理速度的提高。

1引言 (2)1.1编写目的 (2)1.2背景 (2)1.3定义 (2)1.4参考资料 (2)2总体设计 (2)2.1需求规定 (2)2.2运行环境 (2)2.3基本设计概念和处理流程 (3)2.4结构 (3)2.5功能器求与程序的关系 (3)2.6人工处理过程 (3)2.7尚未问决的问题 (3)3接口设计 (3)3.1用户接口 (3)3.2外部接口 (3)3.3内部接口 (4)4运行设计 (4)4.1运行模块组合 (4)4.2运行控制 (4)4.3运行时间 (4)5系统数据结构设计 (4)5.1逻辑结构设计要点 (4)5.2物理结构设计要点 (4)5.3数据结构与程序的关系 (4)6系统出错处理设计 (5)6.1出错信息 (5)6.2补救措施 (5)6.3系统维护设计 (5)概要设计说明书1引言1.1编写目的说明编写这份概要设计说明书的目的，指出预期的读者。

1.2背景说明：a.待开发软件系统的名称；b.列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。

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

1.4参考资料列出有关的参考文件，如：a.本项目的经核准的计划任务书或合同，上级机关的批文；b.属于本项目的其他已发表文件；c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。

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

2总体设计2.1需求规定说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。

2.2运行环境简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。

2.3基本设计概念和处理流程说明本系统的基本设计概念和处理流程，尽量使用图表的形式。

2.4结构用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.2.5功能器求与程序的关系本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：2.6人工处理过程说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。

1引言 (2)1.1编写目的 (2)1.2背景 (2)1.3定义 (2)1.4参考资料 (2)2外部设计 (2)2.1标识符和状态 (2)2.2使用它的程序 (3)2.3约定 (3)2.4专门指导 (3)2.5支持软件 (3)3结构设计 (3)3.1概念结构设计 (3)3.2逻辑结构设计 (3)3.3物理结构设计 (4)4运用设计 (4)4.1数据字典设计 (4)4.2安全保密设计 (4)数据库设计说明书（GB8567——88）1引言1.1编写目的说明编写这份数据库设计说明书的目的，指出预期的读者。

1.2背景说明：a．说明待开发的数据库的名称和使用此数据库的软件系统的名称；b．列出该软件系统开发项目的任务提出者、用户以及将安装该软件和这个数据库的计算站（中心）。

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

1.4参考资料列出有关的参考资料：a．本项目的经核准的计划任务书或合同、上级机关批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用到的文件资料，包括所要用到的软件开发标准。

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

2外部设计2.1标识符和状态联系用途，详细说明用于唯一地标识该数据库的代码、名称或标识符，附加的描述性信息亦要给出。

如果该数据库属于尚在实验中、尚在测试中或是暂时使用的，则要说明这一特点及其有效时间范围。

2.2使用它的程序列出将要使用或访问此数据库的所有应用程序，对于这些应用程序的每一个，给出它的名称和版本号。

2.3约定陈述一个程序员或一个系统分析员为了能使用此数据库而需要了解的建立标号、标识的约定，例如用于标识数据库的不同版本的约定和用于标识库内各个文卷、、记录、数据项的命名约定等。

2.4专门指导向准备从事此数据库的生成、从事此数据库的测试、维护人员提供专门的指导，例如将被送入数据库的数据的格式和标准、送入数据库的操作规程和步骤，用于产生、修改、更新或使用这些数据文卷的操作指导。

1引言 (2)1.1编写目的 (2)1.2前景 (2)1.3定义 (2)1.4参考资料 (2)2软件征述 (2)2.1软件的结构 (2)2.2程序表 (2)2.3文卷表 (3)3安装与初始化 (3)4运行说明 (3)4.1运行表 (3)4.2运行步骤 (3)4.3运行1（标识符）说明 (3)4.3.1运行控制 (3)4.3.2操作信息 (3)4.3.3输入一输出文卷 (4)4.3.4输出文段 (4)4.3.5输出文段的复制 (4)4.3.6恢复过程 (4)4.4运行2（标识符）说明 (4)5非常规过程 (5)6远程操作 (5)操作手册（GB8567——88）1引言1.1编写目的说明编写这份操作手册的目的，指出预期的读者。

1.2前景说明：a．这份操作手册所描述的软件系统的名称；b．该软件项目的任务提出者、开发者、用户（或首批用户）及安装该软件的计算中心。

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

1.4参考资料列出有用的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用的文件、资料，包括所列出的这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

2软件征述2.1软件的结构结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。

2.2程序表列出本系统内每个程序的标识符、编号和助记名。

2.3文卷表列出将由本系统引用、建立或更新的每个永久性文卷，说明它们各自的标识符、编号、助记名、存储媒体和存储要求。

3安装与初始化一步一步地说明为使用本软件而需要进行的安装与初始化过程，包括程序的存载形式，安装与初始化过程中的全部操作命令，系统对这些命令的反应与答复，表征安装工作完成的测试实例等。

如果有的话，还应说明安装过程中所需用到的专用软件。

4运行说明所谓一个运行是指提供一个启动控制信息后，直到计算机系统等待另一个启动控制信息时为止的计算机系统执行的全部过程。

计算机软件产品开发文件编制指南（GB8567-88）国家有关计算机软件产品开发文件编制指南（GB 8567-88）只是一个国家标准，并不一定适合每一个企业，各企业（组织）应该按照标准，制订出符合自身软件过程规范的文档要求。

引言1 目的一项计算机软件的筹划、研制及实现，构成一个软件开发项目。

一个软件开发项目的进行，一般需要在人力和自动化资源等方面作重大的投资。

为了保证项目开发的成功，最经济地花费这些投资，并且便于运行和维护，在开发工作的每一阶段，都需要编制二定的文件。

这些文件连同计算机程序及数据一起，构成为计算机软件。

文件是计算机软件中不可缺少的组成部分，它的作用是：a．作为开发人员在一定阶段内的工作成果和结束标志；b．向管理人员提供软件开发过程中的进展和情况，把软件开发过程中的一些"不可见的"事物转换成“可见“的文字资料。

以便管理人员在各个阶段检查开发计划的实施进展，使之能够判断原定目标是否已达到，还将继续耗用资源的种类和数量；C．记录开发过程中的技术信息，便于协调以后的软件开发、使用和修改；d．提供对软件的有关运行、维护和培训的信息，便于管理人员、开发人员、操作人员和用户之间相互了解彼此的工作；e．向潜在用户报导软件的功能和性能，使他们能判定该软件能否服务于自己的需要。

换言之，本指南认为：文件的编制必须适应计算机软件整个生存周期的需要。

计算机软件所包含的文件有两类：一类是开发过程中填写的各种图表，可称之为工作表格；另一类则是应编制的技术资料或技术管理资料，可称之为文件。

本指南规定软件文件的编制形式，并提供对这些规定的解释。

本指南的目的是使得所编制的软件文件确实能够起到软件文件应该发挥的作用。

2 范围本指南是一份指导性文件。

本指南建议，在一项计算机软件的开发过程中，一般地说，应该产生十四种文件。

这十四种文件是：* （1）可行性研究报告；* （2）项目开发计划；* （3）软件需求说明书；* 数据要求说明书；* （4）概要设计说明书；* 详细设计说明书；* 数据库设计说明书；用户手册；操作手册；模块开发卷宗；（2）测试计划；测试分析报告；开发进度月报；项目开发总结报告。

[软⼯]概要设计说明书（GB8567-88）1.【引⾔】1.1 编写⽬的设计软件结构的具体任务是将⼀个复杂系统按功能进⾏模块划分、建⽴模块的层次结构及调⽤关系、确定模块间的接⼝及⼈机界⾯等。

数据结构设计包括数据特征的描述、确定数据的结构特性、以及数据库的设计。

此概要设计说明书是为了说明整个系统的体系架构，以及需求⽤例的各个功能点在架构中的体现，为系统的详细设计⼈员进⾏详细设计师的输⼊参考⽂档。

1.2 背景说明：a. 待开发软件系统的名称：机房收费系统b. 此项⽬的任务提出者：⽶新江教授c. 开发者：刘竞博d. ⽤户以及将运⾏该软件的计算站（中⼼）：廊坊师范学院机房电脑以及学⽣或教师个⼈笔记本电脑1.3 定义列出本⽂件中⽤到的专门术语的定义和外⽂⾸字母组词的原词组。

1.4 参考资料列出有关的参考⽂件，如：a. 软件需求说明书（GB856T-88）b. 《软⼯视频》张洪志c. 《SQL Server⼊门经典》敖富江译2.【总体设计】2.1 需求规定功能输⼊处理输出注册学⽣基本信息添加到数据库学⽣基本信息添加管理员管理员基本信息添加到数据库管理员基本信息充值充值卡号、充值⾦额添加到数据库充值⾦额、总余额查询上机纪录（等记录）学号或卡号查询数据库学⽣上机纪录（等记录）退卡卡号删除数据库信息退卡⾦额2.2 运⾏环境软件系统运⾏环境：Windows XP及以上系统2.3 基本设计概念和处理流程2.4 结构⽤⼀览表及框图的形式说明本系统的系统元素（各层模块、⼦程序、公⽤程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.2.5 功能器求与程序的关系管理端学⽣(教师)端学⽣基本信息表√√校园卡账户余额信息表√√2.6 ⼈⼯处理过程说明在本软件系统的⼯作过程中不得不包含的⼈⼯处理过程（如果有的话）。

2.7 尚未解决的问题数据库中多个表与功能实现的详细联系不够全⾯，⼤体关系已掌握，后续优化中。

软件设计文档国家标准GB8567-88一、文档编写标准化在整个项目开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。

完备的文档对软件的开发及使用起了很大的作用。

一般要求编写好十三种文档。

1、可行性分析报告说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。

2、项目开发计划为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书（软件规格说明书）对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。

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

4、概要设计说明书是概要设计阶段的工作总结。

主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。

5、详细设计说明书着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

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

7、测试计划包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

8、测试分析报告测试计划的执行情况，对测试结果的分析，提出测试结论。

9、开发进度月报按月提交的项目进展情况报告。

包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。

10、项目开发总结报告项目完成以后，总结实际执行情况。

如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。

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

软件设计文档国家标准GB8567-88一、文档编写标准化在整个项目开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。

完备的文档对软件的开发及使用起了很大的作用。

一般要求编写好十三种文档。

1、可行性分析报告说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。

2、项目开发计划为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书（软件规格说明书）对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。

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

4、概要设计说明书是概要设计阶段的工作总结。

主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。

5、详细设计说明书着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

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

7、测试计划包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

8、测试分析报告测试计划的执行情况，对测试结果的分析，提出测试结论。

9、开发进度月报按月提交的项目进展情况报告。

包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。

10、项目开发总结报告项目完成以后，总结实际执行情况。

如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。

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

1引言 (2)1.1编写目的 (2)1.2背景 (2)1.3定义 (2)1.4参考资料 (2)2程序系统的结构 (2)3程序1（标识符）设计说明 (2)3.1程序描述 (3)3.2功能 (3)3.3性能 (3)3.4输人项 (3)3.5输出项 (3)3.6算法 (3)3.7流程逻辑 (3)3.8接口 (3)3.9存储分配 (4)3.10注释设计 (4)3.11限制条件 (4)3.12测试计划 (4)3.13尚未解决的问题 (4)4程序2（标识符）设计说明 (4)详细设计说明书1引言1.1编写目的说明编写这份详细设计说明书的目的，指出预期的读者。

1.2背景说明：a．待开发软件系统的名称；b．本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。

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

1.4参考资料列出有关的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用到的文件资料，包括所要用到的软件开发标准。

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

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

3程序1（标识符）设计说明从本章开始，逐个地给出各个层次中的每个程序的设计考虑。

以下给出的提纲是针对一般情况的。

对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。

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

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

[计算机软件产品开发文件编制指南]GB8567-88 GB8567-88Guidelines for computer software product development documentation UDC6813黎宇 (转自国家计算机标准和文件模板) 2002-4-151一项计算机软件的筹划、研制及实现，构成一个软件开发项目。

一个软件开发项目的进行，一般需要在人力和自动化资源等方面作重大的投资。

为了保证项目开发的成功，最经济地花费这些投资，并且便于运行和维护，在开发工作的每一阶段，都需要编制二定的文件。

这些文件连同计算机程序及数据一起，构成为计算机软件。

文件是计算机软件中不可缺少的组成部分，它的作用是：a．作为开发人员在一定阶段内的工作成果和结束标志；b．向管理人员提供软件开发过程中的进展和情况，把软件开发过程中的一些“不可见的”事物转换成“可见的”文字资料。

以便管理人员在各个阶段检查开发计划的实施进展，使之能够判断原定目标是否已达到，还将继续耗用资源的种类和数量；C．记录开发过程中的技术信息，便于协调以后的软件开发、使用和修改；d．提供对软件的有关运行、维护和培训的信息，便于管理人员、开发人员、操作人员和用户之间相互了解彼此的工作；e．向潜在用户报导软件的功能和性能，使他们能判定该软件能否服务于自己的需要。

换言之，本指南认为：文件的编制必须适应计算机软件整个生存周期的需要。

计算机软件所包含的文件有两类：一类是开发过程中填写的各种图表，可称之为工作表格；另一类则是应编制的技术资料或技术管理资料，可称之为文件。

本指南规定软件文件的编制形式，并提供对这些规定的解释。

本指南的目的是使得所编制的软件文件确实能够起到软件文件应该发挥的作用。

2本指南是一份指导性文件。

本指甫建议，在一项计算机软件的开发过程中，一般地说，应该产生十四种文件。

这十四种文件是：可行性研究报告；项目开发计划；软件需求说明书；数据要求说明书；概要设计说明书；详细设计说明书；数据库设计说明书；用户手册；操作手册；模块开发卷宗；测试计划；测试分析报告；开发进度月报；项目开发总结报告。

软件设计国家标准⽂档操作⼿册（GB8567——88）1引⾔1.1编写⽬的说明编写这份操作⼿册的⽬的，指出预期的读者。

1.2前景说明：a．这份操作⼿册所描述的软件系统的名称；b．该软件项⽬的任务提出者、开发者、⽤户（或⾸批⽤户）及安装该软件的计算中⼼。

1.3定义列出本⽂件中⽤到的专门术语的定义和外⽂⾸字母组词的原词组。

1.4参考资料列出有⽤的参考资料，如：a．本项⽬的经核准的计划任务书或合同、上级机关的批⽂；b．属于本项⽬的其他已发表的⽂件；c．本⽂件中各处引⽤的⽂件、资料，包括所列出的这些⽂件资料的标题、⽂件编号、发表⽇期和出版单位，说明能够得到这些⽂件资料的来源。

2软件征述2.1软件的结构结合软件系统所具有的功能包括输⼊、处理和输出提供该软件的总体结构图表。

2.2程序表列出本系统内每个程序的标识符、编号和助记名。

2.3⽂卷表列出将由本系统引⽤、建⽴或更新的每个永久性⽂卷，说明它们各⾃的标识符、编号、助记名、存储媒体和存储要求。

3安装与初始化⼀步⼀步地说明为使⽤本软件⽽需要进⾏的安装与初始化过程，包括程序的存载形式，安装与初始化过程中的全部操作命令，系统对这些命令的反应与答复，表征安装⼯作完成的测试实例等。

如果有的话，还应说明安装过程中所需⽤到的专⽤软件。

4运⾏说明所谓⼀个运⾏是指提供⼀个启动控制信息后，直到计算机系统等待另⼀个启动控制信息时为⽌的计算机系统执⾏的全部过程。

4.1运⾏表列出每种可能的运⾏，摘要说明每个运⾏的⽬的，指出每个运⾏各⾃所执⾏的程序。

4.2运⾏步骤说明从⼀个运⾏转向另⼀个运⾏以完成整个系统运⾏的步骤。

4.3运⾏1（标识符）说明把运⾏1的有关信息，以对操作⼈员为最⽅便最有⽤的形式加以说明。

列出为本运⾏所需要”的运⾏流向控制的说明。

4.3.2操作信息给出为操作中⼼的操作⼈员和管理⼈员所需要的信息，如：a. 运⾏⽬的；b. 操作要求；c. 启动⽅法如应请启动（由所遇到的请求信息启动）、预定时间启动、…，··等；d. 预计的运⾏时间和解题时间；e. 操作命令；f. 与运⾏有联系的其他事项。

软件设计文档国家标准GB８５６７-88一、文档编写标准化在整个项目开发及使用过程中,应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。

完备的文档对软件的开发及使用起了很大的作用。

一般要求编写好十三种文档。

1、可行性分析报告说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。

2、项目开发计划为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书(软件规格说明书）对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。

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

4、概要设计说明书是概要设计阶段的工作总结。

主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。

5、详细设计说明书着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

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

７、测试计划包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

8、测试分析报告测试计划的执行情况,对测试结果的分析,提出测试结论。

9、开发进度月报按月提交的项目进展情况报告。

包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。

１0、项目开发总结报告项目完成以后，总结实际执行情况。

如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。

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

详细设计说明书（八号楼宿舍管理系统）1引言1.1编写目的在宿舍管理系统项目的前一阶段，也就是需求分析阶段中，已经将系统用户对本系统的需求做了详细的阐述，这些用户需求已经在上一阶段中对宿舍管理、管理员使用的实地调研中获得，并在需求规格说明书中得到详尽得叙述及阐明。

本阶段已在系统的需求分析的基础上，对宿舍管理系统做概要设计。

主要解决了实现该系统需求的程序模块设计问题。

包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息，以及数据结构、模块结构的设计等。

在以下的概要设计报告中将对在本阶段中对系统所做的所有概要设计进行详细的说明。

在下一阶段的详细设计中，程序设计员可参考此概要设计报告，在概要设计对机票预定系统所做的模块结构设计的基础上，对系统进行详细设计。

在以后的软件测试以及软件维护阶段也可参考此说明书，以便于了解在概要设计过程中所完成的各模块设计结构，或在修改时找出在本阶段设计的不足或错误。

1.2背景本项目（宿舍管理系统）是由宝鸡文理学院委托，由305宿舍小组负责开发。

系统基于宿舍管理系统做出优化，实现了宿舍的人员管理、宿舍的人员安全管理、宿舍的卫生管理、宿舍的电源管理几大主要功能，为宿舍管的人员提供了极大的便利。

1.3定义1.3.1专业用语SQL SERVER: 系统服务器所使用的数据库管理系统（DBMS）。

SQL: 一种用于访问查询数据库的语言。

事务流：数据进入模块后可能有多种路径进行处理。

主键：数据库表中的关键域。

值互不相同。

外部主键：数据库表中与其他表主键关联的域。

ROLLBACK: 数据库的错误恢复机制。

1.3.2缩写系统：若未特别指出，统指本机票预定系统。

SQL: Structured Query Language（结构化查询语言）。

ATM: Asynchronous Transfer Mode (异步传输模式)。

1.4参考资料以下列出在概要设计过程中所使用到的有关资料：1、宿舍管理系统项目计划任务书《》软件开发小组2010/092、学生宿舍管理系统项目开发计划《》软件开发小组2018/113、需求规格说明书《》软件开发小组1999/034、用户操作手册（初稿）《》软件开发小组1999/045、软件工程及其应用周苏、王文等天津科学技术出版社1992/016、软件工程张海藩清华大学出版社1990/117、Computer Network A.S.Tanenbaun Prentice Hall 1996/01文档所采用的标准是参照《软件工程导论》沈美明著的“计算机软件开发文档编写指南”。

操作手册（GB8567——88）1引言1.1编写目的本文档用于指导用户对网上预约挂号系统的安装、配置和操作等。

1.2前景说明：a．待开发的软件系统的名称：基于AJAX的网上预约挂号系统b．本项目的任务提出者：叶富升c．项目来源：1.3定义本文档中涉及到的术语及自定义的词语：AJAX：Asynchronous JavaScript XML 的简称，意思是异步JavaScrip t和XML技术；DOM：给和XML 文件使用的一组API。

它提供了文件的结构表述，允许开发人员改变其中的内容,建立网页与程序语言沟通的桥梁。

(AjaxPro) :用于在.net平台下开发应用程序和系统的ajax框架；有效预约纪录：通过网上预约挂号系统成功预约并且没有就诊的纪录1.4参考资料[1] 杨华.AJAX及在ASP. NET中的实现. 现代电子技术,20XX,12.[2] 范炜,赵政文,邓正宏.AJAX及AJAX. NET应用研究.科学技术与工程,第7卷第8期.[3] 谢延红,钱爱增,胡凯,郝迎英.ASP. NET AJAX 框架及在Web 开发中的应用.长春工程学院学报(自然科学版), 20XX,8(2).[4] 吴学义,黄永平,郭娜,徐昊.基于AJAX的B /S架构及应用.吉林大学学报(信息科学版),第25卷第3期.[5] 陆海晶,刘万军.基于Ajax的Web应用技术的研究与实现.科学技术与工程,第7卷第3期.[6] 谢延红,钱爱增.利用Ajax 技术开发无刷新聊天室系统.长春师范学院学报(自然科学版),第26 卷第3 期.[7] 吴应良,高海军,林梓鹏.基于Ajax的网站登录系统的设计与实现.现代图书情报技术,20XX,5.[8] 方俊.AJAX 引擎的设计和应用.电脑与信息技术,第14卷第3期.[9] ZakasN C,McPeak J,Fawcett J.Professional Ajax.Indianapolis :Publishing Inc, 20XX.[10] 王华杰,李律松,孙一波.精通C＃数据库开发.北京：清华大学出版社,20XX.[11] 陈兵国.基于AJAX 的网站设计与实现.福建电脑,20XX,12.[12] 陈永凯,顾绍元.基于AJAX 技术实现浏览器与服务器的异步通信.福建电脑,20XX,9.[13] 刘铁军.应用AJAX技术构建数字图书馆网络平台.上海高校图书馆情报工作研究,20XX,3.[14] Jesse James Garrett .Ajax: A New Approach to Web pplications.February 18, 20XX.[15] 石志国经典实用案例教程.北京：清华大学出版社,20XX.2软件征述2.1软件的结构结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。

1引言 (2)1.1编写目的 (2)1.2前景 (2)1.3定义 (2)1.4参考资料 (2)2软件征述 (2)2.1软件的结构 (2)2.2程序表 (2)2.3文卷表 (3)3安装与初始化 (3)4运行说明 (3)4.1运行表 (3)4.2运行步骤 (3)4.3运行1（标识符）说明 (3)4.3.1运行控制 (3)4.3.2操作信息 (3)4.3.3输入一输出文卷 (4)4.3.4输出文段 (4)4.3.5输出文段的复制 (4)4.3.6恢复过程 (4)4.4运行2（标识符）说明 (4)5非常规过程 (5)6远程操作 (5)操作手册（GB8567——88）1引言1.1编写目的说明编写这份操作手册的目的，指出预期的读者。

1.2前景说明：a．这份操作手册所描述的软件系统的名称；b．该软件项目的任务提出者、开发者、用户（或首批用户）及安装该软件的计算中心。

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

1.4参考资料列出有用的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用的文件、资料，包括所列出的这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

2软件征述2.1软件的结构结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。

2.2程序表列出本系统内每个程序的标识符、编号和助记名。

2.3文卷表列出将由本系统引用、建立或更新的每个永久性文卷，说明它们各自的标识符、编号、助记名、存储媒体和存储要求。

3安装与初始化一步一步地说明为使用本软件而需要进行的安装与初始化过程，包括程序的存载形式，安装与初始化过程中的全部操作命令，系统对这些命令的反应与答复，表征安装工作完成的测试实例等。

如果有的话，还应说明安装过程中所需用到的专用软件。

4运行说明所谓一个运行是指提供一个启动控制信息后，直到计算机系统等待另一个启动控制信息时为止的计算机系统执行的全部过程。