编辑导读：产物需求说明文档（PRD）可以将产物设计思路清晰的揭示给团队人员，便于他们快速领略产物。那么，产物需求说明文档该如何写呢？本文作者团结多年岁情经验，分享了关于产物需求文档形式、类型、自查相关的很是有用的常识，供各人一同参考和进修。

本文总结一个最基本的话题：PRD。

目次：

一、PRD的形式

二、PRD的类型

三、PRD的自查要领

一、PRD的形式 1. 原型附带文字

移动端产物虽然是把产物DEMO展示出来为之一位。

附带的文字，多是对原型的交互的说明、取值逻辑说明等。

好比这样：

文字较多的，可以把原型靠右的部门都分简朴排版。好比这样：

2. 文字附带原型

逻辑过重的后端需求，爽性就利用Word/Excel/TXT名目标PRD。长处是在行文的进程中，可以二次梳理思路，袒露问题。一般这样的需求文档都包罗：

版本说明(含改观日志)、配景、方针、需求范畴、需求用例（正文，包括所有焦点内容，如成果逻辑说明等）、参考资料等。

（1）需求配景

近况当前业务流程怎么了，当前成果是怎么样的，问题是什么，需要怎么办，以到达什么方针。

用户故事也可以更简朴的以“作为谁，但愿通过什么，实现什么”这样的用户故事形式也可以。

场景是需求的外在，拆解和穷尽需求场景，为穷尽成果和逻辑法则打基本。

拆解需求场景的要领：

按业务顺序，想象或模仿用户操纵顺序；

按方针生命周期，好比草稿、待审核、审核中；

按正常、异常、正向、逆向，形成交错矩阵。

（2）需求方针

用户角度的验收尺度，即从结果的角度表达需求的预期（不表达如何实现）。

譬喻：

a、用户在点击页面之后3秒内必需加载完成。

b、用户能看到本身买到的商品。

c、用户可以删除本身的商品购置记录。

（3）需求范畴

需求范畴就是描写需求的方针项、界线、解除项，其浸染是理清界线。

目标是防备需求伸张（参考PMBOK指南）。

需求范畴可以利用成果框架图。

（4）需求用例

需求用例是需求的正文部门。

先将需求分成任务点，举办描写。

描写的语句要严格凭据文档语法原则举办（下文会继承聊到）。

如下图：

（5）参考资料

参考资料部门，附上调研进程中查到的相关模板、数据表、剧本、接口地点、汗青文档、原型链接等。

二、PRD的类型

这里主要以Word样式的PRD为工具。

1. 需求文档的语法

（1）说明文一字千金

需求文档就像是说明书一，去掉形容词、比喻句、副词等。

能用一句话说明的就不要说第二句。

（2）制止用词不妥

在文档或口头交换的时候，常常用到诸如“维度”、“颗粒度”、“参数”、“字段”、“项”、“列”、“表”等词汇。

产物需求文档中，要做到用词严谨，制止词语歧义或失准。

常见用律例如：

以“订单号+产物编码”的[维度]举办独一性判定；凭据“订单”[颗粒度]举办汇总；

以“时间”作为请求[参数]；

数据库的[字段]为“number”；

页面搜索栏的“姓名”搜索[项]；

页面列表的“年数”[列]。

（3）按顺序描写

开拓和测试人员凡是但愿将一个模块的事情做完，再举办下一个，而不是往返跳。

因此行文顺序上，凭据先后、阁下、巨细等通例的顺序举办，一个模块写完再写下一个。

前面写过的内容，后头不要再写了，制止歧义。

好比：要在已有接口增加获取一个字段，并在页面展示，可以这样两步描写：

在xx接口，增加xx字段，存入数据库xx表。接口逻辑调解为xx。旧数据初始化方案是xx。

在xx页面列表中，新增一列“xx”，对应取值是数据库xx表中的字段xx。

（5）以“在那边，做什么”为主线

文档以任务线为焦点句式布局，即：“在那边，做什么”。

只管用正向语序，不要倒叙，也不要用括号或破折号。

好比制止前面描写完，后头又接着一个“即xxxxx”、“也就是说xxxxx”。

（6）非本需求的成果，不要放在文档中

产物司理是信息布道者，信息中枢。

而开拓和测试人员，是但愿所见即所得的阅读 *** 。所以不须要的任务不要插手进来。

好比不要利用“大概这次要做”、“留意，这个本次不做，只作为提前知悉”之类的内容。

正文必然转达的是“做什么”。假如想增补，那么放在参考资料部门。

（7）回收符合的行文布局

1）假如需要在旧成果基本上做优化，可以用比拟布局举办描写，好比：

修改前：xxxx；

修改后：xxxx；

2）对付并列条件较多的，可以用平队罗列的布局描写，好比：

天天一次，按时监控【退款单】(表f_oms_refund)，若同时满意下列条件：

同时满意上述条件，则举办数据抓取。

数据更新时间为前两天；

退款乐成的（refund_status为：2、5、8、12、24任一个）；

rma_sn不为空；

order_sn已存在于【发票列表】中。

留意：假如不熟悉数据库，发起不要写数据库，而是要写清楚页面取值位点并配以截图，制止弄巧成拙。

