需求规格说明标准规范

XXX 产品需求规格说明书
文档编号
产品名称： 【博金贷 APP】 文件编号：博汇九洲-【博金贷APP】-PRD-V【1.0】 版本号： 【1.0】 归属部门/项目：产品部 创建人：彭绍明 批准人： 密 级： 内部公开???秘密? 机密?绝密? 所属阶段：【正在编撰】 创建日期：【2015.10.10】 批准日期：【2015.10.10】
文档变更
版本号 1.0
修订日期 2015.10.10
修订人 彭绍明
修订摘要 退出账户提示，账户总览可视化 界面，UI 优化
1

目 录 目录
XXX 产品需求规格说明书 ............................................................................................................... 1 文档编号 ................................................................. 1 文档变更 ................................................................. 1 目录..................................................................... 2 1. 引言 ...................................................................................................................................... 3 1.1 编写目的 ............................................................. 3 1.2 参考资料 ............................................................. 3 1.3 术语定义 ............................................................. 4 2. 需求概述............................................................................................................................... 4 2.1 产品描述 ............................................................. 2.2 功能概要 ............................................................. 2.3 用户特征 ............................................................. 2.4 一般约束 ............................................................. 2.5 实现语言 ............................................................. 3. 4 5 6 7 8
功能详细需求....................................................................................................................... 8 3.1XX 功能需求 ............................................................ 9 3.1.1 简要说明.......................................................................................................................... 9 3.1.2 需求分析图...................................................................................................................... 9 3.1.3 各用例说明.................................................................................................................... 13 3.1.4 表单字段........................................................................................................................ 18 3.1.4 领域模型（暂不用） .................................................................................................... 18 3.1.5 UI 界面 .......................................................................................................................... 18
4.
外部接口需求..................................................................................................................... 19 4.1 用户界面 ............................................................ 4.2 硬件接口 ............................................................ 4.3 软件接口 ............................................................ 4.4 通信接口 ............................................................ 19 19 20 20
5.
非功能性需求..................................................................................................................... 20 5.1 性能需求 ............................................................ 20 5.1.1 静态数值需求............................................................................................................... 21 5.1.2 动态数值需求................................................................................................................ 21 5.2 设计约束 ............................................................ 21 5.2.1 硬件限制........................................................................................................................ 21 5.2.2 其他约束........................................................................................................................ 21 5.3 属性 ................................................................ 22
2

5.3.1 可使用性........................................................................................................................ 22 5.3.2 安全性............................................................................................................................ 22 5.3.3 可维护性........................................................................................................................ 22 5.3.4 可移植性........................................................................................................................ 22 5.4 其它需求 ............................................................ 23 5.4.1 数据库............................................................................................................................ 23 5.4.2 操作................................................................................................................................ 23 5.4.3 故障处理........................................................................................................................ 23 6. 数据需求............................................................................................................................. 23 6.1 数据描述 ............................................................ 23 6.2 数据采集 ............................................................ 24 6.2.1 要求与范围.................................................................................................................... 24 6.2.2 处理................................................................................................................................ 24 6.3 数据词典 ............................................................ 24 7. 附录 .................................................................................................................................... 24
1. 引言
1.1 编写目的
说明编写需求规格说明的主要目的。 例：
博金贷 APP V1.0 需求规格说明书，全面细致定义 APP1.0 产品 目标、 功能、 性能、 数据、 故障及交互体验需求， 为产品设计、 开发、 测试、用户交流提供标准依据。 1.2 参考资料
列出下列资料的作者、标题、编号、发表日期和出版单位，必要时说明如 何得到这些资料：
3

a.本项目经核准的计划任务书、合同和上级机关的批文； b. 项目开发计划； c.本文档中引用的文件、资料，其中应包括软件开发规范。
1.3 术语定义
列出本文档中用到的可能会引起混淆的专门术语和缩写词的原文。 例：
名称 有效投资人 年化投资额 解释 指在平台账户有待收余额的投资人。 投资金额*（投资期限/360) * 1%
2. 需求概述
本章描述软件产品的特性及影响其需求的一般因素。 必须注意到：本章不罗列具体的需求，而仅设法使需求更加易于理解。
2.1 产品描述
a. 用一个名字标识要生产的软件产品。例如，宿主数据库管理系统、报表生成
器等；
b. 说明软件产品将干什么，如果需要的话，还要说明这个软件产品不干什
么；
c. 说明此软件产品的应用情况及开发意图，其中应当：尽可能精确地描述
所有相关的利益、目的以及最终目标：如果有较高层次的规格说明存在（例如， 已存在系统需求规格说明） ，则应使这里的陈述与高层次规格说明中的类似陈述 一致；
d. 列出开发项目的委托单位、承办单位及其主管部门；
4

