[模板] 软件需求规格说明书编写指南

XXXX项目

软件需求规格说明书编写指南

（正式发布）

编制单位

总页数 编制 正文 附录 批准 生效日期

变更履历

软件需求规格说明书编写指南

修改编号 版本 修改内容 修改人 修改日期

第2 页 共 19 页

目 录

第一章 1.1 1.2 1.3 1.4 第二章 2.1

编写目的 ......................................................................................................... 7 目的 .................................................................................................................... 7 软件需求规格说明书评审 ................................................................................ 7 软件需求规格说明书确认 ................................................................................ 7 文档内容 ............................................................................................................ 8 软件需求规格说明书的内容格式要求 ......................................................... 9 引言 .................................................................................................................... 9

目的 ............................................................................................................. 9 范围 ............................................................................................................. 9 定义 ........................................................................................................... 10 参考资料 ................................................................................................... 10 软件概述 ................................................................................................... 10

2.1.1 2.1.2 2.1.3 2.1.4 2.1.5 2.2

项目概述 .......................................................................................................... 11

项目现状 ................................................................................................... 11 产品描述 ................................................................................................... 11 产品功能 ................................................................................................... 11 运行环境 ................................................................................................... 11 用户特点 ................................................................................................... 11 一般约束 ................................................................................................... 12 假设和依据 ............................................................................................... 12

2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7 2.3

需求规格 .......................................................................................................... 12

接口需求 ................................................................................................... 12

2.3.1

2.3.1.1 内部接口需求 ................................................................................... 12 2.3.1.1.1 <接口1> ......................................................................................... 12

2.3.1.1.1.1 业务需求 ....................................................................................... 12 2.3.1.1.1.2 业务流程与流程说明 ..................................................................... 13 2.3.1.1.1.3 接口需求分析 ................................................................................ 13 2.3.1.1.2 <接口n> ......................................................................................... 13

软件需求规格说明书编写指南

2.3.1.2 外部接口需求 ................................................................................... 13 2.3.1.2.1 <接口1> ......................................................................................... 13

2.3.1.2.1.1 业务需求 ....................................................................................... 13 2.3.1.2.1.2 业务流程与流程说明 ..................................................................... 13 2.3.1.2.1.3 接口需求分析 ................................................................................ 13 2.3.1.2.2 <接口n> ......................................................................................... 13

2.3.2 功能需求1 ................................................................................................ 13

2.3.2.1 业务描述 ........................................................................................... 13 2.3.2.2 业务流程图 ....................................................................................... 14 2.3.2.3 功能分析 ........................................................................................... 14 2.3.2.3.1 功能清单 ........................................................................................ 14 2.3.2.3.2 系统功能流程图 ............................................................................ 14 2.3.2.3.3 功能模块1 ..................................................................................... 14

2.3.2.3.3.1 功能描述 ....................................................................................... 14 2.3.2.3.3.2 流程描述 ....................................................................................... 15 2.3.2.3.3.3 事件流描述 .................................................................................... 15 2.3.2.3.3.4 数据描述 ....................................................................................... 15 2.3.2.3.3.5 算法描述 ....................................................................................... 15 2.3.2.3.3.6 界面描述 ....................................................................................... 16 2.3.2.3.4 功能模块N .................................................................................... 16

2.3.3 2.3.4 2.3.5 2.3.6

功能需求N ............................................................................................... 16 非功能性需求1 ........................................................................................ 16 非功能性需求N ....................................................................................... 16 报表功能需求 ........................................................................................... 16

报表统一需求 .................................................................................... 16 报表1 ................................................................................................. 16 报表n ................................................................................................. 17

2.3.6.1 2.3.6.2 2.3.6.3 2.3.7 2.3.8 2.3.9 2.4 2.5

其它需求1(可选) ..................................................................................... 17 其它需求N（可选） ............................................................................... 17 测试用例 ................................................................................................... 18

其它方面的描述（可选） .............................................................................. 18 附录 .................................................................................................................. 18

输入单据 ................................................................................................... 18

2.5.1

2.5.1.1.1 <单据1>（单据编号） ................................................................. 18

第4 页 共 19 页

软件需求规格说明书编写指南

2.5.1.1.2 <单据n>（单据编号） ................................................................. 18 2.5.2

