寫PRD并不是產(chǎn)品經(jīng)理的全部工作蹋凝,但卻是不可少的一部分脐瑰,一份可讀性的PRD對(duì)一個(gè)項(xiàng)目團(tuán)隊(duì)來說是至關(guān)重要的。
突發(fā)事件
昨天編輯了一篇純邏輯修改的文檔魄衅,交付開發(fā)后峭竣,開發(fā)方向偏離,后臺(tái)大量訂單數(shù)據(jù)出錯(cuò)出錯(cuò)晃虫。
我立馬叫停開發(fā)人員皆撩,交流之后,發(fā)現(xiàn)開發(fā)人員錯(cuò)誤理解了PRD文檔哲银。開發(fā)人員在閱讀文檔的時(shí)候直接看掉了兩個(gè)字毅访。
后來我自己回去閱讀的時(shí)候也看錯(cuò)了沮榜,說明我文檔是不易讀盘榨。所以一方面叫開發(fā)人員停下來修復(fù)數(shù)據(jù)出錯(cuò)的地方喻粹,一方面重新整理文檔。
下面我就介紹一下我在梳理文檔過程中發(fā)現(xiàn)的幾個(gè)坑草巡。
第一坑——名詞交流混亂
這是昨天文檔中最大的問題守呜,因?yàn)楹笈_(tái)是管理訂單的,所以會(huì)有大量的時(shí)間結(jié)點(diǎn)山憨,但是目前只有兩個(gè)時(shí)間結(jié)點(diǎn)有自己的專屬名字查乒。其他的時(shí)間結(jié)點(diǎn)的叫法都是今天一個(gè)樣,明天一個(gè)樣郁竟。
所以我在寫文檔的時(shí)候就按照自己的叫發(fā)來寫文檔玛迄,其中就有一系列相似名稱的時(shí)間結(jié)點(diǎn)叫做“服務(wù)時(shí)間”、“次服務(wù)時(shí)間”棚亩、“官方服務(wù)時(shí)間”蓖议,技術(shù)同學(xué)在開發(fā)的時(shí)候,直接把“官方服務(wù)時(shí)間”的“官方”二字看掉了讥蟆。
看錯(cuò)后就直接對(duì)“服務(wù)時(shí)間”的先關(guān)內(nèi)容進(jìn)行大刀闊斧的修改勒虾,所以就導(dǎo)致后臺(tái)訂單數(shù)據(jù)錯(cuò)亂。于是乎經(jīng)過交流瘸彤,終于重新定名“服務(wù)時(shí)間”修然、“訂單時(shí)間”、“官方時(shí)間”质况。
關(guān)鍵詞命名的注意點(diǎn):
- 整個(gè)團(tuán)隊(duì)要將關(guān)鍵詞進(jìn)行統(tǒng)一愕宋,最好創(chuàng)建規(guī)范性名詞解釋列表;
- 關(guān)鍵詞命名時(shí)结榄,同一個(gè)模塊中贝、流程中的詞語里邊相同字的使用不要超過50%;
- 還有產(chǎn)品設(shè)計(jì)各個(gè)環(huán)節(jié)中潭陪,關(guān)鍵詞的一致性雄妥,也是需要注意的。
第二坑——專業(yè)名稱重復(fù)出現(xiàn)
昨天在寫文檔的時(shí)候依溯,為了使每一個(gè)名詞都能精確的定位到每個(gè)點(diǎn)上老厌,所以每一個(gè)名詞都使用專業(yè)名稱來表示,全篇PRD專業(yè)名稱橫飛黎炉。由于昨天寫的文檔是屬于純邏輯性的文檔枝秤,所以大量在專業(yè)名稱充斥的情況下,整篇文章的可讀性極差慷嗜。
專業(yè)名稱使用注意:
- 同一句話中淀弹,能使用代詞來代指句子中的專業(yè)名稱的時(shí)候丹壕,盡量使用代詞表示,因?yàn)榇~更口語化薇溃,也更容易讓人理解菌赖。
- 如果使用代詞會(huì)讓整句話產(chǎn)生歧義,那就一定不要使用代詞沐序;
- 使用代詞可以增加可讀性琉用,使用專業(yè)名稱可以增加準(zhǔn)確性,所以只有在恰到好處的地方進(jìn)行敲到好處的表達(dá)策幼,才能把文檔的易讀性和準(zhǔn)確性最大化邑时。
第三坑——行文邏輯不清晰
在寫開發(fā)文檔的時(shí)候,憑著直覺來寫文檔特姐,在寫之前并沒有梳理清楚其中的邏輯晶丘,以至于最后寫出來地文檔邏輯混亂,各個(gè)板塊互相穿插唐含。
在撰寫文檔前浅浮,首先自己要清楚整個(gè)功能的流程,這個(gè)肯定是毋庸置疑的觉壶。但是脑题,我們?cè)趯懳臋n的時(shí)候,可能就沒有這么在意行文的邏輯铜靶,全憑自覺來撰寫叔遂。
所以在寫文檔的時(shí)候,不僅僅需要理清整個(gè)產(chǎn)品争剿、功能的邏輯已艰,還需要為整篇文章的結(jié)構(gòu)和行為邏輯進(jìn)行提前的思考,不然產(chǎn)出的文檔可讀性也很差蚕苇。
第四坑——詳細(xì)得臃腫
在寫PRD時(shí)哩掺,為了想一次性把問題說清楚,讓程序員能一次性把文檔理解透涩笤。所以會(huì)把一個(gè)問題解釋得很詳細(xì)嚼吞,從而使得文檔變得很臃腫。
這不是認(rèn)真蹬碧,這其實(shí)是一種懶惰舱禽,因?yàn)橄胗梦臋n砸給程序員,讓他們自己去理解產(chǎn)品恩沽,不想和程序員進(jìn)行過多的交流和文檔解釋誊稚。
其實(shí)在實(shí)際工作中,我發(fā)現(xiàn)有就算你寫得再詳細(xì),如果不進(jìn)行口頭介紹里伯,程序員想把如此臃腫的文檔理解清楚也非常不容易城瞎。所以,如果能用流程圖來表述疾瓮,就不需要長(zhǎng)篇累述脖镀;如果能先進(jìn)行產(chǎn)品大致的介紹,讓大家先理解整個(gè)思路爷贫,就不需要文字上過于累贅的表述认然。
產(chǎn)品文檔應(yīng)該做到“考慮全面,邏輯清晰漫萄,語言精練”
第五坑——文檔排版不易讀
原來才開始寫文檔的時(shí)候,完全不知道什么排版盈匾,在無數(shù)次打磨自己的格式后腾务,開始對(duì)排版有了一點(diǎn)自己的理解。
如果說排版有什么技巧削饵,我想可能是這幾個(gè):
- 以功能劃分大板塊岩瘦,大板塊標(biāo)題醒目。
- 把大板塊簡(jiǎn)單拆分窿撬,并用小標(biāo)題區(qū)分启昧。
- 用點(diǎn)號(hào)羅列觀點(diǎn),不要寫成一大段劈伴。
對(duì)于文檔排版密末,統(tǒng)一文字格式后,做好以上幾點(diǎn)就能確保文檔基本整潔和可讀性跛璧。但是排版是個(gè)長(zhǎng)期打磨和鍛煉的事情严里,必須要經(jīng)常鍛煉,才能有一套自己的合理的排版風(fēng)格追城。
第六坑——重點(diǎn)內(nèi)容不突出
重點(diǎn)加得非常隨意刹碾,就會(huì)造成兩個(gè)結(jié)果,重點(diǎn)不突出和重點(diǎn)不夠重點(diǎn)座柱。
所以迷帜,文檔中應(yīng)該標(biāo)記重點(diǎn),但也要注意:
- 重點(diǎn)最好為重要的動(dòng)詞色洞、轉(zhuǎn)折詞戏锹、新名詞和關(guān)鍵邏輯判定詞等。
- 重點(diǎn)內(nèi)容不在于多锋玲,更在于精景用,滿篇重點(diǎn)則是沒有重點(diǎn)。
第七坑——不用程序員喜歡的形式寫文檔
最后,特別重要的一點(diǎn)伞插,也是不可不說的一點(diǎn)割粮,那就是使用程序員容易理解的、喜歡的方式來寫文檔媚污。
- 程序員更喜歡看到能用公式來展現(xiàn)各個(gè)數(shù)據(jù)或者信息之間的關(guān)系舀瓢;
- 了解程序員編程的時(shí)候常用的邏輯,多以這種邏輯術(shù)語來寫文檔耗美,這樣程序員就更能理解京髓;
- 多用分句,別用連句商架,一個(gè)分句表達(dá)一個(gè)意思就可以了堰怨。
- 能用配流程圖的,千萬別只寫文字蛇摸。
我是譚宇恒备图。
堅(jiān)持在路上的產(chǎn)品狗,愿陪你一同成長(zhǎng)赶袄。
如果你還有什么產(chǎn)品思考和學(xué)習(xí)經(jīng)驗(yàn)揽涮,請(qǐng)留言與我分享。