开发到底喜欢看怎样的需求文档?

一份好的需求文档不仅能提高开发效率,还能避免需求误解导致的返工。 开发喜欢看怎样的需求文档?我总结了以下7点。

-1-

需求文档必备的基本要素

需求迭代、需求优先级、需求产品负责人、需求开发人员、需求背景、需求总体描述、需求功能描述是组成一份文档的基本要素。

如果你们公司使用了需求管理工具,就更好了,比如tapd需求管理工具,以上提到的要素,在这个管理工具上面都会要求你填写,还有状态流转、开发预计开始时间、结束时间、需求保密性管理、需求的评论补充等,已经结束的需求如果以后想重构功能,查看归档文件也很方便。

-2-

分工要明细,避免多人看同一份文档

如果一份需求需要多个开发角色来完成,比如数据分析师、前端、后台。建议把需求拆成1个父单和3个子单,父单有需求的总体描述,子单是对应到不同角色的需求描述。

子单给到不同的开发,开发不仅能快速浏览到需求明细,后续如果产生需求变更或者需求补充时也能实时反馈到对应的需求文档中。

注:如果使用了需求管理工具,父单和子单可分在不同的链接文档中,如果使用的word文档,在文档内写好不同角色的分工模块即可。

-3-

逻辑要清晰,避免口口相传

1)避免一句话需求

举个例子:产品想提一个和已经存在功能的类似功能,比如登录功能。然后把以前的登录界面截个图,再加上一句话:实现和以前登录一样的功能。

在接这个需求时好像没毛病,但是可能做起来全是问题。比如用户体系是否用的同一套?登录态是否要打通?等等。所以逻辑一定要清晰,关注到细节。

2)避免口口相传

有些逻辑产品经理可能一时没有顾及到,开发在让产品补充时,建议产品把补充的逻辑都写在需求文档中,避免口口相传。这样有个记录,在后期如果出现需求没达到预期时,起码有个依据看。

-4-

重点要突出,避免文案臃肿

文案臃肿是需求文档常出现的问题,大概率的原因是没有主次分明,突出重点。所有的细节都写。对于常识性的细节,建议不要写上,建议写核心逻辑、关键分支、关键异常就可以了。

举个例子:需要新增一个搜索下拉选择框。

描述1(bad): 搜索新增一个选择食品的下拉选择框,当选择食品时,把食品名称展示在输入框中,支持单选搜索。

描述2(good): 搜索新增一个选择食品的下拉选择框,支持单选。

这个需求的重点:下拉框选择食品,仅支持单选。

描述1中有常识性的描述(把食品名称展示在输入框中,然后触发搜索),描述2比较简洁。描述1的做法,当需求内容多起来时很容易导致文案臃肿。

-5-

严谨全面,避免遗漏异常

异常包括:

执行者输入异常。比如输入为空、输入非法字符、输入重复单词。

平台业务异常。比如异常分支流程,超时异常

第三方异常。比如第三方调用失败,第三方请求频率被限制

-6-

需求所有地方的描述要保持一致性

一般一份需求会分为这几部分:需求总体说明文档、原形图、设计稿。

1)避免同个功能逻辑分在多处展示。

目前发现比较多的需求模式是,需求文档里面,一个功能模块一张原型截图,然后底部写上具体逻辑。但是发现有的需求文档是这样的:原型图截图里面写着一份逻辑描述,需求文档也写着一份逻辑描述。这2处地方的逻辑描述大同小异。

建议把逻辑统一写在一处地方表示,好处是:一是开发可以不用来回切换看逻辑,二是以后变更需求时只要改一处地方就可以了。

2)避免原型图和设计稿描述不一致。

这是我经常遇到的需求问题,可能产品和设计没有沟通好,或者变更需求没有及时更新,导致原型图和设计稿展示的功能不一致。开发一般会在设计稿出来之前,按照原型图做功能,等待设计稿出来后再继续完善,如果两个地方不一致容易让开发误解。所以在设计稿出来后,建议产品要做好设计走查,保持一致。

-7-

相比于文字,开发更喜欢看图

能用图展示的需求,尽量不要用文字。俗话说:一图胜千言。 举个例子:比如一个填写的表单,描述输入异常

用文字描述(bad):

  • 活动名称为空时:提示请输入活动名称

  • 活动区域为空时:提示请选择活动区域

  • 活动性质为空时:提示请至少选择一个活动性质

