編輯導(dǎo)語：產(chǎn)品需求文檔撰寫可能是產(chǎn)品經(jīng)理必備技能之一。而在撰寫需求文檔時(shí)，我們應(yīng)當(dāng)先了解需求、從而可以更準(zhǔn)確地下筆。那么，文檔撰寫是否有什么注意事項(xiàng)？本文作者就結(jié)合其案例經(jīng)驗(yàn)向我們闡述了需求文檔的一些要點(diǎn)事項(xiàng)，讓我們一起看一下吧。

各位大大好，我是一枚工作一年的產(chǎn)品小白。撰寫產(chǎn)品需求文檔是自己工作職責(zé)的一部分，下面分享一些自己對需求文檔的理解，如有不當(dāng)，還望各位大大多多指教～

本文分為如下4個(gè)模塊，全文約3500字，閱讀完畢大約需要5分鐘。

1. 為什么要寫產(chǎn)品需求文檔；
2. 需求文檔需要注意的一些點(diǎn)；
3. 實(shí)際案例；
4. 個(gè)人小結(jié)。

一、為什么要寫需求文檔

在我看來，寫需求文檔的目的主要有如下幾個(gè)。

1. 明確產(chǎn)品需求，避免遺漏

一個(gè)項(xiàng)目的需求有很多，把需求都記錄在文檔里并把具體的邏輯縷清，這樣能避免需求遺漏，同時(shí)方便管理。

2. 方便其他人員查閱，降低團(tuán)隊(duì)成員的溝通成本

當(dāng)團(tuán)隊(duì)其他成員需要了解項(xiàng)目需求時(shí)直接閱讀文檔就好了，也方便了產(chǎn)品經(jīng)理離職時(shí)的工作交接。

3. 信息存檔，作為功能開發(fā)的依據(jù)

如果開發(fā)出的功能不合預(yù)期，那么文檔可以作為依據(jù)，避免出現(xiàn)相關(guān)人員之間相互推諉責(zé)任的情況。

二、需求文檔需要注意的一些點(diǎn)

文檔是寫給別人看的！文檔是寫給別人看的！！文檔是寫給別人看的！?。?/p>

既然文檔時(shí)給別人看的，那就應(yīng)該讓讀者以最小的代價(jià)去看懂文檔。所以文檔的結(jié)構(gòu)、可讀性、對產(chǎn)品描述的完整性和對文檔的維護(hù)更新非常重要。

1. 文檔結(jié)構(gòu)

個(gè)人理解的文檔結(jié)構(gòu)是整個(gè)文檔是由哪些內(nèi)容組成的，它們的層級(jí)關(guān)系是怎樣的。比如在一級(jí)標(biāo)題下分別有哪些二級(jí)標(biāo)題，每個(gè)標(biāo)題的具體內(nèi)容分別講什么。

合理的結(jié)構(gòu)可以讓文檔內(nèi)容有條有理。可以先規(guī)劃好整體的文檔結(jié)構(gòu)，然后再開始寫具體的內(nèi)容，建議打開word或WPS中的導(dǎo)航窗格，方便預(yù)覽文檔的整體結(jié)構(gòu)，也方便快速查看某個(gè)模塊的內(nèi)容（單擊視圖中的導(dǎo)航窗格即可打開）。文檔結(jié)構(gòu)規(guī)劃圖示例：

如果是B端產(chǎn)品的文檔，可能還會(huì)涉及一些非功能性的描述，比如安全性、與其他系統(tǒng)的數(shù)據(jù)交互規(guī)則、數(shù)據(jù)的存儲(chǔ)備份規(guī)則等等。其實(shí)沒有標(biāo)準(zhǔn)的文檔結(jié)構(gòu)，具體看項(xiàng)目情況來定，能把需求明確清晰的表達(dá)出來就行了。

在WPS中打開導(dǎo)航窗格：

2. 文檔可讀性

文檔的可讀性還是蠻重要的，先不說內(nèi)容寫得怎么樣，起碼排面要有，特別是一些要交給客戶和領(lǐng)導(dǎo)的文檔，沒有排面可不行。如果想要文檔具有比較強(qiáng)的可讀性，需要注意以下幾個(gè)點(diǎn)。

1）大段文字描述時(shí)，可以分點(diǎn)描述的內(nèi)容就分點(diǎn)描述（以有序列表或無序列表的形式分點(diǎn)），同時(shí)也要注意內(nèi)容的分段。示例：

2）盡量以表格的形式去展現(xiàn)內(nèi)容，比如描述同一個(gè)事件的多種狀態(tài)時(shí)，用表格就比用大段文字合適。示例：

3）如果有某些需要重點(diǎn)強(qiáng)調(diào)的內(nèi)容，可以給字體標(biāo)上一些顯眼的顏色，以便讓讀者一眼就能注意到，特別是大段文字描述時(shí)，更應(yīng)該突出重點(diǎn)內(nèi)容，以便讀者能捕捉重點(diǎn)信息。示例：

4）文檔里的配圖/表格加上題注，讓讀者知道這個(gè)圖/表主要想表達(dá)什么內(nèi)容，減少讀者的認(rèn)知成本。通過通配符可以批量為圖片設(shè)置自動(dòng)題注，有需要的小伙伴可以去百度一下。示例：=