输出单据 ................................................................................................... 18

2.5.2.1.1 <单据1>（单据编号） ................................................................. 18 2.5.2.1.2 <单据n>（单据编号） ................................................................. 18 2.5.3

报表表样 ................................................................................................... 18

2.5.3.1.1 <报表1>（报表编号） ................................................................. 19 2.5.3.1.2 <报表n>（单据编号） ................................................................. 19 2.5.4 第三章 3.1

尚需解决的问题列表 ............................................................................... 19 举例 .................................................................................. 错误!未定义书签。 引言 ..................................................................................... 错误!未定义书签。

目的 .............................................................................. 错误!未定义书签。 范围 .............................................................................. 错误!未定义书签。 定义 .............................................................................. 错误!未定义书签。 参考资料 ...................................................................... 错误!未定义书签。 软件概述 ...................................................................... 错误!未定义书签。

3.1.1 3.1.2 3.1.3 3.1.4 3.1.5 3.2

项目概述 ............................................................................. 错误!未定义书签。

项目现状 ...................................................................... 错误!未定义书签。 产品描述 ...................................................................... 错误!未定义书签。 产品功能 ...................................................................... 错误!未定义书签。 用户特点 ...................................................................... 错误!未定义书签。 一般约束 ...................................................................... 错误!未定义书签。 假设和依据 .................................................................. 错误!未定义书签。

3.2.1 3.2.2 3.2.3 3.2.4 3.2.5 3.2.6 3.3

需求规格 ............................................................................. 错误!未定义书签。

离退休人员管理(FC.2.1) ............................................. 错误!未定义书签。

3.3.1

3.3.1.1 业务描述 .............................................................. 错误!未定义书签。 3.3.1.2 业务流程图 .......................................................... 错误!未定义书签。 3.3.1.3 功能分析 .............................................................. 错误!未定义书签。 3.3.1.3.1 功能清单 ........................................................... 错误!未定义书签。 3.3.1.3.2 系统功能流程图 ............................................... 错误!未定义书签。

第5 页 共 19 页

软件需求规格说明书编写指南

3.3.1.3.3 企业职工离退休审核 ....................................... 错误!未定义书签。

3.3.1.3.3.1 3.3.1.3.3.2 3.3.1.3.3.3 3.3.1.3.3.4 3.3.1.3.3.5 3.3.1.3.3.6

功能描述 ............................................................. 错误!未定义书签。 流程描述 ............................................................. 错误!未定义书签。 事件流描述 .......................................................... 错误!未定义书签。 数据描述 ............................................................. 错误!未定义书签。 算法描述 ............................................................. 错误!未定义书签。 界面描述 ............................................................. 错误!未定义书签。

…… .............................................................................. 错误!未定义书签。

3.3.2

3.3.2.1 …… ....................................................................... 错误!未定义书签。

3.3.2.1.1 …… .................................................................... 错误!未定义书签。

3.3.2.1.1.1 …… ...................................................................... 错误!未定义书签。

第四章

附录 .................................................................................. 错误!未定义书签。

第6 页 共 19 页

软件需求规格说明书编写指南

第一章 编写目的

1.1 目的

本文档旨在指导项目建设单位和承建单位编写软件需求规格说明书，并说明软件需求规格说明书的内容、格式和评审要求。

1.2 软件需求规格说明书评审

各承建单位在需求调研结束或即将结束时，应组织项目组成员编写软件需求规格说明书，编写软件需求说明书时，要把需求调研阶段各单位业务人员的业务要求清晰、明了的表述出来。承建单位技术人员，要积极的参与软件需求规格说明书的编写。承建商项目组在软件需求规格说明书编写完成后，要先在承建单位内部评审。

软件需求规格说明书内部评审通过后，连同内部评审记录提交给监理，总监理组织项目建设单位、项目业务单位、监理进行评审，评审通过后，由各方进行签字盖章确认。各方要分别从以下角度进行评审：项目建设单位从软件需求规格说明书的全面性（根据招投标和合同要求是否含盖了所有的项目建设内容）进行评审；业务单位的业务人员从业务角度给予评审；承建单位技术人员从技术角度进行技术评审；监理单位从规范性方面进行评审。根据需要，可邀请外部专家一同参与评审。