e. 如果被开发软件是独立的，则应在本节描述被开发软件的概况； f. 如果需求规格说明定义的软件是一个较大的系统或项目中的一个组成部
门，那么本节应当：概述这个较大的系统或项目的每一个组成部分的功能，并标 识其接口；标识被开发软件的主要外部接口。注意，这里仅仅是一个综述性的描 述。 用图形表达一个较大的系统或项目的主要组成、 相互联系和外部接口是非常直观 的。 本节不应当具体的进行设计方案的描述， 也不应当描述解决问题时的具体设计约 束。本节应对在需求规格说明具体需求一章中列出的设计约束提出理由。
例： 博金贷 APP V1.0 是一个综合展示投资项目、进行在线投资、 发布和参与在线活动、 查询和管理投资账户、 发布好友邀请的 APP 在线理财应用， PC、 WAP 与 APP 及各个环节之间数据能够共享。 APP 需要开发 Android 手机、ios 手机版本，ipad 版本，交互 体验力求一致，iphone 与 ipad 本力求版本合并，UI 能自适应。 1.0 版本优先推出 android 手机版本。
2.2 功能概要
本节应简单叙述被开发软件的功能。例如，对于一个财务管理系统，需求规格说 明可以在这节描述帐目维护、财务报表等的基本要求，而不必把为完成这些功能 所要求的大量细节描写出来。 有时本节内容可以直接从较高层次的规格说明中引 用（如果存在） 。为了清晰起见，要注意：
a. 应当给出一个使用户、委托单位或者第一次读这个文档的人易理解的功
能清单；
b.可以用图形表达不同的功能和它们之间的关系。但要注意，这样的图形不
是产品设计时需要的，而只是一个有效的解释性工具。 本节不应当陈述具体需求， 而只应对需求规格说明具体需求一章中要描述的需求 给出理由。
5

例如：
博金贷 androidAPP 功能清单：
功能类别/ 系统 子功能/模块 投资项目展示 项目投资 进行投资 查询投资记录 回款 查询回款 登录 注册 修改密码 实名认证 管理账户 银行卡管理 充值 提现 查询交易明细 发布平台公告 信息交互 公告展示 ?? 编号 1.0_001
主要面向投资人对选中的项目进行投资，
功能摘要
1.0_002
能够查询投资合同， 输入金额， 选择卡券， 判断金额有效性，提示投资成功
2.3 用户特征
本节描述影响具体需求的该产品最终用户的特点。 软件生存周期的运行和维护阶段，许多人员与系统有关。这些人员中有用户、操 作员、维护人员和系统工作人员。这些人的某些特点，如教育水平、经验、技术
6

专长等，都对系统运行有重要影响。 如果系统的大多数用户是临时用户，那么他们的具体需求可能是要求系统包 含有许多如何完成基本功能的提示，而不是记忆许多繁琐的细节。 本节不陈述具体需求或针对某些特殊需求而考虑的若干具体设计约束，本 节应对在需求规格说明的具体需求一章中描述的某些具体需求或设计约束提供 理由。
例：净值标项目 根据用户对产品使用权限等级的不同，可将用户角色定义为 以下几类：
角 色 借款人 净值借款管理 员 权限描述 发布借款，查询借款记录，提前还款 设置系统参数（如净值系数， ） ，垫付逾期款项，代理还 款，??
2.4 一般约束
本节给出对一些条款的概括描述，这些条款将影响承办单位在设计阶段的工 作和计划，这些条款包括：
a. 管理方针； b. 硬件的限制； c. 与其他应用的接口； d. 并行操作； e. 实时性能； f. 检查功能； g. 控制功能； h. 信号交换协议； i. 应用的临界点； j. 安全和保密方面的考虑。
7

