很可惜 T 。T 您現(xiàn)在還不是作者身份，不能自主發(fā)稿哦～
如有投稿需求，請把文章發(fā)送到郵箱tougao@appcpx.com，一經(jīng)錄用會有專人和您聯(lián)系
咨詢?nèi)绾纬蔀榇河鹱髡哒埪?lián)系：鳥哥筆記小羽毛（ngbjxym）
最近看下屬寫的產(chǎn)品文檔，邏輯混亂又賊難懂，估計 GPT 都讀不了。
預計 10 分鐘左右的評審，硬生生拖改了幾天，真的差點被氣哭。。
所以含淚寫了幾個小時，總結(jié)出我寫需求文檔的 9 個工作細節(jié)：顏色對比、大小差異、形狀區(qū)分、符號標記、避免歧義、圖表呈現(xiàn)、維度提煉、概念封裝、領域知識。
如果你工作中也遇到了類似問題，不妨看看。
通過顏色深淺、色域?qū)Ρ龋梢宰屓艘幌戮妥サ轿臋n重點。
日常撰寫需求文檔時，你可以試著用紅字標記重要內(nèi)容或說明。
我有一個習慣是，會用藍字去表示一些可跳轉(zhuǎn)的頁面或交互。
在一些 UI 設計規(guī)范中，一般有字體大小的使用規(guī)則。
例如 22px 用于頁面標題、17px 用于列表標題、14px 一般是列表描述文字。
其實我蠻建議初級的產(chǎn)品經(jīng)理，去學習一兩個組件庫的設計規(guī)范，包含“字體圖標、組件說明、顏色大小”等內(nèi)容。
畢竟產(chǎn)品經(jīng)理掌握組件庫，是一種快速提升審美能力的途徑。
假設文檔通過顏色對比、大小差異等優(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 客戶表的全名、名稱、姓氏這些中文翻譯，對應的哪一個英文字段呢？
運氣好的話，前后端經(jīng)過一番折騰，或許能顯示你期望的內(nèi)容。
但大多數(shù)情況，由于你完全不懂其中的數(shù)據(jù)邏輯和細節(jié)，所以只要面上過得去沒有明顯 BUG，你可能就草草驗收了事，或者驗收時出錯，你連問題在哪排查都不知道。
我說的這種情況，其實只是最基礎、簡單的一個表數(shù)據(jù)出錯。
可以想象更復雜的財務賬單數(shù)據(jù)，要是數(shù)據(jù)能對上的話，那應該是平時有燒香拜佛、買中彩票了吧。
一圖勝千言，能用圖表的盡量圖表呈現(xiàn)。
比如某些復雜的知識概念，可能需要幾百字才能闡述清楚，如果通過圖片、表格進行呈現(xiàn)，或許看的人幾分鐘就完全明白了。
我記得剛做產(chǎn)品時，就遇到了對產(chǎn)品新人來說，比較復雜的訂單狀態(tài)定義，當時嘗試了文字描述，我寫的麻煩、耗時不說，看得人也非常費勁。
后來學會了 UML，用幾分鐘畫個簡單的狀態(tài)圖直接搞定，清晰直觀。
沒有經(jīng)過優(yōu)化加工的內(nèi)容，可以說只是一堆無序、混亂的信息。
要讓這些信息變成通俗易懂、持續(xù)復用的知識，你需要把它們進行總結(jié)提煉，并找出內(nèi)容的差異和共性，然后抽象出維度屬性。
最后將信息按維度，進行整理歸納、分門別類，這個思考過程可以稱為維度提煉。
脫不花老師在《溝通的方法》中，分享過一個職場的傾聽方法，叫結(jié)構(gòu)化傾聽。
即把溝通中的話題，提煉成了情緒、事實和期待等 3 個維度。
概念封裝，核心是將內(nèi)容進行壓縮和簡化，提升內(nèi)容的復用率。
具體指的是用一個簡單的概念，去表示一系列關聯(lián)度較高、重復使用的復雜內(nèi)容。
概念封裝的好處是，一次定義，持續(xù)復用。
像我的需求文檔模版中，常用的全局說明、名詞解釋、公式復用、參數(shù)說明、公共組件、交互解耦等文檔模塊，就是概念封裝的一些使用場景。
如何才能快速提升文檔的溝通效率？其實核心在于，呈現(xiàn)領域知識。
簡單來說，就是當面對不同的讀者時，你要針對性地呈現(xiàn)專業(yè)內(nèi)容。
公司的老板時間都很寶貴，所以你要在一兩分鐘內(nèi)，就讓他快速 Get 到文檔重點。這時候內(nèi)容就要側(cè)重于簡潔，大白話講清楚文檔的核心概念。
如果是針對業(yè)務方，一方面你要表達得簡單易懂，另一方面又要呈現(xiàn)專業(yè)的業(yè)務知識，重點是快速達成雙方共識。
當面對前后端團隊時，你還要基于開發(fā)視角和技術(shù)知識，撰寫便于他們理解的文檔。
內(nèi)容不限于寫清楚數(shù)據(jù)處理、異常分支等復雜的規(guī)則交互等。
很多初級產(chǎn)品經(jīng)理一定會遇到這種情況，自己花一小時寫了一堆洋洋灑灑的文檔說明，開發(fā)居然一個字都不看。
其實這是因為文檔呈現(xiàn)的內(nèi)容，并不是開發(fā)通用語言，理解起來太費勁了。
更好的做法是，找到類似 UML 這種統(tǒng)一建模語言，畫幾個狀態(tài)圖、流程圖來呈現(xiàn)你的需求，既專業(yè)又高效。
產(chǎn)品經(jīng)理在日常工作中，如何才能讓撰寫的需求文檔，顯得既清晰、又專業(yè)？
核心在于做好這 9 點：顏色對比、大小差異、形狀區(qū)分、符號標記、避免歧義、圖表呈現(xiàn)、維度提煉、概念封裝、領域知識。
本文為作者獨立觀點，不代表鳥哥筆記立場，未經(jīng)允許不得轉(zhuǎn)載。
《鳥哥筆記版權(quán)及免責申明》 如對文章、圖片、字體等版權(quán)有疑問，請點擊 反饋舉報
我們致力于提供一個高質(zhì)量內(nèi)容的交流平臺。為落實國家互聯(lián)網(wǎng)信息辦公室“依法管網(wǎng)、依法辦網(wǎng)、依法上網(wǎng)”的要求，為完善跟帖評論自律管理，為了保護用戶創(chuàng)造的內(nèi)容、維護開放、真實、專業(yè)的平臺氛圍，我們團隊將依據(jù)本公約中的條款對注冊用戶和發(fā)布在本平臺的內(nèi)容進行管理。平臺鼓勵用戶創(chuàng)作、發(fā)布優(yōu)質(zhì)內(nèi)容，同時也將采取必要措施管理違法、侵權(quán)或有其他不良影響的網(wǎng)絡信息。
一、根據(jù)《網(wǎng)絡信息內(nèi)容生態(tài)治理規(guī)定》《中華人民共和國未成年人保護法》等法律法規(guī)，對以下違法、不良信息或存在危害的行為進行處理。
1. 違反法律法規(guī)的信息，主要表現(xiàn)為：
1)反對憲法所確定的基本原則；
2)危害國家安全，泄露國家秘密，顛覆國家政權(quán)，破壞國家統(tǒng)一，損害國家榮譽和利益；
3)侮辱、濫用英烈形象，歪曲、丑化、褻瀆、否定英雄烈士事跡和精神，以侮辱、誹謗或者其他方式侵害英雄烈士的姓名、肖像、名譽、榮譽；
4)宣揚恐怖主義、極端主義或者煽動實施恐怖活動、極端主義活動；
5)煽動民族仇恨、民族歧視，破壞民族團結(jié)；
6)破壞國家宗教政策，宣揚邪教和封建迷信；
7)散布謠言，擾亂社會秩序，破壞社會穩(wěn)定；
8)宣揚淫穢、色情、賭博、暴力、兇殺、恐怖或者教唆犯罪；
9)煽動非法集會、結(jié)社、游行、示威、聚眾擾亂社會秩序；
10)侮辱或者誹謗他人，侵害他人名譽、隱私和其他合法權(quán)益；
11)通過網(wǎng)絡以文字、圖片、音視頻等形式，對未成年人實施侮辱、誹謗、威脅或者惡意損害未成年人形象進行網(wǎng)絡欺凌的；
12)危害未成年人身心健康的；
13)含有法律、行政法規(guī)禁止的其他內(nèi)容；
2. 不友善：不尊重用戶及其所貢獻內(nèi)容的信息或行為。主要表現(xiàn)為：
1)輕蔑：貶低、輕視他人及其勞動成果；
2)誹謗：捏造、散布虛假事實，損害他人名譽；
3)嘲諷：以比喻、夸張、侮辱性的手法對他人或其行為進行揭露或描述，以此來激怒他人；
4)挑釁：以不友好的方式激怒他人，意圖使對方對自己的言論作出回應，蓄意制造事端；
5)羞辱：貶低他人的能力、行為、生理或身份特征，讓對方難堪；
6)謾罵：以不文明的語言對他人進行負面評價；
7)歧視：煽動人群歧視、地域歧視等，針對他人的民族、種族、宗教、性取向、性別、年齡、地域、生理特征等身份或者歸類的攻擊；
8)威脅：許諾以不良的后果來迫使他人服從自己的意志；
3. 發(fā)布垃圾廣告信息：以推廣曝光為目的，發(fā)布影響用戶體驗、擾亂本網(wǎng)站秩序的內(nèi)容，或進行相關行為。主要表現(xiàn)為：
1)多次發(fā)布包含售賣產(chǎn)品、提供服務、宣傳推廣內(nèi)容的垃圾廣告。包括但不限于以下幾種形式：
2)單個帳號多次發(fā)布包含垃圾廣告的內(nèi)容；
3)多個廣告帳號互相配合發(fā)布、傳播包含垃圾廣告的內(nèi)容；
4)多次發(fā)布包含欺騙性外鏈的內(nèi)容，如未注明的淘寶客鏈接、跳轉(zhuǎn)網(wǎng)站等，誘騙用戶點擊鏈接
5)發(fā)布大量包含推廣鏈接、產(chǎn)品、品牌等內(nèi)容獲取搜索引擎中的不正當曝光；
6)購買或出售帳號之間虛假地互動，發(fā)布干擾網(wǎng)站秩序的推廣內(nèi)容及相關交易。
7)發(fā)布包含欺騙性的惡意營銷內(nèi)容，如通過偽造經(jīng)歷、冒充他人等方式進行惡意營銷；
8)使用特殊符號、圖片等方式規(guī)避垃圾廣告內(nèi)容審核的廣告內(nèi)容。
4. 色情低俗信息，主要表現(xiàn)為：
1)包含自己或他人性經(jīng)驗的細節(jié)描述或露骨的感受描述；
2)涉及色情段子、兩性笑話的低俗內(nèi)容；
3)配圖、頭圖中包含庸俗或挑逗性圖片的內(nèi)容；
4)帶有性暗示、性挑逗等易使人產(chǎn)生性聯(lián)想；
5)展現(xiàn)血腥、驚悚、殘忍等致人身心不適；
6)炒作緋聞、丑聞、劣跡等；
7)宣揚低俗、庸俗、媚俗內(nèi)容。
5. 不實信息，主要表現(xiàn)為：
1)可能存在事實性錯誤或者造謠等內(nèi)容；
2)存在事實夸大、偽造虛假經(jīng)歷等誤導他人的內(nèi)容；
3)偽造身份、冒充他人，通過頭像、用戶名等個人信息暗示自己具有特定身份，或與特定機構(gòu)或個人存在關聯(lián)。
6. 傳播封建迷信，主要表現(xiàn)為：
1)找人算命、測字、占卜、解夢、化解厄運、使用迷信方式治?。?br /> 2)求推薦算命看相大師；
3)針對具體風水等問題進行求助或咨詢；
4)問自己或他人的八字、六爻、星盤、手相、面相、五行缺失，包括通過占卜方法問婚姻、前程、運勢，東西寵物丟了能不能找回、取名改名等；
7. 文章標題黨，主要表現(xiàn)為：
1)以各種夸張、獵奇、不合常理的表現(xiàn)手法等行為來誘導用戶；
2)內(nèi)容與標題之間存在嚴重不實或者原意扭曲；
3)使用夸張標題，內(nèi)容與標題嚴重不符的。
8.「飯圈」亂象行為，主要表現(xiàn)為：
1)誘導未成年人應援集資、高額消費、投票打榜
2)粉絲互撕謾罵、拉踩引戰(zhàn)、造謠攻擊、人肉搜索、侵犯隱私
3)鼓動「飯圈」粉絲攀比炫富、奢靡享樂等行為
4)以號召粉絲、雇用網(wǎng)絡水軍、「養(yǎng)號」形式刷量控評等行為
5)通過「蹭熱點」、制造話題等形式干擾輿論，影響傳播秩序
9. 其他危害行為或內(nèi)容，主要表現(xiàn)為：
1)可能引發(fā)未成年人模仿不安全行為和違反社會公德行為、誘導未成年人不良嗜好影響未成年人身心健康的；
2)不當評述自然災害、重大事故等災難的；
3)美化、粉飾侵略戰(zhàn)爭行為的；
4)法律、行政法規(guī)禁止，或可能對網(wǎng)絡生態(tài)造成不良影響的其他內(nèi)容。
二、違規(guī)處罰
本網(wǎng)站通過主動發(fā)現(xiàn)和接受用戶舉報兩種方式收集違規(guī)行為信息。所有有意的降低內(nèi)容質(zhì)量、傷害平臺氛圍及欺凌未成年人或危害未成年人身心健康的行為都是不能容忍的。
當一個用戶發(fā)布違規(guī)內(nèi)容時，本網(wǎng)站將依據(jù)相關用戶違規(guī)情節(jié)嚴重程度，對帳號進行禁言 1 天、7 天、15 天直至永久禁言或封停賬號的處罰。當涉及欺凌未成年人、危害未成年人身心健康、通過作弊手段注冊、使用帳號，或者濫用多個帳號發(fā)布違規(guī)內(nèi)容時，本網(wǎng)站將加重處罰。
三、申訴
隨著平臺管理經(jīng)驗的不斷豐富，本網(wǎng)站出于維護本網(wǎng)站氛圍和秩序的目的，將不斷完善本公約。
如果本網(wǎng)站用戶對本網(wǎng)站基于本公約規(guī)定做出的處理有異議，可以通過「建議反饋」功能向本網(wǎng)站進行反饋。
(規(guī)則的最終解釋權(quán)歸屬本網(wǎng)站所有)