撰寫需求文檔是產(chǎn)品經(jīng)理的核心工作之一，它直接影響到產(chǎn)品的開發(fā)效率和最終質(zhì)量。作者分享的9個關(guān)鍵細節(jié)，幫助產(chǎn)品經(jīng)理寫出既清晰又專業(yè)的需求文檔。

最近看下屬寫的產(chǎn)品文檔，邏輯混亂又賊難懂，估計 GPT 都讀不了。

預(yù)計 10 分鐘左右的評審，硬生生拖改了幾天，真的差點被氣哭。。

所以含淚寫了幾個小時，總結(jié)出我寫需求文檔的 9 個工作細節(jié)：顏色對比、大小差異、形狀區(qū)分、符號標記、避免歧義、圖表呈現(xiàn)、維度提煉、概念封裝、領(lǐng)域知識。

如果你工作中也遇到了類似問題，不妨看看。

一、顏色對比

通過顏色深淺、色域?qū)Ρ?，可以讓人一下就抓到文檔重點。

日常撰寫需求文檔時，你可以試著用紅字標記重要內(nèi)容或說明。

我有一個習慣是，會用藍字去表示一些可跳轉(zhuǎn)的頁面或交互。

二、大小差異

在一些 UI 設(shè)計規(guī)范中，一般有字體大小的使用規(guī)則。

例如 22px 用于頁面標題、17px 用于列表標題、14px 一般是列表描述文字。

其實我蠻建議初級的產(chǎn)品經(jīng)理，去學習一兩個組件庫的設(shè)計規(guī)范，包含“字體圖標、組件說明、顏色大小”等內(nèi)容。

畢竟產(chǎn)品經(jīng)理掌握組件庫，是一種快速提升審美能力的途徑。

三、形狀區(qū)分

假設(shè)文檔通過顏色對比、大小差異等優(yōu)化后，呈現(xiàn)的內(nèi)容還是難以理解和吸收，你可以嘗試增加形狀這一維度，進一步降低文檔的閱讀難度。

就像我們熟悉的流程圖，繪制時會用圓角矩形代表起始節(jié)點、矩形代表流程動作、菱形代表條件判斷。

四、符號標記

符號標記，指的是通過一些特殊符號，去突出重要內(nèi)容的層次，加深文檔讀者的印象。

我一般喜歡用中英文間隔、 “”【】「」等符號，來突出文檔中的一些重要內(nèi)容。

五、避免歧義

我發(fā)現(xiàn)初中級產(chǎn)品在撰寫文檔時，最容易犯的高頻錯誤，就是文檔中出現(xiàn)的各種內(nèi)容歧義。

例如列表的某個數(shù)據(jù)，需要顯示 clients 表的 name 字段。這個表又有各種類似的數(shù)據(jù) full_name、first_name、display_name。

如果你在文檔中寫的規(guī)則是“顯示客戶名稱”，那前后端聯(lián)調(diào)、測試驗收時大概率會出各種小問題。

他們有可能會懵逼卡殼一兩個小時，然后去猜、去問客戶名稱到底是指什么？

到底是用戶表、游客表還是客戶表呢？哦搞了半天原來是 clients 客戶表。那客戶名稱這個字段，又是 clients 客戶表的全名、名稱、姓氏這些中文翻譯，對應(yīng)的哪一個英文字段呢？

運氣好的話，前后端經(jīng)過一番折騰，或許能顯示你期望的內(nèi)容。

但大多數(shù)情況，由于你完全不懂其中的數(shù)據(jù)邏輯和細節(jié)，所以只要面上過得去沒有明顯 BUG，你可能就草草驗收了事，或者驗收時出錯，你連問題在哪排查都不知道。

我說的這種情況，其實只是最基礎(chǔ)、簡單的一個表數(shù)據(jù)出錯。

可以想象更復(fù)雜的財務(wù)賬單數(shù)據(jù)，要是數(shù)據(jù)能對上的話，那應(yīng)該是平時有燒香拜佛、買中彩票了吧。

六、圖表呈現(xiàn)

一圖勝千言，能用圖表的盡量圖表呈現(xiàn)。

比如某些復(fù)雜的知識概念，可能需要幾百字才能闡述清楚，如果通過圖片、表格進行呈現(xiàn)，或許看的人幾分鐘就完全明白了。

我記得剛做產(chǎn)品時，就遇到了對產(chǎn)品新人來說，比較復(fù)雜的訂單狀態(tài)定義，當時嘗試了文字描述，我寫的麻煩、耗時不說，看得人也非常費勁。

后來學會了 UML，用幾分鐘畫個簡單的狀態(tài)圖直接搞定，清晰直觀。

七、維度提煉

沒有經(jīng)過優(yōu)化加工的內(nèi)容，可以說只是一堆無序、混亂的信息。

要讓這些信息變成通俗易懂、持續(xù)復(fù)用的知識，你需要把它們進行總結(jié)提煉，并找出內(nèi)容的差異和共性，然后抽象出維度屬性。

最后將信息按維度，進行整理歸納、分門別類，這個思考過程可以稱為維度提煉。

脫不花老師在《溝通的方法》中，分享過一個職場的傾聽方法，叫結(jié)構(gòu)化傾聽。

即把溝通中的話題，提煉成了情緒、事實和期待等 3 個維度。

八、概念封裝

概念封裝，核心是將內(nèi)容進行壓縮和簡化，提升內(nèi)容的復(fù)用率。

具體指的是用一個簡單的概念，去表示一系列關(guān)聯(lián)度較高、重復(fù)使用的復(fù)雜內(nèi)容。

概念封裝的好處是，一次定義，持續(xù)復(fù)用。

像我的需求文檔模版中，常用的全局說明、名詞解釋、公式復(fù)用、參數(shù)說明、公共組件、交互解耦等文檔模塊，就是概念封裝的一些使用場景。

九、領(lǐng)域知識

如何才能快速提升文檔的溝通效率？其實核心在于，呈現(xiàn)領(lǐng)域知識。

簡單來說，就是當面對不同的讀者時，你要針對性地呈現(xiàn)專業(yè)內(nèi)容。

公司的老板時間都很寶貴，所以你要在一兩分鐘內(nèi)，就讓他快速 Get 到文檔重點。這時候內(nèi)容就要側(cè)重于簡潔，大白話講清楚文檔的核心概念。

如果是針對業(yè)務(wù)方，一方面你要表達得簡單易懂，另一方面又要呈現(xiàn)專業(yè)的業(yè)務(wù)知識，重點是快速達成雙方共識。

當面對前后端團隊時，你還要基于開發(fā)視角和技術(shù)知識，撰寫便于他們理解的文檔。

內(nèi)容不限于寫清楚數(shù)據(jù)處理、異常分支等復(fù)雜的規(guī)則交互等。

很多初級產(chǎn)品經(jīng)理一定會遇到這種情況，自己花一小時寫了一堆洋洋灑灑的文檔說明，開發(fā)居然一個字都不看。

其實這是因為文檔呈現(xiàn)的內(nèi)容，并不是開發(fā)通用語言，理解起來太費勁了。

更好的做法是，找到類似 UML 這種統(tǒng)一建模語言，畫幾個狀態(tài)圖、流程圖來呈現(xiàn)你的需求，既專業(yè)又高效。

十、總結(jié)

產(chǎn)品經(jīng)理在日常工作中，如何才能讓撰寫的需求文檔，顯得既清晰、又專業(yè)？

核心在于做好這 9 點：顏色對比、大小差異、形狀區(qū)分、符號標記、避免歧義、圖表呈現(xiàn)、維度提煉、概念封裝、領(lǐng)域知識。