本文将分享一般的需求说明书该如何撰写,有哪些格式,需要注意什么等方面,力求使需求说明书看起来规范、专业。

一、文档结构

如何撰写需求规格说明书?-风君雪科技博客

1. 首页

先说需求说明书的首页,首页展示本公司的基本信息、需求说明书的标题,如XX产品需求规格说明书,和文档编号、编写人、模块名称、部门、保密等级、日期、版权说明等。

如何撰写需求规格说明书?-风君雪科技博客

2. 修订页

修订页的作用是记录需求说明书版本的变更,在跟客户沟通需求的时候,需求可能会变更,每一次修订,都需记录下来,作为留痕。

修订页展示的内容包括编号、章节名称、修订内容简述、修订日期、修订前版本号、修订后版本号、修订人、批准人。

如何撰写需求规格说明书?-风君雪科技博客

3. 目录

目录即是需求说明书正文的内容,包含了引言、项目概述、业务需求、附录。

如何撰写需求规格说明书?-风君雪科技博客

(1)引言:展示编写目的、范围、定义和参考资料。

编写目的:说明编写这份软件需求说明书的目的,指出预期的读者范围。
范围:待开发的软件系统的名称;说明软件将干什么,如果需要的话,还要说明软件产品不干什么;描述所说明的软件的应用,尽可能精确地描述所有相关的利益、目的、以及最终目标。
定义:列出本文件中用到的专门术语的定义和缩写词的原词组。

2)项目描述:如果是项目需求,简要描述一下项目的概况,如项目的背景,项目的周期等等。

产品描述:叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。如果开发的系统与其他系统有对接,则还应该本系统与其他系统之间的关系,用方框图表示。
产品功能:系统包含的模块,并简要描述下各模块的功能。描述产品功能模块的作用是将系统的范围定义清楚,一共有多少个模块,以便甲乙两方明确本次项目的边界。

(3)业务需求:用户提出的需求

功能介绍:描述功能要达到的目标、所彩的方法和技术,还应清楚说明功能意图的由来和背景。
流程图:如果涉及到流程,除了文字以外,还需附上流程图
数据项描述:展示字段、字段类型(文本、日期、数值、枚举值等)、数据来源、备注,开发看到数据项描述能定义数据库表中的字段。
界面展示:原型图输出,用原型图方式呈现文字描述的功能,每张原型图下面可以备注功能的路径,以便开发明白该原型图在哪个模块的哪个菜单。

(4)附录:对一个实际的需求规格说明来说,若有必要应该编写附录。

附录包括有助于理解需求说明的背景信息、用户历史、背景、经历和操作特点、原始需求、需求调研记录等等。需要注意的是当包括附录时,需求说明必须明确地说明附录只作为参考,不作为正式的需求。

因为有时候一些原始需求,在需求沟通过程或者其他原因,可能会不做,原始的需求和正式要开发的需求不一定是相同的,所以要用文字说明附录不作为正式开发的需求,也不作为验收的标准。

最后,如果需求说明书需要用户签名,还需在后面写上用户公司名称、日期,以及本公司名称和日期。

以上是文档结构部分,为了使一份需求说明书看起来专业,还需注意细节部分。

二、文档细节

页眉页脚: 页眉注明是XX公司的需求说明书;页脚要编写页码,如第几页,但是首页不要页眉页脚。
字体字号:正文的字体建议用宋体,字号用5号。需求说明书不要出现3种字体。
行距:1.5倍行距

需求说明书可以向开发和用户展现需求分析师的实力,专业的需求说明书能体现需求分析师的专业水平,可以说需求说明书是需求分析师的一件“外衣”,专业的需求分析师写出的需求不仅是用户开发能看懂,而且整篇文档的结构完整,细节也相当注意。

软件需求说明书的一个例子:

https://blog.csdn.net/bingocoder/article/details/89160757