软件开发文档：需求规格说明书-范本.docx

[项目名称]
需求规格说明书

建设单位：
承建单位：
编订时间：YYYY-MM-DD

文件修订记录
修订日期
版本
修订内容
修订人
审核人

目 录
第 1 章 前言 1
1.1 目的 1
1.2 项目概述 1
1.3 术语和缩写 1
1.4 参考资料 1
第 2 章 业务需求 1
2.1 用户组织结构 1
2.2 业务需求概述 2
2.3 业务需求一 2
2.4 业务需求二 2
第 3 章 功能需求 2
3.1 功能需求概述 2
3.2 用户角色 2
3.3 公共功能需求 2
3.4 模块一 2
3.5 模块二 4
第 4 章 用户界面需求 4
第 5 章 系统接口需求 4
5.1 接口需求一 4
5.2 接口需求二 5
5.3 转换需求 5
第 6 章 代码集 5
6.1 代码一 5
6.2 代码二 5
第 7 章 系统运行环境 5
7.1 软件环境 5
7.2 硬件环境 5
7.3 网络环境 6
第 8 章 其它需求 6
8.1 性能需求 6
8.2 存储需求 6
8.3 易用性需求 6
8.4 可靠性需求 6
8.5 可维护性需求 7
8.6 安全需求 7
8.7 设计约束 7

第 1 章 前言
1.1 目的
说明开发本软件的目的；
说明编写文档的目的；
说明本文档所预期的读者

1.2 项目概述
简述项目背景及目标：
项目背景：
项目的提出原因
项目环境背景
项目优势分析（资源、技术、人才、管理等方面）
项目运作的可行性
项目的独特与创新分析
1.3 术语和缩写
列出本需求说明书中专门术语的定义以及英语缩写词的原词组。
1.4 参考资料
列出本项目经核准的任务书或合同和上级机关的批文；
列出编写本软件需求说明书时参考的文件、资料、技术标准以及它们的作者、标题、发布日期和出版单位等。
第 2 章 业务需求
描述客户组织结构、业务处理流程，接口需求、及其他需求。如果编写了《业务需求说明书文档》可在此处引用，不需要编写本章节内容。
2.1 用户组织结构
说明业务系统所涉及到的用户部门、岗位、职责，并说明与业务系统相关的用户特性。用户特性一般包含操作人员、维护人员的教育水平和技术专长以及本软件的预期使用频度。这些是软件设计工作的重要约束。
例如：二次开发人员：具有很高的专业知识水平，理解业务系统的运行机制。可以对开放代码进行阅读和分析，以完成其系统独特的需求，提供给这部分用户开放API手册和Debug版本的源代码即可。
一般用户：具有一定的计算机操作能力和知识，了解业务领域的相关概念和用途。提供给这部分用户操作手册即可。
维护人员：具有较高的计算机专业水平，可以对常见的系统Bug进行追踪和分析，具有一定的测试能力，这部分用户主要是采用了本系统之后的后期工作维护者。
2.2 业务需求概述
对业务需求从整体上进行概述，并说明业务边界。
2.3 业务需求一
如果业务需求较多，需目录层次描述。
2.3.1 业务描述
简要描述本章节业务需求，如果业务流程章节省略，本章节须与上一章节合并。
2.3.2 业务流程
可选章节，结合业务流程图对业务流程描述和所需的业务表单进行说明，如果业务流程比较简单，可以整体描述，如果业务流程比较复杂，须分节点描述。
2.4 业务需求二
第 3 章 功能需求
3.1 功能需求概述
对系统功能进行概述，画出系统功能结构图并对其进行说明，注意一定要包含后台维护性功能与统计性功能的说明。
3.2 用户角色
说明与系统使用相关的所有角色，使用下表列出。
#
角色名称
角色说明

3.3 公共功能需求
可选章节。
为了解决重复描述，将散落在各个模块的需求描述抽取出来，统一进行描述，包括但不限于分页功能、字段校验提示、系统错误、安全错误、系统超时、流程预警及超时提醒。

3.4 模块一
对于较大型系统可以根据实际需要按目录分解子模块、三四级模块分层进行说明。
3.4.1 功能结构
使用功能结构表列出本模块所有功能。
功能名称
涉及角色
说明

3.4.2 功能一
1. 功能描述
对该功能进行简述，并对所涉及的页面及其导航链接关系进行说明。
2. 用户界面
画出用户界面图形，可以使用系统原型界面截图。
3. 用户界面说明
详细描述页面数据，可以使用下表进行描述：
#
数据名称
类型
长度
格式
必须
取值
备注
1

注：1) 类型包含单行输入框、多行输入框、下拉框、单选框、多选框、列表框、双向选择、按钮、链接、显示（表示数据字段只为查看的内容，非编辑字段）显示编辑（表示数据字段作为可查看内容同时又可编辑）；
2) 格式包含字符、日期、数字等；
3) 必须表示是必填还是可空；
4) 取值表示数据的取值范围，对于代码类型的数据，可以引用代码名称；
5) 备注中描述其他信息（象按钮完成的功能等）

