第2章 如何撰寫產(chǎn)品文檔

2.1 撰寫產(chǎn)品文檔的基本方法

文檔撰寫能力是產(chǎn)品經(jīng)理必須具備的最基本的能力之一。在實(shí)際的產(chǎn)品工作中，產(chǎn)品經(jīng)理要輸出各種類型的文檔，例如，商業(yè)需求文檔、市場(chǎng)需求文檔、產(chǎn)品需求文檔，以及競(jìng)品分析文檔等。寫作本質(zhì)上是把自己的思考進(jìn)行文本化表達(dá)的過(guò)程，最終目的是讓閱讀對(duì)象清晰地閱讀并理解文檔的內(nèi)容。撰寫產(chǎn)品文檔并不需要產(chǎn)品經(jīng)理?yè)碛泻軓?qiáng)的文字駕馭能力（當(dāng)然，有這種能力更好），只要掌握基本的文檔撰寫方法和規(guī)范，就能寫出合格的產(chǎn)品文檔。

圖2-1是產(chǎn)品經(jīng)理在撰寫產(chǎn)品文檔的過(guò)程中可以使用的一套完整的產(chǎn)品文檔撰

圖2-1 撰寫產(chǎn)品文檔的基本方法

寫方法。這個(gè)方法有3個(gè)步驟，分別是定范圍、選模板、規(guī)范化。本節(jié)將詳細(xì)介紹如何利用這3個(gè)步驟撰寫一篇產(chǎn)品文檔。

1．定范圍

當(dāng)產(chǎn)品經(jīng)理要撰寫一個(gè)產(chǎn)品文檔時(shí)，首先要定好產(chǎn)品文檔的范圍，通常要明確以下5點(diǎn)。

● 文檔標(biāo)題（要求定位清晰、內(nèi)容明確，如果文檔還在修訂中，需要在標(biāo)題后面加上版本號(hào)）。

● 文檔目的（用清晰簡(jiǎn)潔的語(yǔ)言描述文檔的用途）。

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

● 創(chuàng)建時(shí)間/更新時(shí)間（創(chuàng)建時(shí)間和更新時(shí)間在文檔剛創(chuàng)建時(shí)是一致的，后續(xù)每次更新，創(chuàng)建時(shí)間不變，更新時(shí)間隨文檔的更新而改變）。

● 其他范圍（補(bǔ)充文檔范圍內(nèi)的其他要素，如一些文檔有關(guān)于保密等級(jí)的說(shuō)明等）。

2．選模板

確定文檔范圍后，接下來(lái)進(jìn)入文檔正文的撰寫階段。先根據(jù)文檔類型選擇一個(gè)合適的模板，模板提供了一種通用的格式框架，文檔輸出者可以直接套用格式框架，無(wú)須重新設(shè)計(jì)，在提高文檔輸出效率的同時(shí)，這也在一定程度上使不同時(shí)期、不同人輸出的文檔具備統(tǒng)一性和規(guī)范性。

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

3．規(guī)范化

規(guī)范化是產(chǎn)品經(jīng)理在職業(yè)成長(zhǎng)過(guò)程中需要具備的一項(xiàng)基本職業(yè)素質(zhì)。規(guī)范包含的內(nèi)容很多，小到文檔撰寫、原型設(shè)計(jì)的規(guī)范，大到用戶調(diào)研、需求分析及產(chǎn)品設(shè)計(jì)的規(guī)范。做事規(guī)范化是產(chǎn)品經(jīng)理專業(yè)化的基本要求之一。文檔撰寫通常需要遵守以下3個(gè)規(guī)范。

● 命名規(guī)范。產(chǎn)品文檔標(biāo)題的命名不僅要考慮標(biāo)題是否可以準(zhǔn)確表達(dá)文檔的定位和類型，還要考慮標(biāo)題名稱是否會(huì)引起歧義。通用的命名規(guī)則為描述對(duì)象+版本號(hào)，例如，CRM系統(tǒng)產(chǎn)品需求文檔V1.0.0，標(biāo)題中加版本號(hào)的目的是記錄整個(gè)文檔在輸出過(guò)程中的迭代過(guò)程。當(dāng)然，如果輸出的文檔是最終版，且以后不會(huì)再次修訂，則無(wú)須添加版本號(hào)。

● 表達(dá)規(guī)范。在文檔撰寫過(guò)程中，注意文本表達(dá)要規(guī)范，盡量避免使用口語(yǔ)化的表達(dá)，如“我認(rèn)為” “我覺得”“接下來(lái)我們”“那咱們”等表達(dá)句式。這種口語(yǔ)化的表達(dá)會(huì)降低文檔的專業(yè)性和嚴(yán)謹(jǐn)性，也會(huì)給閱讀對(duì)象留下不專業(yè)的印象。

● 版本號(hào)規(guī)范。一個(gè)文檔經(jīng)常會(huì)被修訂多次才輸出最終版，因此每次編輯結(jié)束的時(shí)候都需要進(jìn)行版本的更新，以保證其他編輯人員了解上個(gè)版本編輯過(guò)的內(nèi)容，同時(shí)讓閱讀人員能了解文檔的更新歷史。版本更新的內(nèi)容包括版本號(hào)、修訂人（當(dāng)前版本的修訂人）、修訂時(shí)間（當(dāng)前版本的修訂時(shí)間）、修訂內(nèi)容（當(dāng)前版本新增或刪除了哪些內(nèi)容）、備注（對(duì)當(dāng)前版本的一些附加說(shuō)明）等。

其中，版本號(hào)用來(lái)識(shí)別當(dāng)前版本，標(biāo)準(zhǔn)的版本號(hào)采用“VX.Y.Z”的格式。例如，V1.1.0中，V表示版本號(hào)，即Version Number；X、Y、Z 為非負(fù)的整數(shù)，X是主版本號(hào)，Y是次版本號(hào)，Z為修訂號(hào)。首次發(fā)布的版本命名為V1.0.0，后期每更新一個(gè)版本，就在主版本號(hào)上加1。

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

● 當(dāng)對(duì)文檔進(jìn)行小規(guī)模的修訂時(shí)，修改、疊加第3位數(shù)字，即Z+1，其他不變。例如，V1.0.0變?yōu)閂1.0.1。

● 當(dāng)對(duì)文檔進(jìn)行中等規(guī)模的修訂時(shí)，修改、疊加第2位數(shù)字，即Y+1，其他不變。例如，V1.0.0變?yōu)閂1.1.0。

● 當(dāng)對(duì)文檔進(jìn)行大規(guī)模的改動(dòng)時(shí)，修改、疊加第1位數(shù)字，即X+1，其他不變。例如，V1.0.0變?yōu)閂2.0.0。

● 位于前面的數(shù)字疊加后，后面的數(shù)字從零開始計(jì)算。例如，V1.0.1變?yōu)閂1.1.0，V1.2.1變?yōu)閂2.0.0。

最后，除按照以上幾點(diǎn)要求規(guī)范自己的文檔輸出之外，讀者還可以在平時(shí)的產(chǎn)品工作中不斷地實(shí)踐和積累，總結(jié)出一套屬于自己的規(guī)范，為產(chǎn)品工作的專業(yè)化和職業(yè)化打好基礎(chǔ)。