16種簡單方法讓需求文檔更清晰更專業(yè)
需求文檔作為整個(gè)項(xiàng)目中最重要的內(nèi)容,直接影響整個(gè)項(xiàng)目開發(fā)的質(zhì)量。產(chǎn)品經(jīng)理的重點(diǎn)在需求文檔的功能邏輯、取值邏輯、交互邏輯等描述上,還有就是關(guān)注PRD的可讀性。PRD是你給到團(tuán)隊(duì)中的最重要的文檔,團(tuán)隊(duì)成員都看著PRD來干活。能夠準(zhǔn)確、快速、清晰的表達(dá)出PRD內(nèi)容,也有很多注意點(diǎn)。
一、使用合適的需求文檔類型
1. Word文檔
通過Word進(jìn)行需求描述,對(duì)外提供 Word 或PDF 格式。
容易留存,也比較正規(guī),在閱讀上以文字為主。
文檔中包含了文字+原型圖,使用「原型圖片+文檔內(nèi)文字說明」的方式進(jìn)行描述。
對(duì)于沒有原型的需求文檔。
比如接口需求,偏后端邏輯的需求。
只需要通過文檔進(jìn)行描述即可,直接使用word就行。
2. 原型一體化需求文檔
在原型里將需求文檔中各個(gè)內(nèi)容全部包含,然后將原型通過在線鏈接、或者是打包成html 提供出去。
在畫原型的時(shí)候,同步寫上功能描述。
具體選擇哪種類型?
——首先看公司要求。
像我之前有公司要求,必須用word,就算是有大量原型的,也只能把頁面原型畫好,然后再復(fù)制到word里,在word寫需求內(nèi)容。
如果公司 / 團(tuán)隊(duì)沒有要求,具體采用的方式可以看不同的需求類型:
如果涉及到畫原型,且原型頁面較多的:
——建議使用Axure原型一體化需求文檔。
如果只有偏后端需求的,邏輯相關(guān)的需求。
比如說是接口需求、算法需求,并不涉及到前端需求的。
—— 建議直接使用 word 寫。
如果是做的大項(xiàng)目,同時(shí)有功能需求,又有接口需求、算法需求的。
—— 建議都在原型中寫需求,使用Axure原型一體化需求文檔
我之前做新項(xiàng)目時(shí),Axure文檔用于描述功能,然后提供了word文檔,重點(diǎn)說接口邏輯。
后來用例評(píng)審的時(shí)候,測(cè)試說不知道word版接口需求,之后我就統(tǒng)一寫在Axure里了。
在這篇文章里,我們重點(diǎn)說下「原型一體化需求文檔」中的注意點(diǎn)。
目的很簡單:提高易讀性,提高信息傳達(dá)效率。
二、頁面文件夾層級(jí)劃分合理
在Axure中可以添加頁面文件夾與頁面(page),一個(gè)合理的頁面劃分可以很大的提高可讀性。
以下 Axure 中的頁面稱為Page,為避免與原型的頁面造成誤解。
我覺得不錯(cuò)的劃分方法有:
1. 按照菜單層級(jí)劃分
如下圖,這是一個(gè)后臺(tái)的需求文檔,我們可以將一級(jí)菜單劃分成文件夾、將二級(jí)菜單作為page。
文件夾名稱、Page名稱都使用菜單名稱。
2. 按照功能點(diǎn)大小劃分
當(dāng)功能點(diǎn)的頁面太大時(shí),我們可以新增一個(gè)Page進(jìn)行說明。
如下圖,「機(jī)構(gòu)管理」是個(gè)表格,有「新增」與「編輯」兩個(gè)功能。
點(diǎn)擊「新增」時(shí),會(huì)彈出一個(gè)彈窗,但是彈窗里的內(nèi)容太多,在「機(jī)構(gòu)管理」中添加描述時(shí),內(nèi)容會(huì)很多。
所以就可以再建一個(gè)Page,單獨(dú)對(duì)「新增」「編輯」進(jìn)行說明。
在「機(jī)構(gòu)管理」寫到「新增機(jī)構(gòu)」這個(gè)功能時(shí),則引導(dǎo)去另外一個(gè)頁面進(jìn)行查看具體說明。
如下圖:
但是并不是要每個(gè)功能點(diǎn)都新建Page。
當(dāng)一個(gè)頁面中的功能描述太多、某個(gè)功能點(diǎn)的描述有很多時(shí),這時(shí)可以單獨(dú)建一個(gè)Page進(jìn)行說明。
目的是劃分出多個(gè)Axure Page,避免一個(gè)頁面中內(nèi)容過多,影響閱讀。
3. 按照Tab頁、步驟條中每個(gè)頁面劃分
比如使用了步驟條組件,我們可以把步驟條的每一步對(duì)應(yīng)新建出一個(gè)Page,對(duì)每一步單獨(dú)進(jìn)行說明。
對(duì)于Tab頁也是,把每個(gè)Tab頁都新建對(duì)應(yīng)的Page。
二、原型與描述的排版
我們先從原型與功能描述的布局看,我了解到的有3種,推薦的是第1種:
1. 左圖右文(推薦)
示例圖如下:
這種布局方式是我最建議的方式。
左邊放原型,右邊放描述內(nèi)容。
通過編號(hào)進(jìn)行左右對(duì)應(yīng),可以快速找到對(duì)應(yīng)的說明。
在一屏內(nèi)容中可以顯示出原型與描述,且功能點(diǎn)位置與功能描述的位置有映射關(guān)系。
功能點(diǎn)從上到下編號(hào),功能點(diǎn)描述從上到下依次描述,可很容易找到對(duì)應(yīng)位置。
這種布局也會(huì)有一個(gè)問題,就是當(dāng)右側(cè)功能描述內(nèi)容太多時(shí),功能點(diǎn)與功能描述的位置會(huì)離得比較遠(yuǎn)。
極端例子:第1個(gè)編號(hào)的功能點(diǎn)寫了很多,超過了一屏,然后在寫之后的功能描述時(shí),需要滑動(dòng)頁面。在看的時(shí)候也是,再查看第2點(diǎn)之后的描述時(shí)需要不停的上下滑動(dòng)頁面,來找到原型與描述。
2. 上圖下文
示例:
在上邊放原型圖,下邊放描述。在很多交互稿中會(huì)使用這種方式。
不過這種方式有個(gè)最明顯的問題:
功能點(diǎn)與描述內(nèi)容離的太遠(yuǎn),眼睛需要上下移動(dòng)去查看。
如果在一屏內(nèi)能顯示出全部內(nèi)容,還會(huì)好點(diǎn)。當(dāng)高度超過一屏后,則需要進(jìn)行上下滑動(dòng)頁面去查看,很費(fèi)勁。
3. 左右布局
如下圖:
原型在中間,左右放描述。
這種視覺流很亂,根據(jù)編號(hào)來回找。
這種對(duì)于PC端大尺寸頁面更不適用,需要來回左右滑動(dòng)。
三、功能序號(hào)標(biāo)注
先畫出原型圖,在原型中標(biāo)注「序號(hào)」,然后在右側(cè)按照相同的序號(hào)進(jìn)行功能需求描述。
這是一種很方便的方式。
1)標(biāo)注順序:一般按照從左到右,從上到下的順序。
2)標(biāo)注哪些點(diǎn):需要進(jìn)行功能說明的功能點(diǎn),但是并不意味著每一個(gè)點(diǎn)都要進(jìn)行標(biāo)注。
一般按照從大到小,按照模塊化的方式進(jìn)行序號(hào)標(biāo)注。
以下方的表單頁面為例:
當(dāng)原型畫出后,在頁面上標(biāo)個(gè)序號(hào) 「 1 」,對(duì)頁面進(jìn)行下簡介。
一般說明頁面是什么,使用角色是誰、權(quán)限是什么等等,對(duì)整個(gè)頁面進(jìn)行說明。
然后繼續(xù)標(biāo)注「返回」,對(duì)「返回」進(jìn)行說明。
然后接著對(duì)下方的「患者信息」進(jìn)行標(biāo)注。
可以看到「患者信息」里有很多字段,我不建議對(duì)每個(gè)字段進(jìn)行說明。
可以直接對(duì)「患者信息」整個(gè)模塊進(jìn)行標(biāo)注,然后對(duì)每個(gè)字段進(jìn)行說明。
(現(xiàn)在看其實(shí)上邊的需求描述還是不全,比如漏了小數(shù)點(diǎn)位數(shù)說明,文本輸入框內(nèi)能不能輸入表情emoji符號(hào)等等)
當(dāng)頁面內(nèi)出現(xiàn)彈窗時(shí),在右邊展示出彈窗原型,接著對(duì)彈窗里的內(nèi)容進(jìn)行說明。
單獨(dú)對(duì)彈窗里功能點(diǎn)進(jìn)行標(biāo)注,然后在下方繼續(xù)對(duì)需求進(jìn)行說明。
對(duì)于彈窗里的內(nèi)容,我一般從「1」開始重新編號(hào),不把彈窗里的序號(hào)和其他頁面夾雜在一起。
當(dāng)存在功能點(diǎn)遺漏,或者要添加新的功能點(diǎn)說明時(shí),這時(shí)候會(huì)涉及到功能點(diǎn)標(biāo)注序號(hào)的修改。
比如一個(gè)頁面中的序號(hào)標(biāo)注 1 – 10,這時(shí)發(fā)現(xiàn)中間少了個(gè)標(biāo)注。
可以采用新增一個(gè) 「11 」,然后對(duì)「11 」再進(jìn)行說明,不用嚴(yán)格按照順序標(biāo)注的方式。
四、利用連接線
使用連接線連接功能點(diǎn)與功能描述。比如下邊的例子。
我不建議這種方式,首先我們已經(jīng)有了序號(hào),可以找到對(duì)應(yīng)關(guān)系。
另外使用連接線,會(huì)產(chǎn)生多余的工作量,需要去調(diào)整線條,不讓線條遮擋內(nèi)容……
我認(rèn)為是沒有必要使用連接線連接功能點(diǎn)與描述。
不過使用連接線來連接頁面,這種方式很好。
但是只針對(duì)移動(dòng)端頁面,PC端并不適用。
看個(gè)例子:
在下邊的頁面中,我將全部頁面平鋪在了一個(gè)Page里。
當(dāng)涉及到頁面跳轉(zhuǎn)、彈出層時(shí),可以使用連接線,連接功能點(diǎn)與頁面,用于表達(dá)頁面流程。
在使用連接線時(shí)要注意,不要讓連接線遮擋內(nèi)容,連接線也不要交叉。
五、功能描述注意點(diǎn)
功能描述是需求文檔中很重要的部分,對(duì)于功能描述有幾點(diǎn)我們可以注意:
1. 重點(diǎn)內(nèi)容重點(diǎn)突出
可以使用一個(gè)突出的顏色,比如標(biāo)紅、標(biāo)黃。
功能描述很多時(shí),看的人很容易忽略。
因?yàn)榇蠹铱次淖侄际菕哌^去,不會(huì)每個(gè)字每個(gè)字的去看。
我吃過這個(gè)虧,有次驗(yàn)收的時(shí)候返現(xiàn)最重要的功能沒實(shí)現(xiàn),研發(fā)測(cè)試說沒看到,我一看需求文檔上寫了,然后研發(fā)加班搞得。
無論寫什么文檔,重點(diǎn)內(nèi)容都要重點(diǎn)突出。
2. 有必要添加示例
文字說明都會(huì)有一定的片面理解。
對(duì)于比較復(fù)雜的內(nèi)容我們可以添加示例說明:
3. 采用多分段,多分行,加序號(hào)的方式
當(dāng)文字較多時(shí),分行分段是很有用的方式。
添加序號(hào)也能更易閱讀。
4. 用好標(biāo)點(diǎn)符號(hào)
如:點(diǎn)擊「確認(rèn)」按鈕,跳轉(zhuǎn)至【XXX頁面】。
將特殊的名稱、動(dòng)作通過符號(hào)框住,可以更清晰的表達(dá)。
5. 結(jié)合Axure的特性,添加文字鏈接
當(dāng)需要閱讀者進(jìn)入另一個(gè)Page查看時(shí),可以通過「添加文字鏈接」交互,點(diǎn)擊文字鏈接快速進(jìn)入對(duì)應(yīng)Page。
6. 內(nèi)容變更時(shí)保留記錄
當(dāng)描述需要修改時(shí),可以保留原內(nèi)容,然后添加刪除線,并寫上修改后的內(nèi)容,寫上修改時(shí)間。
如果你直接刪除,接著寫修改后的內(nèi)容,你可能會(huì)忘了改之前的邏輯。
7. 對(duì)于變量值,使用特殊符號(hào)標(biāo)記下
對(duì)于會(huì)變化的值,我一般使用用兩個(gè)百分號(hào)。
如下方的「科室名稱」,會(huì)根據(jù)不同的選擇展示不同的名稱,所以我就通過‘%科室名稱%’進(jìn)行表示,然后單獨(dú)說明,并舉例說明。
8. 用表格描述也挺好
除了使用文字,功能描述時(shí)還可以使用表格的方式。
比如表單頁字段說明,當(dāng)內(nèi)容很多時(shí),可以直接使用表格進(jìn)行說明。
9. 寫上頁面名稱、功能點(diǎn)名稱
對(duì)于每個(gè)頁面、每個(gè)功能點(diǎn),可以單獨(dú)展示出名稱,這樣便于找到頁面。
如果頁面重要,也可以說明下頁面是什么,干什么的。
六、不建議使用的方式
1. 不要嵌套mockup
這種很不建議,只能展示出首屏內(nèi)容,當(dāng)頁面多長時(shí),還要添加上下滑動(dòng),手機(jī)殼也沒有任何用。
在純演示交互時(shí)沒問題,但是在PRD中,不要用。
2. 盡量不要把 功能序號(hào) 和 動(dòng)效 混在一塊
舉個(gè)例子:
比如:畫原型使用動(dòng)態(tài)面板,做了個(gè)切換Tab的動(dòng)效。
并且在動(dòng)態(tài)面板里的每個(gè)State(面板頁面)里的原型上添加了序號(hào)標(biāo)注。
想把動(dòng)效和功能描述都展示出來。
如果你這樣做,你需要在面板頁面里標(biāo)上序號(hào),再退出動(dòng)態(tài)面板,然后再繼續(xù)寫功能描述。
這樣非常費(fèi)時(shí)間,而且這個(gè)時(shí)間很沒有必要,不要多給自己找事。
操作的越多,出錯(cuò)的概率就越大。
可以直接把Tab頁的每個(gè)頁面平鋪出來,直接進(jìn)行標(biāo)注序號(hào)、功能描述即可。
不要迷戀動(dòng)態(tài)交互。
3. 不要使用看起來很炫酷的Axure需求文檔模板
對(duì)于需求文檔,只要你說明白,讓看的人能看明白,你能最快的完成需求文檔輸出就行了。
有些原型需求文檔模板,提供了很多動(dòng)態(tài)交互,可以在模板里寫很多內(nèi)容。
這個(gè)也沒有意義,你寫內(nèi)容的時(shí)候很費(fèi)事,看的人也麻煩。
就直接規(guī)規(guī)矩矩的使用Axure文件夾、Page放不同的內(nèi)容就可以了。
七、總結(jié)
我們從原型一體化需求文檔中包含的內(nèi)容做了說明,來提供PRD的易讀性。
還有其它點(diǎn):
把Page底色設(shè)置成護(hù)眼的顏色、調(diào)整功能描述文字的字間距、行間距等。
還有文字顏色,我一直使用的Antdesign組件庫中的刺眼玫紅,我也想打算改個(gè)柔和的顏色。
產(chǎn)品經(jīng)理要考慮用戶體驗(yàn),需求文檔是產(chǎn)品經(jīng)理輸出的最核心的產(chǎn)品,所以這個(gè)產(chǎn)品的用戶體驗(yàn)我們也要好好優(yōu)化。
本文由人人都是產(chǎn)品經(jīng)理作者【王大鹿】,微信公眾號(hào):【產(chǎn)品大鹿】,原創(chuàng)/授權(quán) 發(fā)布于人人都是產(chǎn)品經(jīng)理,未經(jīng)許可,禁止轉(zhuǎn)載。
題圖來自Unsplash,基于 CC0 協(xié)議。
干爹公眾號(hào)文件都有rp源文件我愛你
更多產(chǎn)品落地干貨,都在公眾號(hào):產(chǎn)品大鹿
寫的好棒??!
牛啊牛啊 作者大大有沒有推薦組件
都在公眾號(hào):產(chǎn)品大鹿,里邊有
突然發(fā)現(xiàn) 去年關(guān)注過你