4. 功能操作说明
输入
详细描述该用户界面的输入数据，如：输入源、数量或有效范围、度量单位、时间设定。
业务处理
说明该功能的业务处理过程，一般包含：
输入数据的有效性检查；
业务操作顺序（包括事件的时间设定）；
异常响应处理，例如，溢出、通信故障、错误处理等；
受操作影响的参数；
输出数据的有效性检查。
输出
详细描述该功能所有输出数据，包含输出目的地、数量或有效范围、度量单位、时间关系、出错信息描述；
3.4.3 功能二
3.4.3.1 子功能
3.4.3.1.1 子功能
3.4.3.1.1.1 子功能
3.4.3.1.1.1.1 子功能

3.5 模块二
第 4 章 用户界面需求
可选章节，如果用户有明确的界面公共需求则需要在这里通过界面效果截图进行描述。用户界面需求通常包含：
用户界面大体风格描述，对屏幕格式的要求，色彩、分辨率等；
屏幕行为（例如进入程序后第一界面，焦点默认于左上角底一个按钮，还是无焦点状态）；
用户的交互方法（例如快捷键和右键菜单）；
系统时间会应用户的反馈时间；
各种特色的控件交互；
窗口位置、大小；
软件导航的数据与软件同步；
错误的预防和恢复；
标准色、图标指针的标准应用；
报表或菜单的页面打印格式和内容；
程序功能键的可用性；
即时帮助与提示。
第 5 章 系统接口需求
5.1 接口需求一
5.1.1 接口目的
5.1.2 接口方式与标准
以何种方式提供接口、如何使用接口、接口必须遵守的标准规范。
5.1.3 接口内容
接口传递的数据信息与处理过程描述等。
5.2 接口需求二
5.3 转换需求
数据转换需求。通常需要把一些历史数据（包含纸质的、电子的独立文件）导入到开发的系统中去。
第 6 章 代码集
如果代码内容较多，可以在独立的文档中按照以下要求编写，并将此独立文档作为附件。
6.1 代码一
说明此代码名称，并对代码的用途或内容等进行简述，说明代码采用的编码规则，并说明代码集内容。代码集属性至少包含：编码、名称、说明，可以增加其他属性列（简称、缩写等）。
如果编码规则使用国标或行标等相关标准规范，可以在此写出引用标准规范名称，并将被引用标准规范作为附件，不再需要填写下表。
代码名称

代码简述

编码规则

#
编码
名称
说明
1

2

3

4

5

6.2 代码二
第 7 章 系统运行环境
说明系统正式运行的客户环境要求，最好结合系统部署图进行说明。
7.1 软件环境
列出支持软件,包括要用到的操作系统、中间件、数据库等。
7.2 硬件环境
列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能，包括：
处理器型号及内存容量；
外存容量、联机或脱机、媒体及其存储格式，设备的型号及数量；
数据通信设备的型号和数量；
其他输入及输出设备的型号和数量，联机或脱机。
7.3 网络环境
第 8 章 其它需求
可选章节，根据业务需要选择涉及到的小节进行描述，如果小节的内容不能涵盖其他需求，可以增加小节进行描述，例如扩充性，扩展性，软件所有必需的法律免责声明、担保、版权声明、专利声明、文字商标、商标或徽标遵从问题等。
8.1 性能需求
描述哪些业务操作对性能的具体需求，并解释产生性能需求的原因以帮助开发人员作出合理的设计选择。性能需求通常包含：
并发用户数量（总用户量及并发用户量）
事务的响应时间（平均值、最大值），通常指在达到最大并发用户时的响应时间；
吞吐量，例如每秒事务数 ，通常指在达到最大并发用户时的吞吐量；
容量；一般指系统能够容纳的用户或事务数量；
8.2 存储需求
描述磁盘空间、数据库或存储器的数据容量需求。一般计算每年的数据存储需求，每年的增长率等。
8.3 易用性需求
易用性需求指用户为使用系统功能所做的努力与使用评价，一般包含易理解、易学习、易操作等方面。
8.4 可靠性需求
可靠性需求指系统保持正常运行的能力，常用的衡量指标：
此处应指定系统的可靠性需求。建议如下：
可用性 －指有效的时间内运行比率的正常值（运行比率=正常运行时间÷（正常运行时间+修复时间））；
平均故障间隔时间（MTBF）－ 通常以小时为单位指定，但也可以天、月或年为单位指定；
平均修复时间（MTTR）－ 指在系统发生故障后允许系统中断时间；
准确性 － 指定在系统输出中必需的精度（分辨率）和准确性（按照某些已知的标准）；
最大错误或缺陷率 － 通常以每千行代码错误数（错误数／KLOC）或每个功能点错误数（错误数／功能点）为单位表示。

8.5 可维护性需求
可维护性指维护系统正常运行或修复问题所做出努力的程度。一般包含日常运维、服务响应、系统升级、系统运行监控方法与手段、问题定位与分析方法、完整可靠的数据备份方案以及相关的制度规范等方面的要求。

8.6 安全需求
安全性需求一般包含：
应用安全
数据安全
网络与系统安全
物理安全
确定系统安全性的要素一般包含：
确定需要保护的安全对象
确定安全威胁的来源
确定安全威胁的类型
意外的损坏或破坏
故意的损坏或破坏
欺骗行为
黑客行为
病毒/木马
8.7 设计约束
说明对于要构建系统的所有设计约束。设计约束是指批准的必须遵从的设计决定，一般包含软件语言、软件流程管理、使用的开发工具、体系结构和设计约束、购买的组件、类库等。