技术文档

好的产品需求文档拥有6个共性

作者:admin   来源:未知

  “不专业的产物司理,你连ta需求文档都读不下去”,这是近期很有共识的一句话,产物需求文档算得上是产物司理的半个大脑,由于产物需求文档是前期统统作事的结果,那一份可读性高的需求文档究竟有哪些共性?

  起首先领悟咱们大脑是若何明确文字或一段话的,咱们碰到事变必要去明确时就会将获得的新闻往已知的模子上靠,一朝要是咱们大脑有相同模子,明确起来就很容易。要是沒找到相同的模子,明确就很艰难。

  为什么提到Toast大多了解是提示对话框,由于Toast曾经被多次教训大脑曾经“界说”好了,大脑能直接解析并获取新闻。但要是需求文档中时时呈现的或者目生的词,就可能正在文档发端界说真切,云云一来就能让阅读者分明知道,这个常呈现或者目生的词究竟是什么旨趣。有点相同于纸质书内里的注解,避免明确差错,告终共鸣。

  网上时时会有人问,拓荒嗜好看何如的需求文档,用户拓荒谙习的讲话来写,即少少逻辑描摹和拓荒日常常接触描摹相似,如发端所提到,往拓荒已知的新闻模子上靠,比方一个列表的排序规矩,咱们念描摹韶华越近排正在越前的功夫,平淡会这么写“XXX按动态更新韶华从大到幼排序”,最好的应当这么描摹是“按更新韶华倒序”,“倒序/升序/降序”应当曾经存正在每个拓荒职员的已知新闻模子中,明确起来更容易。

  除了排序表比力常见的尚有韶华单元,可能用yyyy-MM-dd hh:MM:ss即年月日时分秒来取代,比拟文字描摹研发对字母代码更谙习。

  要是一个页面需求比力杂乱且是纯文字描摹性的文字,一大坨一大坨堆正在沿途别说拓荒职员,就算是你接办了去职同事的文档,信任你也看不不下去,能用图来描摹的境况下就不要用文字,图+文字搭配可读性会更高,一图胜千言,由于现实拓荒时,拓荒必要切磋后续逻辑变动,要是惟有纯描摹性的文字,拓荒可以还得猜后续逻辑变动,但要是有流程图/泳道图搭配文字描摹,那结果就统统不相通了。

  要是一个需求涉及“一对多”或者“多对多”的功夫,比方按照“差别用户品级赐与差别的案牍提示”,用表格把“品级和对应提示案牍”装起来,真的会有字斟句酌的成绩。咱们得谢谢有“表格”这种东西存正在,由于要是没有表格,咱们可以得多喝5L水和拓荒面临面疏导,估量后续还得正在微信上敲5000个字。

  公式是最常见的逻辑管理之一,涉及到少少加减乘除的策动逻辑,尽可以公式化来描摹需求,云云能简化拓荒的明确和思量。比方咱们正在描摹积分变动境况时,平淡嗜好用纯描摹性的文字来写文档,“点击签到按钮用户积分加1,点击抽奖按钮用户积分-20”。

  然而记得不要“得陇望蜀”,要是感触我方必定拓荒根源,还念进一步进步拓荒职员阅读功效,是不是可能写成“伪代码”直接给拓荒照猫画虎。一面不倡议这么做,由于差别拓荒讲话写法都不相通,你明确的讲话正在拓荒角度可以阻挠易明确,我以前就犯过一个舛错,web端的弹窗alert,正在Android端得用AlertDialog安卓拓荒才容易明确,否则还得明确你这个alert才略转化我方的思绪,而且需求文档阅读职员内里还蕴涵了测试职员,就算拓荒明确了,测试不必定会明确。

  少少能被复用的产物模块,尽可以坚持同样的写法,要是描摹的画风不相通,拓荒有可以给你做出不相通的东西,当然上面所提到的实质,均筑树正在逻辑没有硬伤的条件下。

  可能去看一下局限框架安定台的拓荒文档,比方web端常见的Ant Design,Element,要是产物形式是幼法式可能去看微信幼法式拓荒文档等等, 云云也许领悟框架/平台的更新日记,这种新闻领悟的越多,对技巧明确越深刻,云云不管是写文档仍然和拓荒疏导城市有很大帮帮,同时这也是洞察力的一种显露。由于局限新本领更欲望是你来提示拓荒,云云拓荒更有踊跃性来反映,而不是平台更新了某个效用你绝不知情,反过来拓荒来提示你,就显得尽头被动。

  时时会有少少读者加微信后会问“园长,你有PRD模板吗”,模板只是面上的东西,对付新人来说,模板只可给我方供应一个思绪,而不是完全套用,终究适合我方的才是最好的,于是最好的模板实质模块应当是内部多次实操后总结出来的。

  动物园园长,微信群多号:首席吹法螺官,一面网站:,人人都是产物司理专栏作者。互联网圈十八线作词人,国度一级退堂饱献技艺术家。颜良而文丑,迎接互换。

  人人都是产物司理(是以产物司理、运营为中枢的进修、互换、分享平台,集媒体、培训、社群为一体,全方位供职产物人和运营人,建立9年举办正在线+期,线+场,产物司理大会、运营大会20+场,笼盖北上广深杭成都等15个都邑,熟行业有较高的影响力和着名度。平台凑集了稠密BAT美团京东滴滴360幼米网易等着名互联网公司产物总监和运营总监,他们正在这里与你沿途生长。

技术文档

联系我们

CONTACT US

联系人:张先生

手机:13988889999

电话:020-66889888

邮箱:admin@baidu.com

地址:广东省广州市番禺经济开发区58号