如何写一份程序员爱看的需求文档?

最近这段时间被产品经理折磨得要死,产品就给了一张UI图就让我开发功能,UI图的数据是随便写的,数据来源什么的都不说明,然后就一直对需求,他自己也不清楚,然后又去问需求方那边,而且一问,让我稍等一会就等了一两天,我整个人都不好了,所以去网上找了一篇关于产品经理的,发现里面写得很不错,所以就记录下来了,原文链接:http://www.woshipm.com/pmd/778068.html

产品经理的生涯中,肯定遇到过如下的痛点吧:

1.含辛茹苦地写完了需求文档(PRD),开发人员却将文档束之高阁(一万只草泥马在你的后脑勺奔腾而过……);

2.开发人员反复来回地确认需求、细节逻辑等,问的你一脸懵逼,只能默默地去修改文档;

3.开发完成,进入测试阶段,想着一锅香喷喷的米饭就要上桌了,打开一看,居然是热腾腾的一锅粥~;

以上问题之所以会发生,主要的罪魁祸首当然是你的需求文档:

1.文档不简洁明了,读起来吃力,给到开发,犹如给他们吃了安眠药,开发当然不爱看。

2.文档的功能需求描述不清晰、逻辑不严谨,开发需要反复确认、浪费了大量时间,最后让开发对你越来越不信任(产品狗,你过来,我保证不打死你……)。

3.没有很好的把控进度,项目跟不紧,中途容易出问题,产品难以达到预期。

那么,如何写一份用户体验好、开发喜欢看、靠谱的需求文档呢?笔者将从以下几个方面展开阐述:

image

一、产品简介

1.简要说明产品的使用价值

  • 我是谁(一两句话写清楚产品的身份)?
  • 我有什么用(我是做什么的,我能提供什么服务等)?
  • 为什么选择我们(与竞争对手相比,我们产品的优势,核心竞争力是什么)?

2.目标用户、使用场景

  • 产品的主要用户群是谁?
  • 用户主要在什么场景下使用我们的产品。

二、行业概要

  • 简要阐述行业现状
  • 未来的发展趋势
  • 竞争对手情况分析

补充:如何快速了解一个行业?

1.通过艾瑞咨询、易观等网站查看行业的分析报告,深入了解整个产业的上下游结构;

2.通过商业模式画布工具,分析行业主要玩家的商业模式

三、版本

按照版本来分类,点击版本链接可进入查看每个版本的文档。

文档的第一页如下图:

image

(一)、排期

每次的大版本开发,最好对应有一个排期表(与开发沟通确认时间的安排),开发过程中,根据进度情况,适当调整时间安排。

image

开发人员可以根据自己负责的模块,进入排期详情查看当天的任务,完成的模块可以进行标记,如图。

image

(二)、产品设计(重点)

1.实体关系图

当你做的产品是从0到1时,为了让数据库的开发人员更快速的了解你的产品,实体关系图(E-R图)将会发挥很大作用,数据库的开发人员可以参考此图来做数据表结构的设计(具体这里就不说了,大家可以网上详细了解E-R图)。

image

厂家、经销商、客户等这些都是属于实体,实体包含的的属性(字段)最好也要写出来,如下图举例:

image

2.用户角色权限表

涉及到角色和权限的,需要做一份全面的角色权限表格,方便开发人员参考。››

image

3.业务流程图

通过业务流程图,可以在大方向上知道产品的整体逻辑,业务流程图拆解可以得到任务流程图,任务流程图拆解可以得到页面流程图。

image

4.全局说明

一些通用的控件、状态等,不需要每次都说明,比如空数据、网络异常、加载失败、刷新状态等等,只需说明一次即可。

5.需求、功能、交互说明

很多人在写功能说明、交互说明时,总是会遗漏一些细节,逻辑不严谨。从以下几个维度去说明,将会让你考虑的更加全面:

  • 字段、字段说明、数据来源
  • 前置条件、排序机制、刷新机制
  • 状态流转(一个页面可能有多个状态,需要说明)
  • 交互操作(正常操作、异常操作)

下面,笔者将以一个页面做举例说明:

image

产品设计模块里的结构如图:

(为了方面查看以及和视觉页面的对照,每个页面需要标注编号)

image

(三)、非功能需求

1.埋点需求

页面的打开率、按钮点击率等,如果需要记录,则需要做说明。

image

埋点是数据分析的基础,建议使用“GrowingIO” 这个工具进行可视化埋点,操作简单、方便,能减少很多的工作量。

2.性能需求

请求数据的响应时间要求、并发数要求等。

3.兼容性需求

系统版本的支持、多终端的支持、浏览器的支持等。

(四)、修改记录

image

文档的第二页如下图:

image

为了让开发人员更方便的浏览,增强阅读体验,使用markdown语言来辅助写需求文档是最好不过了,浏览体验会大大提升。

好了,本次分享到这里,感谢您的阅读。

作者:dreamer,微信公众号:拳头产品

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345