本节不列举具体的需求或具体的设计约束。但是，应对具体需求一章中描述 的某些具体需求和设计约束提供理由。
例如：与其他应用的接口 APP 应与 WEB，WAP 数据保持实时一致，能够共享，注意 做好相关接口。
2.5 实现语言
本节要列出所采用的编程语言。
Android ：JAVA
…….
3. 功能详细需求
本章包括软件开发者进行设计时所需要的全部细节。通常本章是需求规格说 明中篇幅最长和最重要的部分。
a. 必须按照本标准第 4.4 条描述的标准（可验证的、无歧义的等） ，对
需求规格说明中的每个具体需求给出详细定义；
b. 应当利用引言、概述和附录部分中的有关讨论及交叉引用关系，提供
每个具体需求的背景及注释内容；
c. 具体需求的一种分类方法为： 功能需求， 性能需求， 设计约束， 属性，
外部接口需求，其他需求。 必须注意到：
a. 具体需求应当按逻辑可读的方式组织； b. 每一个具体需求应使用指定的方法进行客观的验证。
8

3.1xx 功能需求
这里用功能清单上的功能/模块名称，有多少个功能模块列多少章节。 本节描述软件产品的输入经过什么处理，产生什么输出，它描述在软件中发 生的基本操作。 对于每一类功能或者有时对于每一个功能，需要描述其输入、处理和输出等 需求。
3.1.1 简要说明
在本节中应当描述完成本功能的目的， 所使用的方法和技术， 还应当包括可以清楚说明本功能意图的来源或背景材料以及有关 需求的注释内容。
3.1.2 需求分析图
用例图/活动图/状态图 /交互图 什么是用例： 在不展现一个系统或子系统内部结构的情况下， 对系统或子系统的某个连贯的功能单元的定义和描述。用例将系 统的功能范围分解成许多小的系统功能陈述。一个用例代表了系 统的一个单一的目标，用例是一个行为上相关的步骤序列。 用例图是指由参与者（Actor） 、用例（Use Case）以及它们之 间的关系构成的用于描述系统功能的静态视图。
例如： 借款人还款模块
9

1）用例图/流程图
平台虚拟人
到期还款
提前还款
<>
<>
投资人回款 投资人
借款人
逾期还款
<> <>
垫付
平台运营人员
用例图说明： 借款人：可手动提前还款，逾期还款。 平台虚拟人：平台自动对到期项目进行还款，还款资金来源 于借款人账户余额。
2）活动图
类似流程图，在强调业务操作流程的功能模块使用。
10

借款人
平台虚拟人
平台运营人员
投资人
判断当前日期与还款日差距
提前还款
当前日期=还款日期 当前日期<还款日期
到期还款 回款
当期日期-还款日=10天
当前日期-还款日<10天
平台垫付
逾期还款
还款活动图说明： 提前还款：如果当前日期早于项目计划还款日期，且借款人 选择了提前还款，则启动提前还款程序。 到期还款： 如果当前日期=项目计划还款日期， 则不用借款人 手动还款，平台（虚拟人）自动从借款人账户余额还款。 ?? 3）状态图
状态图，在状态比较多的功能模块使用。
还款模块分 7 种状态，状态转移条件如下图：
11

未到还款日
未到还款日提前全额一次性还款 提前已还款
正常还款中 还款日尚未还款
到还款日准时还款
到期已还款
逾期中
今天距还款日10天以内还清
逾期垫付前还款
今天距还款日10天由平台垫付 垫付后，借款人还清平台欠款 平台已垫付 垫付后已还平台款
4）序列图
序列图显示不同的业务对象如何交互，对于交流当前业务如何进行很有 用。除记录组织的当前事件外，一个业务级的序列图能被当作一个需求文件 使用，为实现一个未来系统传递需求。在项目的需求阶段，分析师能通过提 供一个更加正式层次的表达，把用例带入下一层次。那种情况下，用例常常 被细化为一个或者更多的序列图。
逾期且提前还款的顺序图
借款人 还款界面 : payView 项目本金表 利息表 罚息表
1 : 选择提前还款() 2 : 提取该项目剩余本金() 3 : 返回本金() 4 : 计算未还利息()
5 : 返回待还利息() 6 : 计算罚息() 7 : 返回待还罚息()
8 : 计算总待还金额()
9 : 提前还款()
12

