寫好需求文檔的 9 個關鍵細節,你一定要知道!

0 評論 566 瀏覽 2 收藏 9 分鐘

撰寫需求文檔是產品經理的核心工作之一,它直接影響到產品的開發效率和最終質量。作者分享的9個關鍵細節,幫助產品經理寫出既清晰又專業的需求文檔。

最近看下屬寫的產品文檔,邏輯混亂又賊難懂,估計 GPT 都讀不了。

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

所以含淚寫了幾個小時,總結出我寫需求文檔的 9 個工作細節:顏色對比、大小差異、形狀區分、符號標記、避免歧義、圖表呈現、維度提煉、概念封裝、領域知識。

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

一、顏色對比

通過顏色深淺、色域對比,可以讓人一下就抓到文檔重點。

日常撰寫需求文檔時,你可以試著用紅字標記重要內容或說明。

我有一個習慣是,會用藍字去表示一些可跳轉的頁面或交互。

二、大小差異

在一些 UI 設計規范中,一般有字體大小的使用規則。

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

其實我蠻建議初級的產品經理,去學習一兩個組件庫的設計規范,包含“字體圖標、組件說明、顏色大小”等內容。

畢竟產品經理掌握組件庫,是一種快速提升審美能力的途徑。

三、形狀區分

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

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

四、符號標記

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

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

五、避免歧義

我發現初中級產品在撰寫文檔時,最容易犯的高頻錯誤,就是文檔中出現的各種內容歧義。

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

如果你在文檔中寫的規則是“顯示客戶名稱”,那前后端聯調、測試驗收時大概率會出各種小問題。

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

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

運氣好的話,前后端經過一番折騰,或許能顯示你期望的內容。

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

我說的這種情況,其實只是最基礎、簡單的一個表數據出錯。

可以想象更復雜的財務賬單數據,要是數據能對上的話,那應該是平時有燒香拜佛、買中彩票了吧。

六、圖表呈現

一圖勝千言,能用圖表的盡量圖表呈現。

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

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

后來學會了 UML,用幾分鐘畫個簡單的狀態圖直接搞定,清晰直觀。

七、維度提煉

沒有經過優化加工的內容,可以說只是一堆無序、混亂的信息。

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

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

脫不花老師在《溝通的方法》中,分享過一個職場的傾聽方法,叫結構化傾聽。

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

八、概念封裝

概念封裝,核心是將內容進行壓縮和簡化,提升內容的復用率。

具體指的是用一個簡單的概念,去表示一系列關聯度較高、重復使用的復雜內容。

概念封裝的好處是,一次定義,持續復用。

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

九、領域知識

如何才能快速提升文檔的溝通效率?其實核心在于,呈現領域知識。

簡單來說,就是當面對不同的讀者時,你要針對性地呈現專業內容。

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

如果是針對業務方,一方面你要表達得簡單易懂,另一方面又要呈現專業的業務知識,重點是快速達成雙方共識。

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

內容不限于寫清楚數據處理、異常分支等復雜的規則交互等。

很多初級產品經理一定會遇到這種情況,自己花一小時寫了一堆洋洋灑灑的文檔說明,開發居然一個字都不看。

其實這是因為文檔呈現的內容,并不是開發通用語言,理解起來太費勁了。

更好的做法是,找到類似 UML 這種統一建模語言,畫幾個狀態圖、流程圖來呈現你的需求,既專業又高效。

十、總結

產品經理在日常工作中,如何才能讓撰寫的需求文檔,顯得既清晰、又專業?

核心在于做好這 9 點:顏色對比、大小差異、形狀區分、符號標記、避免歧義、圖表呈現、維度提煉、概念封裝、領域知識。

本文由人人都是產品經理作者【好夕雷】,微信公眾號:【產品之外】,原創/授權 發布于人人都是產品經理,未經許可,禁止轉載。

題圖來自Unsplash,基于 CC0 協議。

更多精彩內容,請關注人人都是產品經理微信公眾號或下載App
評論
評論請登錄
  1. 目前還沒評論,等你發揮!