软件需求规格说明书中，各章节中的业务需求、业务流程与流程说明以及附录中的业务表单等章节描述的是具体的业务，业务人员重点评审这一部分内部；技术人员要重点评审各章节中功能分析等内容。

软件需求规格说明书由各方进行签字确认，承建单位进入开发阶段后，软件需求规格说明书不能发生变更，此办法另行制定。

1.3 软件需求规格说明书确认

各方评审完软件需求规格说明书后，要对其评审的内容进行确认，确认无问题后，进行签字，并对其负责。

各方要签署软件需求规格说明书需求确认单；业务人员签署软件需求规格说

第7 页 共 19 页

软件需求规格说明书编写指南

明书业务需求确认单，对所提的业务需求负责，保证所提业务需求清晰、准确、无二义性。业务需求确认单以附录形式附在软件需求规格说明书需求确认单后。签署的软件需求规格说明书需求确认单和业务需求确认单由总监理单位存档，以备后查。

软件需求规格说明书需求确认单和业务需求确认单格式如本文档附录。

1.4 文档内容

本软件需求规格说明书编写指南主要包含以下内容：

第一、软件需求规格说明书的内容和格式要求，软件需求规格说明书的格式应以第二章节的格式来编写，内容包含引言、项目概述、需求规格、附录和关于软件需求的一些其它方面的描述。其中需求规格是本章节的重点，包括了接口需求、功能需求、非功能需求等。

第二、根据第二章节软件需求规格说明书的内容和格式要求，本章例举了一个示例，用来演示软件需求规格说明书的编写方法。所举示例是以企业职工养老退休时，企业职工离退休审核为例来描述。

第三、附录，软件需求规格说明书需求确认单和业务需求确认单的格式。

第8 页 共 19 页

软件需求规格说明书编写指南

第二章 软件需求规格说明书的内容格式要求

本章节主要描述软件需求规格说明书的内容和格式要求，各项目建设单位和承建单位要按照本章节的格式和内容来编写软件需求规格说明书。

考虑到各板块系统庞大、复杂，那么可根据情况，以总册和分册的形式来展现需求规格说明书。总册中对项目共性的需求进行描述，分册中重点描述需求规格这一章节的内容。总册和分册的内容格式也要按照本章节的格式和内容来编写，总册和分册可相互引用。

为便于后期文档管理，软件需求规格说明书的流程图和其它的图示，均用Microsoft Offic Visio工具来划。

2.1 引言

2.1.1 目的

一、本软件需求规格说明书主要目的为：

需求规格说明书是将业务人员描述的需求，以贴近软件系统的描述、软件开发人员更容易理解的描述形成的需求报告。需求规格说明书的质量对软件系统的好坏有着直接、重要的影响。

本文档的目的是希望通过规则要点的形式，辅以实际案例片段，展示给建设单位和承建单位，使其在形成需求规格说明书的时候，有一个比较好的参考和依照，能够清晰、准确的表达出业务需求，为系统质量打好基础。

二：本软件需求规格说明书的预期读者： 用户 系统设计人员 数据库设计人员 用户手册编写人员 系统确认测试人员 系统维护人员 ……

2.1.2 范围

第9 页 共 19 页

软件需求规格说明书编写指南

说明：

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

b． 说明软件将干什么，如果需要的话，还要说明软件产品不干什么； c． 描述所说明的软件的应用。应当：

1）尽可能精确地描述所有相关的利益、目的、以及最终目标。

2）如果有一个较高层次的说明存在，则应该使其和高层次说明中的类似的陈述相一致。

2.1.3 定义

列出本文中用到的专门术语的定义和缩写词的原词组 序号 1 2 词汇名称 简写/缩略语 所指对象或含义 2.1.4 参考资料

列出要用到的参考资料，如：

a． 本项目的经核准的计划任务书或合同、上级机关的批文； b． 属于本项目的其他已发表的文件；

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

对软件系统的一些概述，主要描述软件总体业务流程图，软件的总体功能结构图等。最好以图的形式直观描述。

第10 页 共 19 页

软件需求规格说明书编写指南

2.2 项目概述

2.2.1 项目现状

在此描述目前项目的业务现状和系统现状。

2.2.2 产品描述

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

2.2.3 产品功能