3）假如需求点有多个，但属于同一个页面成果模块下的，那么可以放在一个用例中，分点描写，就像书本的目次一样举办编号。

（8）穷尽原则

“穷尽”是方案严谨的基本。

穷尽包罗穷尽需求的成果点，穷尽每个成果点的要素，穷尽每一个逻辑判定、机能要求、异常机制、用户权限等。

好比：做一个新页面，就要从导航栏目、界面交互、搜索成果、网站先容性文字、默认列表展示内容、列表数据统计等全部说清。

同时对付后端产物而言，根基上每个需求都要说明机能要求、异常机制等。

（9）最后，不要漏掉对机能的要求、对汗青数据是否处理惩罚、以及权限要求

机能的要求，假如不懂技能术语，则写出机能支持的数据或现象范畴。

好比：估量半年内数据量为100万/天，要求接口响应3s内。

汗青数据是否要初始化，及与发版的时间顺序。

权限就是赋予页面数据、成果权限。

2. 通用项举办统一

（1）定名统一

页面一些常见的插件的定名大概有多个版本，产物司理需一开始就在需求文档中确定用哪一个。

好比下面这几组意思临近的插件名称：

暗示删除或禁用的：删除、禁用、封锁、封存；

暗示启用的：开启、启用、生效；

暗示配置的：设置、配置；

暗示编辑的：编辑时间、修改时间、更新时间、操纵时间。

（2）数据库表中的通用字段定名统一（开拓认真的）

好比：

每个开拓习惯差异，所以要牢靠用哪一种，制止千人千面。

是否已写入：用“is_use”、“is_used”照旧“is_write”暗示？

已写入/未写入：用“1/0”，照旧用“1/2”暗示？

笔者曾经碰着一个开拓比葫芦画瓢，把“goods_sn”（商品编码），写成“good_sn”，这就闹笑话了。

（3）页面展示统一

好比：数据表为空字符串时，前端展示什么，是显示“/”，照旧空缺？

（4）文档定名统一

可以利用日期+模块名+需求名称+作者+版本号，譬喻：20180920_【小我私家资料】编辑小我私家资料优化_张三_V1.0。

（5）术语名词界说统一

好比跨境电商行业的“清关”、“保税”、“头程运费”、“尾程运费”、“大包”、“小包”等。

三、PRD的自查

PRD可形成一套自查法则。笔者抛砖引玉。

1. 按成果插件自查

（1）输入框

需限定输入的范畴，做输入校验。示例：最多输入10个数值，输入不正当则的内容，则在输入框下方赤色字体提示，好比：“请不要输人汉字！”。

（2）下拉框

下拉的同时是否支持输入搜索，是否支持多选。

（3）导入文档

表头校验、自校验、与系统校验、写入逻辑（全部不予导入或部门导入)、下载功效文档；

（4）已有成果的逻辑法则改观

则要思量旧数据兼容或初始化。

（5）基本数据删除

则要思量基本数据被挪用的处所，删除和编辑怎么处理惩罚。

好比：商品分类中维护的“商品范例”被删除，那么再编辑和删除该分类下的汗青数据的时候就大概报错，所以基本数据维护时候要校验挪用环境。

（6）配置法则

思量法则去重、法则优先级。

一般环境下，没有优先级的话，法则的去重和掷中序次校验起来较量贫苦。（在<后端产物司理宝典>一书中有专门先容）。

（7）列表的数据的排序

一般凭据修改时间的倒叙分列，也可以用数据库id取代序号。

用数据库id的长处是，利便用户和技能协作追溯数据。

（8）异常机制

时时刻刻都要有逆向思维，汇报开拓人员什么算异常？异常了怎么标示出来。

好比：表1字段A，匹配表2字段B，将匹配乐成的数据写入表3。就要思量表1中字段A为空的环境该怎么办。

（9）页面恒久不登录

则给自动退出。主要思量到后端系统的保密性。

（10）每每带操纵的

一般都要配置页面权限。

最简朴的 *** 是所有系统的权限都分三个品级：不能查察、只能查察、可以编辑。

（11）成果修订

好比法则改观，需要思量旧数据是否要凭据新法则举办初始化。

2. 按需求范例自查

（1)成果需求

需要穷尽成果包围的利用场景，穷尽本成果相关联的各个系统模块，穷尽本成果的用户脚色、权限。

（2)机能需求

数据量较大时的系统压力、回响速度；

批量上传、下载要思量数量上限，思量是否异步处理惩罚；

思量欣赏器兼容性；思量挪用接口超时的备用计策等。

（3）安详需求

敏感词屏蔽（同步过滤和异步召回）、防刷单机制、数据补推机制、风险预警等。

3. 要害词提醒自查

笔者不完全摆列了几个要害词，可以作为自查的维度。

（1）完整流程是否存在断头路。

（2）逆向成果流程是否可逆，假如逆向操纵，是否思量对应的机制：好比退款、退货操纵。

（3）异常即异常机制。各个步调都大概呈现预期外的环境。

（4）歧义需求文档的语法、成果文案、名词是否易懂，是否存在歧义。