完整的產品文檔寫作流程「產品設計文檔模板怎麼寫」

文檔能力是產品經理最基本的能力之一,學生時代我們寫的日記、作文、報告,以及論文等,都是在以不同的形式輸出文檔。實際的產品工作中輸出產品文檔的過程,本質上是把自己的產品邏輯進行文本化的描述的過程,最終目的是讓閱讀對象能清晰的閱讀並理解,產品相關文檔撰寫並不需要產品經理擁有很強的文字駕馭能力(當然有這種能力是更好),只要掌握基本的文檔撰寫方法和規範就能寫出合格的文檔。 如圖2-1所示,展示了產品經理文檔撰寫的基本方法。

圖2-1是產品經理撰寫文檔過程中可使用的一套完整的文檔撰寫方法,這個方法有三個步驟:定範圍、選模板,守規範。下文將詳細介紹如何利用這三個步驟完成一篇產品文檔的撰寫。

產品文檔撰寫的基本方法

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

(1)定範圍

當我們撰寫一個完整的產品文檔時,首先要定好文檔的範圍,通常要明確以下幾點:

① 文檔標題 (要求定位清晰,內容明確,如果文檔還在修訂過程中,需要在標題後面加上版本號)。

② 文檔目的(用清晰簡潔的語言描述文檔的用途)。

③ 文檔歸屬/閱讀對象(通常歸屬於文檔的撰寫人或其所在的組織,並對文檔擁有解釋權。閱讀對象則聲明適合或有權閱讀此文檔的人或組織);

④ 創建時間/更新時間(創建時間和更新時間在文檔創建時是一致的,後續每次更新,創建時間不變,更新時間隨文檔更新而更新);

⑤ 其它範圍(作為文檔範圍的其它要素補充,例如一些文檔有關於保密等級的說明等)。

(2)選模板

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

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

(3)守規範

規範化是產品經理在職業成長過程中需要具備的一項基本職業素質,小到文檔撰寫和原型設計的規範,大到用戶調研、需求分析、以及產品設計的規範,做事規範化是產品經理專業化的基本要求之一,文檔撰寫通常需要遵守以下幾種規範。

① 命名規範

標題命名時不僅要考慮標題可以準確傳達文檔的定位和類型,還要考慮標題名稱是否會引起歧義。通用的命名規則為:描述對象+版本號。例如:CRM系統產品需求文檔v1.0.0,一般文檔通常都用這個格式來命名,版本號的目的是為了記錄整個文檔輸出過程中的迭代過程。當然,一些文檔如果已經正式輸出的是最終版,且以後也不會再次修訂,則無需添加版本號。

② 表達規範

在文檔撰寫過程中,要注意一些文本表達的規範,盡量避免使用口語化的表達,例如:「我認為」;「我覺得」;「接下來我們」「那咱們」;等這樣的表達句式,這種口語化的句式會影響文檔的專業性和嚴謹性,也會給閱讀對象留下不專業的印象。

③ 版本號規範

一個文檔經常會被修訂多次最終輸出終版,每次編輯結束的時候都需要進行版本的更新,以保證其他編輯者了解上個版本編輯的內容,同時讓閱讀者也能清晰文檔的更新歷史。版本更新的內容包括版本號、修訂人(當然版本的修訂人)、修訂時間(當前版本的修訂時間)、修訂內容(當前版本修改,新增或刪除了那些內容)、備註(對當前版本的一些附加說明)等。

其中版本號是用來識別當前版本唯一性的命名方式,標準的版本號採用 VX.Y.Z 的格式。例如V1.1.0其中 V表示版本號 :Version Number ,簡寫為 V。X、Y、Z 為非負的整數。X 是主版本號、Y 是次版本號、 Z 為修訂號。首次發布的版本命名為v1.0.0。後期每更新一個版本,就在版本號上+1。

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

1. 當對文檔進行小規模的修訂時,修改疊加第三位數字,即Z+1,其他不變。例如:v1.0.0——V1.0.1。

2.當對文檔進行中等規模的修訂,修改疊加第二位數次,即Y+1,其他不變。例如:v1.0.0——V1.1.0。

3.當對文檔進行大規模的改動時,修改疊加第一位數次,即X+1,其他不變。例如:v1.0.0——V2.0.0。

4.前面的位數疊加後,後面的位數從零開始計算。例如v1.0.1——V1.1.0,v1.2.1——V2.0.0。

最後,希望讀者們除了按照以上的幾點要求,規範自己的文檔輸出之外,能在平時產品工作中不斷的實踐和積累,總結出一套屬於自己的規範,為以後的專業化和職業化打好基礎。

原創文章,作者:投稿專員,如若轉載,請註明出處:https://www.506064.com/zh-tw/n/323924.html

(0)
打賞 微信掃一掃 微信掃一掃 支付寶掃一掃 支付寶掃一掃
投稿專員的頭像投稿專員
上一篇 2025-01-12 12:50
下一篇 2025-01-12 12:50

相關推薦

發表回復

登錄後才能評論