第2章 如何撰寫產品文檔

2.1 撰寫產品文檔的基本方法

文檔撰寫能力是產品經理必須具備的最基本的能力之一。在實際的產品工作中，產品經理要輸出各種類型的文檔，例如，商業需求文檔、市場需求文檔、產品需求文檔，以及競品分析文檔等。寫作本質上是把自己的思考進行文本化表達的過程，最終目的是讓閱讀對象清晰地閱讀并理解文檔的內容。撰寫產品文檔并不需要產品經理擁有很強的文字駕馭能力（當然，有這種能力更好），只要掌握基本的文檔撰寫方法和規范，就能寫出合格的產品文檔。

圖2-1是產品經理在撰寫產品文檔的過程中可以使用的一套完整的產品文檔撰

圖2-1 撰寫產品文檔的基本方法

寫方法。這個方法有3個步驟，分別是定范圍、選模板、規范化。本節將詳細介紹如何利用這3個步驟撰寫一篇產品文檔。

1．定范圍

當產品經理要撰寫一個產品文檔時，首先要定好產品文檔的范圍，通常要明確以下5點。

● 文檔標題（要求定位清晰、內容明確，如果文檔還在修訂中，需要在標題后面加上版本號）。

● 文檔目的（用清晰簡潔的語言描述文檔的用途）。

● 文檔歸屬/閱讀對象（通常文檔歸屬于文檔的撰寫人或其所在的組織，文檔的撰寫人或其所在組織對文檔內容擁有解釋權。閱讀對象則是適合或有權閱讀此文檔的人或組織）。

● 創建時間/更新時間（創建時間和更新時間在文檔剛創建時是一致的，后續每次更新，創建時間不變，更新時間隨文檔的更新而改變）。

● 其他范圍（補充文檔范圍內的其他要素，如一些文檔有關于保密等級的說明等）。

2．選模板

確定文檔范圍后，接下來進入文檔正文的撰寫階段。先根據文檔類型選擇一個合適的模板，模板提供了一種通用的格式框架，文檔輸出者可以直接套用格式框架，無須重新設計，在提高文檔輸出效率的同時，這也在一定程度上使不同時期、不同人輸出的文檔具備統一性和規范性。

而產品工作中的很多文檔類型（例如，產品經理經常需要寫的三大文檔，以及產品體驗報告、用戶調研報告、行業分析報告等）有比較固定的模板。產品經理在撰寫文檔時，只需要按照固定的模板填充需要的內容，就可以快速、高效地輸出專業的文檔。

3．規范化

規范化是產品經理在職業成長過程中需要具備的一項基本職業素質。規范包含的內容很多，小到文檔撰寫、原型設計的規范，大到用戶調研、需求分析及產品設計的規范。做事規范化是產品經理專業化的基本要求之一。文檔撰寫通常需要遵守以下3個規范。

● 命名規范。產品文檔標題的命名不僅要考慮標題是否可以準確表達文檔的定位和類型，還要考慮標題名稱是否會引起歧義。通用的命名規則為描述對象+版本號，例如，CRM系統產品需求文檔V1.0.0，標題中加版本號的目的是記錄整個文檔在輸出過程中的迭代過程。當然，如果輸出的文檔是最終版，且以后不會再次修訂，則無須添加版本號。

● 表達規范。在文檔撰寫過程中，注意文本表達要規范，盡量避免使用口語化的表達，如“我認為” “我覺得”“接下來我們”“那咱們”等表達句式。這種口語化的表達會降低文檔的專業性和嚴謹性，也會給閱讀對象留下不專業的印象。

● 版本號規范。一個文檔經常會被修訂多次才輸出最終版，因此每次編輯結束的時候都需要進行版本的更新，以保證其他編輯人員了解上個版本編輯過的內容，同時讓閱讀人員能了解文檔的更新歷史。版本更新的內容包括版本號、修訂人（當前版本的修訂人）、修訂時間（當前版本的修訂時間）、修訂內容（當前版本新增或刪除了哪些內容）、備注（對當前版本的一些附加說明）等。

其中，版本號用來識別當前版本，標準的版本號采用“VX.Y.Z”的格式。例如，V1.1.0中，V表示版本號，即Version Number；X、Y、Z 為非負的整數，X是主版本號，Y是次版本號，Z為修訂號。首次發布的版本命名為V1.0.0，后期每更新一個版本，就在主版本號上加1。

以下是文檔版本更新的一些通用規則。

● 當對文檔進行小規模的修訂時，修改、疊加第3位數字，即Z+1，其他不變。例如，V1.0.0變為V1.0.1。

● 當對文檔進行中等規模的修訂時，修改、疊加第2位數字，即Y+1，其他不變。例如，V1.0.0變為V1.1.0。

● 當對文檔進行大規模的改動時，修改、疊加第1位數字，即X+1，其他不變。例如，V1.0.0變為V2.0.0。

● 位于前面的數字疊加后，后面的數字從零開始計算。例如，V1.0.1變為V1.1.0，V1.2.1變為V2.0.0。

最后，除按照以上幾點要求規范自己的文檔輸出之外，讀者還可以在平時的產品工作中不斷地實踐和積累，總結出一套屬于自己的規范，為產品工作的專業化和職業化打好基礎。