5）此外還有一些細(xì)節(jié)。

文字的行間距、段落的段間距在很大程度上也會(huì)影響文檔的視覺效果，行間距、段間距太小，文檔看起來會(huì)顯得很擁擠，太大文檔看起來會(huì)顯得很松散。

至于行間距和段間距要設(shè)多少，就要看正文字體是多大了，比如5號(hào)字體比較適用單倍行距，具體的大家可以去百度一下，反正看起來順眼就行。

3. 對產(chǎn)品描述的完整性

對產(chǎn)品描述的完整性是指盡可能的把一個(gè)產(chǎn)品的功能規(guī)則全部描述出來。

比如短信驗(yàn)證碼的相關(guān)規(guī)則包括：多久能獲取一次驗(yàn)證碼、某段時(shí)間內(nèi)最多可以獲取多少次驗(yàn)證碼、驗(yàn)證碼有多少位數(shù)、有效期是多久等等。

如果對產(chǎn)品規(guī)則描述得不齊全，可能會(huì)導(dǎo)致程序在開發(fā)時(shí)遺漏掉某些功能（有些程序真的是按照需求文檔進(jìn)行開發(fā)，完全不多想其他），別人讀起來也可能會(huì)感到疑惑：為什么這個(gè)功能沒有對xxx進(jìn)行限制?。?/p>

個(gè)人覺得要想做到盡可能全的把規(guī)則羅列出來，可以從以下3個(gè)方面著手：

1）寫文檔前一定要先把產(chǎn)品吃透，自己要先知道開發(fā)這個(gè)產(chǎn)品是為了解決什么問題，有哪些功能和相關(guān)規(guī)則，各個(gè)功能模塊間的關(guān)系是怎樣的，有哪些需要特別注意的點(diǎn)，同時(shí)要能熟練地使用產(chǎn)品。

如果自己都沒有把產(chǎn)品吃透，那很難寫出文檔的。

2）培養(yǎng)自己全方位思考問題的意識(shí)。一件事情發(fā)生前、發(fā)生時(shí)、發(fā)生后的規(guī)則分別是什么，是否有什么前置條件或特殊條件，如果某個(gè)條件不滿足會(huì)怎么樣等等，自己要主動(dòng)有這樣的意識(shí)去思考，而不是單純的靠經(jīng)驗(yàn)，想到什么就寫什么。

平時(shí)可以有意識(shí)的去訓(xùn)練自己，讓自己養(yǎng)成這樣思考問題的習(xí)慣。

3）多體驗(yàn)各種產(chǎn)品，研究它們的功能都有些什么約束規(guī)則，為什么要這么設(shè)計(jì)（比如淘寶的搜索框是怎樣設(shè)計(jì)的，具體有什么規(guī)則，為什么要這么設(shè)計(jì)）。

可以對各種情況進(jìn)行嘗試，比如在填寫某個(gè)信息時(shí)故意輸入很多位數(shù)，探究其對輸入信息的校驗(yàn)。也可以多看一下別人寫的需求文檔，里面也會(huì)對規(guī)則進(jìn)行約束性的描述。

總而言之就是要多看文檔或多體驗(yàn)其他產(chǎn)品，讓自己知道，這一類功能要進(jìn)行這樣的約束，是怎樣進(jìn)行約束的，而且也可以在這個(gè)過程中讓自己形成全方位思考問題的意識(shí)。

4. 文檔維護(hù)及更新

對于這個(gè)方面，個(gè)人的做法是這樣的，每一個(gè)功能模塊就起一個(gè)文檔來寫，如果把所有的功能都寫在一個(gè)文檔里，文檔會(huì)非常的冗長，而且不利于分工進(jìn)行開發(fā)。

實(shí)際案例：一個(gè)項(xiàng)目由多個(gè)產(chǎn)品經(jīng)理同時(shí)負(fù)責(zé)，每個(gè)人都負(fù)責(zé)相應(yīng)的功能模塊，如果把需求都寫在一個(gè)文檔里的話，會(huì)很難同步各方的信息（用云文檔可以解決信息同步困難這個(gè)問題，但我們公司沒有這樣做）。

每次對功能進(jìn)行改動(dòng)后，就復(fù)制一份文檔，然后在上面更新改動(dòng)的內(nèi)容，并給一個(gè)新的版本號(hào)，大版本直接由1.0升到2.0，小版本就由1.0升到1.1，如果是很小很小的改動(dòng)，不給新的版本號(hào)也可以，直接在當(dāng)前最新版本的文檔里寫就好了。

同時(shí)還要寫明版本信息，說明是誰改動(dòng)了文檔，什么時(shí)候改的，相比于上一個(gè)版本改了什么東西。一個(gè)功能模塊的文檔經(jīng)過多次迭代后是這樣的：

三、實(shí)際案例

版本信息

1. 需求概述

1）需求來源

對多款競品進(jìn)行分析并結(jié)合產(chǎn)品自身戰(zhàn)略方向得出需求。

2）需求目的