3.1.3 各用例说明
用例 1：逾期还款
用例名称 用例标识 创建人 创建日期 版本 用例类型 例如：逾期还款 1.0_002_01
1.0 业务操作类：重点是操作流程和交互 信息展示类：重点是展示信息； 子用例： 扩展用例：
用例描述 优先级 执行者/参与 者
例： 主要是还款状态的判断，还款的计算与操作。 无 用例图中该用例的参与者，通常是业务操作的触发者和施与对象 （如外部系统） 。 如：区总管理系统的执行者是经系统登记注册的区总账户，或系 统管理员
谁干了什么，触发了这个用例。
触发条件 如： 用户在单个项目投资页面单击了“确认投资”按钮 在触发该用例相关操作前必须达到的条件。比如: 进入区总管理界面，必须先获得区总的权限。
前置条件
本栏应包括：
a. 对本功能全部输入数据的详细描述，它们包括：输入源，数量， 输入
度量单位，时间关系，有效输入的范围，精度和公差；
b. 操作员具体的控制要求，其中包括操作员活动的描述，控制台
或操作员的位置等。例如，在打印表格时，要求操作员调整打印
13

纸位置的需求；
c. 指明引用的接口规格说明或相应的接口控制文档。
例如：立即投资的输入信息包括：投资金额，卡券
本节陈述为获得期望的输出，而对输入数据和中间参数进行的全 部操作。它可包括如下内容：
a. 输入数据的有效性检查； b. 操作的精确顺序，包括事件的时间设定； c. 非正常情况的处理，例如对溢出、通信故障、错误处理的
响应；
d. 操作对参数的影响； e. 降级运行的需求； f. 把系统输入变换为相应输出的方法（如方程式、数学算法
和逻辑操作） 。例如可以列出：在工资管理软件包中关于房租计算 的公式，求解微分方程的算法，天气预报软件包使用的气象学模 型；
g.输出数据的有效性检查。 需求描述/ 操作序列/事 件流
这是用例说明中最重要的部分，它详细描述了该用例可能出现的 所有流程。 基本流程：另一个名称更能表达它的意义：最佳流程（ The Best Flow） 。它描述的是该用例以最佳的、最正常的方式流转， 没有出现任何异常，并且最终成功完成操作的流程。基本 流程在编写时，应当通过数字对流程中的每一步进行编号。 扩展流程：或者叫“分支流程”，它描述的是基本流程在流转过程中 可能出现的所有分支。扩展流程最大的特点就是，它应当 是在基本流程的某一步骤发生的分支，因此它的编号规则 是“基本流程号+序号”。基本流程号就是发生分支的那一个 基本流程的编号。在同一个基本流程上发生多个分支时， 它们的序号从 1 依次开始编号。另一种情况是，某个扩展 流程本身拥有多个步骤，这时应当在“基本流程号+自身序 号”的基础上再添加序号，如“2.1.1”。扩展流程在描述时， 应当首先描述进入这个分支的条件，即“如果× × 则××”、“当 × × 时××”。
14

异常流程：就是发生异常情况时的处理流程。注意，用例说明是 站在用例角度进行的说明，因此这里并不是我们通常一样的 发生程序异常的处理流程，而是用户在处理业务操作时发生 的异常情况，如：如果顾客不能提供身份证，则??????
例如：订货流程 S1：进入订货合同信息的界面，默认订货合同的录入界面，选择 以下操作(<增加>、<删除>、<修改>、<查询>、<打印>)； S2：选择<增加>转入 S2.1；选择<删除>转入 S2.2；选择<修改>转 入 S2.3；选择<查询>转入 S2.4；选择<打印>转入对当前记录 进行打印并返回 S1； （打印的表单见附录：表单 2） <增加>操作： S2.1： 选择<增加>后系统进入订货合同信息的录入界面， 首先录入 合同编码、合同名称后，进行<选择 1>操作，在弹出窗口选择 供应商名称双击后信息接收到增加界面。录入信息后，选择 以下操作<提交>、<重置>、S2.1.1：选择<提交>后系统进行录 入 / 修改信息的约束判断，如果违反约束的提示信息，返回 S2.1， 否则进行保存当前记录并把当前记录置为只读状态对该 记录进行增加、删除、修改、查询操作； S2.1.2：选择<重置>后，清空信息。 <删除>操作：……
这一栏应包括： 该功能所有输出数据的详尽描述，包括：
a．输出的目的地； b．数量； c．度量单位； d．时间关系； 输出 e．有效输出的范围，包括精度和公差； f．非法值的处理； g．错误信息。
有关接口说明或接口控制文档的参考资料。对于非标准输出设备 此部分内容尤其重要。
后置条件
又称为“成功保证”， 就是执行基本流程获得成功以后所达到的状态 （条件） 。后置条件往往体现的是执行该用例的最终目的。如：完 成用户投资金额的填写并提交。数据记录提交成功或失败的处理。
15

