4.5 输出需求文档
在需求分析和评估之后,输出《产品需求规格说明书》。《用户需求说明书》是站在用户角度,提出用户需要的功能或者任务的说明书,用户需求是用户的目标,即用户要求产品完成的任务以及对产品的未来期望。《产品需求规格说明书》是需求分析师对《用户需求说明书》的详细分析和细化,将用户需求转换为产品需求的文档。
《产品需求规格说明书》主要包括变更记录、引言、项目/产品概述(产品简介、用户和角色说明、功能总体设计、核心业务流程和用例图等)、功能性需求、非功能性需求、验收标准(项目一般有该章节,产品一般没有)、运行环境规定和附录等内容。
1.变更记录
要求每一个文档都必须存在,方便以后的变更查询。每次变更,都需要详细记录变更内容、变更人、文档版本号、变更日期和批准人等信息。
2.引言
(1)目的
目的也就是这份文档所要解决的问题或者要达到怎样的目标。
(2)适用范围
说明该文档的使用范围,适用于产品周期的哪个阶段,适用于产品周期内哪些参与人员。
(3)预期读者和阅读建议
本文档的读者对象有哪些,哪些人需要重点阅读本文档,哪些人可选择性地阅读本文档。
(4)参考文档
需要列出本文档的所有参考文件。
如果包含了参考文献,需要按照下面格式编写:
[标识符]作者,文献名称,出版单位(或归属单位),日期
(5)术语与缩写解释
用于清楚地描述术语或者缩写的意思,如表4-1所示。
表4-1 术语与缩略语解释示例表
(6)需求描述约定
用于说明本文档描述需求的约定,这些约定主要包括需求标识方法、需求跟踪的颗粒度和需求优先级定义。
1)需求标识方法:“需求编号”的格式为:X-YYY-ZZZ,其中X表示子系统,YYY表示3位主功能模块码,ZZZ表示3位子功能模块码。
需求层次:分3个层次,第一层指主功能模块,第二层指功能模块的子功能,第三层指子功能下的具体需求。
2)需求跟踪的颗粒度:跟踪到第二层功能需求。
3)需求优先级定义。
本文档统一规定对需求层次为二级以上的定义优先级,三层需求依据二层需求的优先级执行。
需求分析师应确定每个需求的优先级并写入软件需求分析说明书,需求的优先级的评价标准如表4-2所示。
表4-2 需求优先级评价标准
3.项目(产品)概述
(1)简介
说明项目(产品)是什么,用来做什么。
(2)用户与角色
通过分析用户的最后结果,说明产品的用户角色有哪些,如表4-3所示。
表4-3 术语与缩略语解释示例表
(3)功能总体设计
1)功能架构图:产品的功能架构图由分功能或功能单元按照逻辑关系连成的结构图。
2)功能列表:用表格形式细分功能,如表4-4所示。
表4-4 功能示例表
(4)核心业务流程
该部分展示产品核心业务流程图,按优先级排列,如业务流程图1,业务流程图2,业务流程图3等。
(5)核心用例图
该部分展示产品的用例图,按优先级排列,如用例图1,用例图2,用例图3等。
4.功能性需求
功能性需求需要叙述清楚功能的业务概述、使用者、输入要素、处理流程和输出要素。以表4-4中的“账本分类管理”功能为例。
(1)业务概述
账户分类管理是对用户账户分类的管理,用于可添加多个类型的账户。包括添加分类、删除分类和编辑分类功能,分类信息包括账本分类信息。
(2)使用者
所有用户。
(3)输入要素
1)添加分类:分类名。
2)编辑分类:分类名。
(4)处理流程
1)添加分类:用户进入账户分类界面,点击右上角“+”图标,弹出添加账户分类弹窗;输入分类名,点击“确认”按钮,如果添加成功,以toast(属于一种轻量级的反馈,常常以小弹框的形式出现,一般出现1到2秒会自动消失,可以出现在屏幕任意位置)提示“添加成功”;如果失败,提示“添加失败”。
2)编辑分类:用户进入账户分类界面,左滑显示“编辑”和“删除”按钮,用户点击“编辑”按钮,弹出编辑账户分类弹窗;输入分类名,点击“确认”按钮,如果修改成功,以toast提示“修改成功”;如果失败,提示“修改失败”。
3)删除分类:用户进入账户分类界面,左滑显示“编辑”和“删除”按钮,用户点击“删除”按钮,弹出确认删除弹窗;点击“确认”按钮,完成删除;点击“取消”按钮,取消删除。如果删除成功,以toast提示“删除成功”;如果失败,提示“删除失败”。
注意:如果账本名下存在账户,不能删除。需要给出提示“该账本名下存在账户,不能删除”。
(5)输出要素
1)列表显示账户分类名,并且显示存在账本数。
2)添加、编辑和删除,提示相应操作结果。
5.非功能性需求
(1)界面需求
界面需求的描述,可包括风格、布局、色调、图片、控件和提示等方面的需求。
(2)质量要求
记录产品质量的需求,一般包括性能、易用性、安全性、可靠性、稳定性、扩展性、兼容性和可移植性等方面的需求,如表4-5所示。
表4-5 产品质量需求示例表
(3)接口需求
一般接口需求包括内部接口和外部接口。
6.验收标准
项目一般有该章节,产品一般没有。
7.运行环境规定
硬件环境规定如表4-6所示。
表4-6 硬件环境规定表
软件环境规定如表4-7所示。
表4-7 软件环境规定表
8.附件
附件需要说明用户需求用到的文件,例如产品规划书等。
9.附录
可附上需求访谈记录表和调研报告等。