本条是为将要完成的软件功能提供一个摘要。例如，对于一个记帐程序来说，需求说明可以用这部分来描述：客房帐目维护、客房财务报表和制作，而不必把功能所要求的大量的细节描写出来。有时，如果存在较高层次的规格说明时，则功能摘要可从中取得，这个较高层次的规格说明为软件产品分配了特殊的功能，为了清晰起见，请注意：

a． 编制功能的一种方法是制作功能表，以便用户或者第一次读这个文件的人都可以理解；

b． 用方框图来表达不同的功能和它们的关系也是有帮助的。但应牢记，这样的图不是产品设计时所需求的，而只是一种有效的解释性的工具。

2.2.4 运行环境

简要说明本系统的运行环境(包括硬件环境和支持环境)的规定。

2.2.5 用户特点

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

第11 页 共 19 页

软件需求规格说明书编写指南

2.2.6 一般约束

本条对设计系统时开发者选择的其他一些项作一般性描述。而这些项将限定开发者在设计系统时的任选项。这些包括：

a． 管理方针； b． 硬件的； c． 与其他应用间的接口； d． 并行操作； e． 审查功能； f． 控制功能； g． 所需的高级语言； h． 通信协议； i． 应用的临界点； j． 安全和保密方面的考虑。

2.2.7 假设和依据

本条列出影响需求说明需求的每一个因素。这些因素不是软件的设计约束，但是它们的改变可能影响到需求说明中的需求。例如：假定一个特定的操作系统是在被软件产品指定的硬件上使用的，然而，事实上这个操作系统是不可能使用的，于是，需求说明就要进行相应的改变。

2.3 需求规格

2.3.1 接口需求

2.3.1.1 内部接口需求 可分类描述。

实现系统内部各个子系统之间的接口的清单。在此以列表的形式列出所有内部接口。

2.3.1.1.1 <接口1> 2.3.1.1.1.1 业务需求

第12 页 共 19 页

软件需求规格说明书编写指南

概括描述接口业务的需求。 2.3.1.1.1.2 业务流程与流程说明

画出接口业务流程图，并对流程进行简要的文字说明。 2.3.1.1.1.3 接口需求分析

…… 2.3.1.1.2 <接口n>

……

2.3.1.2 外部接口需求

最好分类描述，不限于以下分类，如用户接口、软件接口、硬件接口、通信接口等。

实现系统与外部系统之间的接口的请单。在此以列表的形式列出所有外部接口。

2.3.1.2.1 <接口1> 2.3.1.2.1.1 业务需求

概括描述接口业务的需求。 2.3.1.2.1.2 业务流程与流程说明

画出接口业务流程图，并对流程进行简要的文字说明。 2.3.1.2.1.3 接口需求分析

…… 2.3.1.2.2 <接口n>

……

2.3.2 功能需求1

2.3.2.1 业务描述

概括描述业务工作流程及总体规则等

第13 页 共 19 页

软件需求规格说明书编写指南

2.3.2.2 业务流程图

画出业务流程图 2.3.2.3 功能分析 2.3.2.3.1 功能清单

序号 功能名称 备注 2.3.2.3.2 系统功能流程图

画出系统功能流程图 2.3.2.3.3 功能模块1 2.3.2.3.3.1 功能描述

 功能名称  功能分类

描述该功能属于哪个大类的业务。  优先级

明确该功能在整个系统中的应用优先级别。对于优先级高的功能，可以考虑尽早开发出来，进行测试、应用。

 业务背景

描述该功能的业务场景。  功能说明

描述该功能要实现哪些操作。  前置条件

描述该业务办理之前，需要符合哪些业务条件。  后置条件

描述该业务办理完毕之后，业务的变化。  业务表单

第14 页 共 19 页

软件需求规格说明书编写指南

列明该业务涉及到的业务表单，并标明属于系统的输入还是输出表单，说明使用表单的时机。

 业务规则

详细描述系统在对该业务的实现过程里，把业务需求转化为按照计算机系统需要处理的逻辑规则进行说明。如：系统界面需要默认显示哪些信息、界面上信息项之间的联动规则、系统对输入信息项进行自动校验的规则等等。 2.3.2.3.3.2 流程描述

以流程图的形式描述功能的流程。 2.3.2.3.3.3 事件流描述

 基本流