用图描述(good):

↘好文推荐:

“百亿补贴”真的能拯救一切吗?

产品经理学PMP,有必要吗?

美团外卖 | 离线数据仓库建设实践

(0)

相关推荐

  • 同样写文档,初阶产品经理找模板,高阶产品经理是这样修炼逻辑的!

    刚走进办公室就听到产品实习生小邱在抱怨:"今天要我写竞品分析,明天要我写PRD.写写写!天天写这么多,浪费时间不说,产出的文档我怀疑根本没人看." 不止是小邱有这个困扰,很多产品经 ...

  • 过于真实!总是陷入加班怪圈的产品新人,都是在无效加班?

    作为一个经常加班的产品新人,小刘常常会感觉工作疲累,既没有成就感,也没有丝毫的能力提升,连轴转的状态很让人颓败. 其实,除非在项目关键期加班能够完推进某个子目标的完成或者帮你理清思路,更好的推进工作. ...

  • 2 种不合格的 PRD

    之前帮几个我星球内的同学看了下他们的 PRD,尽管他们来自不同公司,做的项目也不一样.但是,我在他们的 PRD 中却发现了一些共性问题. 总结起来主要有 2 类,今天在这也跟你们聊聊. 如果你是产品经 ...

  • 开发到底需要一份怎样的需求文档? | 产品壹佰

    开发到底需要一份怎样的需求文档?这个问题我记得我做产品不久后在PMcaff上提过,非常感谢当时解答的朋友,为我在以后的写文档提升了很大的质量和减少了很多不必要的沟通. 今天做为已有丰富经验的产品老司机 ...

  • 你给需求文档,AI就能帮你开发安卓App|安卓|编译器|翻译|应用程序

    用自然语言生成代码不算稀奇,但现在,这项技术涉及的业务范围真是越来越广了. 就有一个叫做Text2App的"AI",你"喂"给它一串文字需求,它就能直接给你&q ...

  • 你给需求文档,AI就能帮你开发安卓App

    编者按:本文来自微信公众号"量子位"(ID:QbitAI),作者:关注前沿科技,36氪经授权发布. 丰色 发自 凹非寺量子位 报道 | 公众号 QbitAI 用自然语言生成代码不算 ...

  • seo需求文档-伪静态的考虑和基本解决方案

    伪静态结果页 后台: 1.需生成url伪静态页面 2.添加关键词.对应URL.新定义的伪静态URL,并生成 3.伪静态页面支持自定义标题.描述.url(url具有唯一性,不可重复) 4.可删除已生成关 ...

  • PRD:抖音APP产品需求文档

    一.前言 1. 编写目的 通过倒推抖音APP,体验产品,培养自己的思维逻辑能力,锻炼自己撰写文档的能力. 2. 产品概述 1)产品的介绍 抖音,是由今日头条孵化的一款音乐创意短视频社交软件,该软件于2 ...

  • 需求文档是出轨,测试用例也是出轨,结果上线变成了结婚,怪技术吗?

    今天的朋友圈被赵丽颖冯绍峰结婚刷屏了 女粉丝闻之哭泣 男粉丝闻之落泪 没想到唐僧真的娶了女儿国的公主 没想到当初宣称8个人出轨也hold住的微博挂了 (视频来源见水印,侵权删) 网友表示纷纷吐槽 作为 ...

  • 一线大厂产品需求文档案例 NO.4 :平安好医生

    / 产品干货 / 产品经理工作必备:七大常用文档写法   110份产品需求文档(PRD)模板     150份超好用的简洁风PPT及简历模板    38个经典产品经理面试题回答思路 校招产品经理:52 ...

  • 一线大厂产品需求文档案例 NO.3 :陌陌

    / 产品干货 / 产品经理工作必备:七大常用文档写法   110份产品需求文档(PRD)模板     150份超好用的简洁风PPT及简历模板    38个经典产品经理面试题回答思路 校招产品经理:52 ...

  • 数据埋点与数据需求文档

    数据分析流程数据采集→指标建模→观测数据→数据分析→业务洞察,数据采集首当其冲,而数据采集中埋点是其中的一个重要方法,移动端的数据采集,一是为了服务于开发者,协助开发者分析各类设备信息:二是为了帮助各 ...