A.1 软件开发文件模板(规范性附录)
A.1.1 软件需求说明书
软件需求说明书
项目名称:
委托单位:
承担单位:
编写: 年 月 日
校对: 年 月 日
审核: 年 月 日
批准: 年 月 日
《软件需求说明书》的编制是为了使用户和软件开发者双方对该软件的初始规定有一个
共同的理解,使之成为整个开发工作的基础。《软件需求说明书》编制指导如下。
1 引言
1.1 编写目的
说明编写这份《软件需求说明书》的目的,指出预期的读者。
1.2 背景
说明待开发的软件系统的名称、版本号说明、本项目的任务提出者、开发者、用户以及该
软件系统同其他系统的关系。
1.3 修订审批记录
说明编写这份《软件需求说明书》的修订过程、审批过程。参见文档修订记录表及文档审
批记录表。
表 1 文档修订记录表
修订记录
章节
修订日期
版本
修订描述
修订者
审核者
表 2 文档审批记录表
审批记录
审批方式
审批日期
版本
文档所有者
提交者
审批者
1.4 术语和缩写词
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.5 参考资料
列出本文件中用到的参考资料(参考格式:作者、名称、出版单位、发表日期等)。
2 任务概述
2.1 目标
叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开
发的背景材料。
2.2 业务需求
叙述本软件最终用户的原始业务需求,包括:业务现状、预期功能需求、预期性能需求
以及其他专门需求,为需求分析提供支持。
2.3 用户特点
列出本软件的最终用户的特点,充分说明操作人员、维护人员的教育水平和技术专长,
以及本软件的预期使甩频度。这些是软件设计工作的重要约束。
2.4 假设和约束
列出进行本软件开发工作的假定和约束,例如经费限制、开发期限等。
3 总体需求
2
3.1 组织结构
绘出待开发软件系统最终用户的组织结构图,并对各组织的作用以及相互关系加以说
明。
3.2 业务流程
说明待开发软件系统的业务流程。此流程可用图表即流程图的形式表示,并加以叙述。
3.3 数据流程
说明待开发软件系统的数据流程。此流程可用图表即流程图的形式表示,并加以叙述。
4 需求规定
4.1 功能需求
从以下四个部分,详细叙述每一类功能或每一个功能对软件所提出的功能要求,说明
输入什么量、经过怎样处理、得到什么输出:
(1) 引言
该功能要达到的目标、所采用的方法和技术。还应清楚说明该功能意图的由来和背景。
(2)输入
该功能的所有输入以及输入操作时控制细节的需求。
(3)加工
定义输入数据、中间参数,以及获得预期输出结果的全部操作。它包括如下的说明:
输入数据的有效性检查;
操作的顺序;
响应,例如,溢出、通信故障、错误处理等;
用于把系统输入变换成相应输出的任何方法(方程式、数学算法、逻辑操作等);
输出数据的有效性检查。
(4)输出
该功能所有输出以及非法值的处理、出错信息。
4.2
性
能
需
求
说明对该软件的输入、输出数据精度的要求、对时间特性要求以及对对灵活性的要求。
4.3 其他专门需求
说明对安全保密的要求、对使用方便的要求以及对可靠性、维护性、可扩充性的特殊要求
等。
5 运行环境规定
5.1 设备
列出运行该软件所需要的硬设备。
5.2 支持软件环境
列出支持软件,包括要用到的操作系统、编译(或汇编)程序、测试支持软件等。
5.3 接口
说明该软件同其他软件之间的接口、数据通信协议等。
3
A.1.2 系统设计说明书
系统设计说明书
项目名称:
委托单位:
承担单位:
编写: 年 月 日
校对: 年 月 日
审核: 年 月 日
批准: 年 月 日
4
《系统设计说明书》的编制,是为了说明对程序系统的设计考虑。《系统设计说明书》编制
Q/SY XJXXXX—2007
指导如下。
1 引言
1.1 编写说明
说明编写这份《系统设计说明书》的目的,指出预期的读者。
1.2 背景
说明待开发的软件系统的名称、版本号说明、本项目的任务提出者、开发者、用户以及该
软件系统同其他系统的关系。
1.3 修订审批记录
说明编写这份《系统设计说明书》的修订过程、审批过程。参见文档修订记录表及文档审
批记录表。
表 1 文档修订记录表
修订记录
章节
修订日期
版本
修订描述
修订者
审核者
表 2 文档审批记录表
审批记录
审批方式
审批日期
版本
文档所有者
提交者
审批者
1.4 需求概述
简略说明待开发的软件系统的基本需求。详细的说明可参见《软件需求说明书》。
1.5 术语和缩写词
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.6 参考资料
列出本文件中用到的参考资料(参考格式:作者、名称、出版单位、发表日期等)。
2 总体设计
2.1 软件实现技术及特点
5
Q/SY XJXXXX—2007
简要列出开发本软件系统的所使用的技术及特点。
2.2 基本设计概念和处理流程
说明本系统的基本设计概念和处理流程,尽量使用图表的形式。
2.3 结构设计
用图表的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,扼要
说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系。
2.4 运行环境设计
说明本程序运行时所必需的环境条件。
2.5 接口设计
说明本系统同外界接口的安排(包括软件与硬件之间的接口)、本系统与各支持软件之
间的接口关系。以及关于用户接口、内部接口的相关说明。
2.6 出错处理设计
说明系统出错时输出信息的形式、含意及处理方法;故障出现后可能采取的变通措施以
及为了系统维护的方便而在程序内部设计中所做出的安排。
2.7 安全保密设计
关于系统安全保密的相关安排和处理。
2.8 标识符设计
说明准备在本程序中安排的标识符。
3 模块设计
从功能描述、处理流程、界面设计、出错处理设计等方面,逐个地给出各个层次中的每个
模块的设计考虑。
3.1 模块 1
a. 功能描述
以条目的方式详细说明该模块的功能。
b. 处理流程
以图示(流程图,时序图,活动图)方式描述功能模块的实现原理。
c. 界面设计
绘制该功能的实现界面及界面之间的关系。
d. 出错处理设计
6
Q/SY XJXXXX—2007
描述功能模块的出错情况和容错机制。
3.2 模块 2
用类似本文3.1节的方式给出第2项及其后各项模块设计描述。
......。
3.n 模块 n
......。
A.1.3 数据库设计说明书
数据库设计说明书
项目名称:
委托单位:
7
Q/SY XJXXXX—2007
承担单位:
编写: 年 月 日
校对: 年 月 日
审核: 年 月 日
批准: 年 月 日
《数据库设计说明书》的编制,是对于设计中的数据库的所有标识、逻辑结构和物理结
构做出具体的设计规定。《数据库设计说明书》编制指导如下。
1 引言
1.1 编写说明
说明编写这份《数据库设计说明书》的目的,指出预期的读者。
1.2 背景
说明待开发数据库的名称、版本号说明、使用范围并列出本项目的任务提出者和开发者。
1.3 修订审批记录
说明编写这份《数据库设计说明书》的修订过程、审批过程。参见文档修订记录表及文档
审批记录表。
表 1 文档修订记录表
8