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