這篇文章暫時(shí)不討論什么是需求文檔，也不強(qiáng)調(diào)需求文檔的重要性等等，就簡(jiǎn)單地從各種細(xì)節(jié)問(wèn)題出發(fā)如何寫好一份需求文檔。

一份好的需求文檔的標(biāo)準(zhǔn)是什么？不同項(xiàng)目不同規(guī)模的團(tuán)隊(duì)有不一樣的評(píng)判標(biāo)準(zhǔn)，個(gè)人覺(jué)得能清晰準(zhǔn)確把握需求各項(xiàng)要素，寫完之后各相關(guān)部門同事能清楚明白，那就是一份好的需求文檔了。想要做到清晰和準(zhǔn)確卻不是一件簡(jiǎn)單的事，作為缺乏經(jīng)驗(yàn)的產(chǎn)品新人，我覺(jué)得可以從一些細(xì)節(jié)問(wèn)題上開(kāi)始做好。

有人會(huì)覺(jué)得需求文檔根本不需要那么嚴(yán)謹(jǐn)細(xì)膩，這樣會(huì)浪費(fèi)很多時(shí)間。寫產(chǎn)品需求文檔本就是一個(gè)鍛煉自己邏輯思維和推敲求證的過(guò)程，嚴(yán)謹(jǐn)細(xì)膩的態(tài)度可以讓我們更全面的考慮問(wèn)題，從而寫出一份好的需求文檔，減少團(tuán)隊(duì)成員的理解障礙。現(xiàn)在就把我平時(shí)寫需求文檔遇到的一些細(xì)節(jié)問(wèn)題拿出來(lái)給大家分享一下，希望大家都能避免這些不必要的錯(cuò)誤。

排版規(guī)范

我們會(huì)寫各種文檔，如圖能做到每一份文檔都有統(tǒng)一的排版，將更方便各部門同事閱讀。格式的標(biāo)準(zhǔn)包括文檔頁(yè)眉、各類型文字的字體型號(hào)、大小、顏色；表格規(guī)范；流程圖統(tǒng)一規(guī)范等等。

文檔的命名

如果能做到高度概括，精準(zhǔn)定義，可以幫助團(tuán)隊(duì)成員快速準(zhǔn)確把握文檔的內(nèi)容，避免跑偏。需求文檔的命名可以從文檔的意義，作用，性質(zhì)方面考慮。

名詞的定義

第一次出現(xiàn)在文檔中的特殊名詞一定要精準(zhǔn)描述，不可有缺失。產(chǎn)品肯定明白自己寫的內(nèi)容是什么，但并不代表團(tuán)隊(duì)里面的人都能理解。每個(gè)人對(duì)事物的理解都不一樣，如果不做好名詞的定義解釋，很容易產(chǎn)生歧義，從而產(chǎn)生分歧。用普通的電商網(wǎng)站舉個(gè)例子，如果在需求文檔只是簡(jiǎn)單描述說(shuō)“后臺(tái)實(shí)現(xiàn)XX功能”，那就麻煩大了。這個(gè)“后臺(tái)”可以指的是買家個(gè)人中心、賣家后臺(tái)系統(tǒng)甚至整個(gè)網(wǎng)站的后臺(tái)管理系統(tǒng)等等，如果不正確命名并解釋清楚，開(kāi)發(fā)看起來(lái)會(huì)很痛苦。

盡量不用大段大段文字描述需求，不是每個(gè)開(kāi)發(fā)都有耐心開(kāi)得下去。

盡量用表格或者流程圖進(jìn)行描述，比如說(shuō)要說(shuō)清楚不同角色間不同的功能權(quán)限，用表格列出來(lái)可以清楚明白地表達(dá)和比照；另外一種就是流程圖了，正所謂一圖勝千言。建議大家都可以學(xué)習(xí)和使用UML的一些相關(guān)知識(shí)，比如用例圖、類圖、序列圖、活動(dòng)圖、狀態(tài)圖等，它們可以清楚詳細(xì)的描繪出任何一種事物和各種邏輯關(guān)系。從開(kāi)發(fā)的角度看，他們是很喜歡這種表達(dá)方式的，如果你能正確熟練的使用的話。

牽扯到專業(yè)術(shù)語(yǔ)要弄清楚再寫

比如說(shuō)某些登錄輸入框需要用到正則表達(dá)式，如果自己沒(méi)弄懂什么是正則表達(dá)式，最好別寫在需求文檔上。需求文檔不是開(kāi)發(fā)文檔，我們不一定要用開(kāi)發(fā)的語(yǔ)言去描述，只要把功能邏輯講清楚即可。

不要留空白

很多時(shí)候我們?cè)趯懳臋n的過(guò)程總會(huì)有些內(nèi)容未確定，但是請(qǐng)養(yǎng)成好習(xí)慣，不要留空白的地方，未確定的地方寫“待定”或者“TBD”，并交代清楚和誰(shuí)待定，這將有利于你接下來(lái)的工作對(duì)接。

善于舉例

寫需求文檔的目的就是跟團(tuán)隊(duì)相關(guān)成員講清楚需求，在描述需求的時(shí)候多舉例子可以幫助閱讀人員更好的了解需求。我們可以像講故事一樣去描述需求，但是千萬(wàn)別跑偏了。

圖文一致

需求文檔我們會(huì)用到交互原型圖，原型的截圖和文字說(shuō)明必須保持一致，而且截圖必須與實(shí)現(xiàn)情況相符。

寫這篇文章的主要目的是想引起大家對(duì)文檔細(xì)節(jié)的重視，從細(xì)節(jié)中發(fā)現(xiàn)問(wèn)題，并找到相應(yīng)技巧和方法去把需求文檔寫好。上面只是列出了幾條細(xì)節(jié)問(wèn)題，如果大家在寫文檔過(guò)程中發(fā)現(xiàn)更多細(xì)節(jié)問(wèn)題和文檔技巧歡迎交流學(xué)習(xí)。

本文由 @samuel（微信號(hào)：suns_up） 原創(chuàng)發(fā)布于人人都是產(chǎn)品經(jīng)理?，未經(jīng)許可，禁止轉(zhuǎn)載。