站在使用系统的角度，描述业务经办的操作人员从操作的第一步开始，如何与系统间进行交互、以及交互操作的步骤，系统如何响应。

 备选事件流

作为基本流的补充说明，主要描述系统在遇到一些无法返回正确结果或异常的时候，系统如何给出提示。 2.3.2.3.3.4 数据描述

 输入数据

列明需要在系统界面录入的信息项，如果是界面必录项的话需要标注出来，如果涉及二级代码的话，需要列出二级代码项。

 输出数据

在业务办理过程中或结束后，由系统展示或生成的信息项。如果涉及二级代码的话，需要列出二级代码项。 2.3.2.3.3.5 算法描述

 算法

对该功能实现涉及到的计算进行描述，要清楚、详细。  算法举例

第15 页 共 19 页

软件需求规格说明书编写指南

通过举实例的方式说明算法，以使系统设计开发人员更好的理解算法。 2.3.2.3.3.6 界面描述

可选择以下两种方式进行描述。

 界面原型

承建单位可以把本公司已经实现的系统功能界面，以截图的形式展示给业务需求调研人员，同时对界面的操作进行描述，对照着界面来梳理事件流、数据项、界面布局、必录项等，会有助于将需求更贴近实际的描述出来。界面要包括主界面、弹出界面、多分页等，即该功能涉及的所有界面。

 工具绘制

可以根据需求调研的实际情况，用某个开发工具绘制出界面，同时对界面的操作进行描述，这个界面可能不是将来系统实际使用的界面，但是界面上的布局、信息项等都是根据需求实际模拟的，可以作为系统界面设计开发时的重要依据。界面要包括主界面、弹出界面、多分页等，即该功能涉及的所有界面。 2.3.2.3.4 功能模块N

……

2.3.3 功能需求N

……

2.3.4 非功能性需求1

在此描述非功能性的需求，如性能需求、安全性需求、用户管理等。

2.3.5 非功能性需求N

……

2.3.6 报表功能需求

2.3.6.1 报表统一需求

描述需要统一遵守的规则 2.3.6.2 报表1

第16 页 共 19 页

软件需求规格说明书编写指南

一、统计表表样：

指出表样位置（可引用） 二、总体说明

描述该报表的相关规则。 三、统计条件说明：

序号 统计条件 说明 四、报表主栏说明：

序号 主栏 对应新系统代码项 备 注 五、报表宾栏数据项说明：

序号 宾栏数据项 统计项说明 数据要求 备注 2.3.6.3 报表n

……

2.3.7 其它需求1(可选)

以上如不能满足需要需求规格说明书的一些内容，可在此增加。如数据迁移、报表等方面的需求。

2.3.8 其它需求N（可选）

第17 页 共 19 页

软件需求规格说明书编写指南

……

2.3.9 测试用例

在需求调研阶段编写测试用例，一是用来辅助对需求的理解，二是可以作为承建单位内测、建设单位测试的依据，最终目的是提高系统质量。

2.4 其它方面的描述（可选）

根据系统的不同，如果还有对需求的其它方面进行描述的，可在此增加内容。

2.5 附录

附录中可包括但不限于以下信息： a． 输入输出格式样本；

b． 有助于理解需求说明的背景信息； c． 软件所解决问题的描述；

d． 用户历史、背景、经历和操作特点；

2.5.1 输入单据

这里的输入单据指需要导入系统的业务单据 2.5.1.1.1 <单据1>（单据编号）

……

2.5.1.1.2 <单据n>（单据编号）

……

2.5.2 输出单据

这里的输出单据指需要导出或打印的业务单据 2.5.2.1.1 <单据1>（单据编号）

……

2.5.2.1.2 <单据n>（单据编号）

……

2.5.3 报表表样

第18 页 共 19 页

软件需求规格说明书编写指南

这里的报表样式是指对统计结果导出到统计报表模板的报表样式 2.5.3.1.1 <报表1>（报表编号）

……

2.5.3.1.2 <报表n>（单据编号）

……

2.5.4 尚需解决的问题列表

若本文档中还存在需要进一步明确的问题，请在下表中列出。若到需求确认签字后，问题都已明确，可清空该列表内容，并在列表中写上“无”。

序号 问题编号 所属子系统/模块 严重程度 问题描述

第19 页 共 19 页