就是隐藏于业务功能中的各项规则与条件，如各种逻辑条件、计 算公式、环境限制等等。 例如： 假设与约束 输入的投资金额必须大于最低投资金额，小于个人剩余投资金额 账户余额须大于输入的投资金额 简称为“URPS+”，即可用性（Usability） 、可靠性（Reliability） 、性 能（Performance） 、可支持性（Supportability）以及其它（+） 。 要求界面美观、简捷。 1、供应商信息来源于《供应商信息表》 2、产品信息来源于《供方产品信息表》 1、该表单需要部门经理审核、主管付经理审批。
非功能需求
补充说明
需求变更列表
创建人 版本 描述 创建日期
1.0_1.0
用例 2： ??
标准模块模板 收件地址模块
16

用例说明：
所在地区的选项卡模型
包含世界区域、省份、城市、县区、街道。 地址输入规范：
收件人地址：建议您如实填写详细地址，例如街道名称，门牌号码，楼层和房间号等信息。 收件人/单位地址示例：江西省南昌市新建县丽景路 XXX 号 XXXX 楼 XXX 室
单位名称示例：例如：中国建设银行 XX 省分行 XX 市 XXX 支行
17

3.1.4 表单字段
3.1.4 领域模型（暂不用）
（即概念类模型）为用例绘制领域模型，并编写领域模型说明，对每个实体进行 说明。对实体的说明包括对实体的定义、属性说明、行为说明、实体关系说明等 等。如果实体间关系复杂，还要使用对象图说明实体关系的所有情况。
3.1.5UI 界面
给出本功能模块界面图及辅助文字说明。
UI 要素描述要包括： 布局 字体 大小 颜色 行距 对齐 图形大小，形状，颜色 动画效果演示
（其他功能单元继续按上述要求撰写）
18

4. 外部接口需求
4.1 用户界面
本节应当描述： a.用户使用软件产品时的界面需求。例如，如果系统的用户通过显示统筹终端操 作，就必须指定如下需求：对屏幕格式的要求，报表或菜单的页面显示格式和内 容，有关输入和输出的时间，用户命令的形式； b.界面的优化问题。可以简单的用一个表列出系统用户做什么或不做什么。 例如，要求的是长的还是短的出错信息。与其他需求一样，这种需求也应该是可 验证的。
需求名称 界面友好 详细要求 要求能方便的输入、输出数据，减少非法数据的输入，有固定 分类的地方采用选择方式，替手工录入，减少出错率。 能够明确的标明操作的界面，多处使用文字提示，以方便非计 算机人员的使用。级联菜单不能太多 要求界面风格统一、美观大方，不要使用特别夸张的色彩。 统一为蓝色风格。
操作简单
界面风格
4.2 硬件接口
本节应当陈述软件产品与系统硬件设备之间每一个接口的逻辑特点。 还可能包括 如下事宜：要支持什么样的设备，如何支持这些设备。
APP 需要支持的设备：4.0,4.7,5.5 寸的手机，mini ipad。
19

4.3 软件接口
在这里应当陈述其它有关软件 （如数据库管理系统、 操作系统、 或者数学软件包） 的使用方法，以及同其它相连接软件的接口。 对每一有关的软件产品，必须提供如下内容： a.名字； b.助忆符； c.版本号； d.源程序。 对于每个与其它软件接口，本部分应： a.描述与本软件产品相联接的软件的基本功能，以及达到的目的； b.描述传递信息的内容和格式定义接口。对已有完整文档的接口，只需要引用描 述该接口的文档。
应用需要支持的操作系统： android 3.0 以上版本； iphone ipad
4.4 通信接口
本节应说明各种通信接口。例如，局部网络协议等。
5. 非功能性需求
5.1 性能需求
本节应从整体上说明该软件、 人与该软件相互作用的静态或动态数值需求。
20