提供多種登錄方式供用戶進(jìn)行登錄，減少用戶登錄的操作成本，降低用戶流失率。

3）功能說明

2. 登錄功能需求

1）UI原型圖

2）功能流程圖

3）前端規(guī)則

手機(jī)號(hào)登錄

• 手機(jī)號(hào)要輸入11位數(shù)，否則提示：手機(jī)號(hào)格式錯(cuò)誤。暫不考慮海外手機(jī)號(hào)碼登錄。
• 60秒后才能再次獲取驗(yàn)證碼，在此期間，獲取驗(yàn)證碼按鈕置灰不可點(diǎn)擊且顯示倒計(jì)時(shí)動(dòng)畫。
• 手機(jī)驗(yàn)證碼最多能輸入5位數(shù)，否則提示：驗(yàn)證碼格式錯(cuò)誤。
• 手機(jī)驗(yàn)證碼錯(cuò)誤則提示：驗(yàn)證碼錯(cuò)誤。
• 輸入了過期的驗(yàn)證碼，則點(diǎn)擊登錄后提示提示：驗(yàn)證碼無效或已過期，請重新獲取。
• 在第5次獲取驗(yàn)證碼時(shí)彈出提示：驗(yàn)證碼已發(fā)送，請?jiān)赱下次可獲取驗(yàn)證碼時(shí)間點(diǎn)]再次嘗試獲取。在驗(yàn)證碼冷卻期內(nèi)再次點(diǎn)擊獲取驗(yàn)證碼按鈕，則提示：請?jiān)赱下次可獲取驗(yàn)證碼時(shí)間點(diǎn)]再次嘗試獲取。
• 根據(jù)后端返回的標(biāo)志判斷是否為第一次登錄，如果是，則登錄成功后進(jìn)入創(chuàng)建賬號(hào)流程，否則直接進(jìn)入APP。

賬號(hào)密碼登錄

如果登錄失敗則彈出提示：賬號(hào)或密碼錯(cuò)誤，請重新輸入。

社交賬號(hào)快捷登錄

單擊社交賬號(hào)登錄按鈕后，根據(jù)相應(yīng)社交APP的狀態(tài)作出響應(yīng)：

其他

• 單擊“賬號(hào)密碼登錄”可以跳轉(zhuǎn)到賬號(hào)密碼登錄的界面，單擊“手機(jī)號(hào)快捷登錄”可以跳到手機(jī)號(hào)快捷登錄的界面。
• 單擊登錄遇到問題可以跳到“常見問題解答”界面。在兩種登錄模式下都是跳到同一個(gè)界面。

4）后端規(guī)則

手機(jī)號(hào)登錄

• 以第1次單擊獲取驗(yàn)證碼按鈕的時(shí)間點(diǎn)為準(zhǔn)，同一手機(jī)號(hào)一個(gè)小時(shí)內(nèi)最多可以獲取5次短信驗(yàn)證碼，以單擊第5次獲取驗(yàn)證碼的按鈕時(shí)間點(diǎn)為準(zhǔn)進(jìn)行計(jì)時(shí)，60分鐘后可再次獲取驗(yàn)證碼。比如在7:24:00第1次獲取驗(yàn)證碼，則在7:24:00—8:24:00期間只能獲取5次驗(yàn)證碼。
• 獲取驗(yàn)證碼后需要等待60秒才能獲取下一次驗(yàn)證碼。
• 驗(yàn)證碼有效期為5分鐘，發(fā)送多個(gè)驗(yàn)證碼時(shí)以最后一個(gè)為準(zhǔn)。
• 如果該手機(jī)號(hào)為首次登錄，則返回標(biāo)志至前端。

賬號(hào)密碼登錄

如果賬號(hào)或密碼錯(cuò)誤，或賬號(hào)不存在，則返回登錄失敗標(biāo)志。

社交賬號(hào)快捷登錄

每個(gè)社交賬號(hào)都可以創(chuàng)建一個(gè)獨(dú)立的賬號(hào)，例如使用qq/微信登錄的賬號(hào)，它們之間的數(shù)據(jù)不共享。

5）測試要點(diǎn)

各個(gè)功能是否遵循如上規(guī)則。

四、個(gè)人小結(jié)

這篇文章主要是講文檔的結(jié)構(gòu)和關(guān)于可讀性的一些注意事項(xiàng)，都是一些偏展示形式的東西，但要真正寫好一份文檔，對產(chǎn)品的熟悉和理解才是最關(guān)鍵的，個(gè)人覺得，一份好的文檔=好的想法+好的展現(xiàn)形式。

文章中的登錄功能是是參考了簡書，上面關(guān)于社交賬號(hào)登錄的描述不是特別詳細(xì)，有興趣了解的小伙伴們可以去下載APP自己體驗(yàn)一下。

小弟目前經(jīng)驗(yàn)尚且不足，歡迎各位大大對文章做出評論～

本文由 @活蹦亂跳的大咸魚 原創(chuàng)發(fā)布于人人都是產(chǎn)品經(jīng)理。未經(jīng)許可，禁止轉(zhuǎn)載。

題圖來自 Unsplash，基于CC0協(xié)議。