需求文檔如何做好規(guī)范?

“需求文檔能力是產(chǎn)品的半條腿?！?/span>

需求文檔是基本功，但想真正寫好需求文檔卻沒(méi)那么容易。先說(shuō)說(shuō)我的經(jīng)歷也不怕大家笑話，以前我寫文檔產(chǎn)研同學(xué)會(huì)吐槽：字怎么寫這么少、你真是惜字如金...，到后來(lái)產(chǎn)研同學(xué)說(shuō)：你這是寫作文啊，幾千字我怎么看。

這說(shuō)明要想寫好需求文檔不在于字?jǐn)?shù)多少，而是要做好規(guī)范，通俗易懂，不同的需求要用更合適的表現(xiàn)形式，當(dāng)產(chǎn)研同學(xué)說(shuō)你寫的需求文檔很容易看懂。表?yè)P(yáng)你時(shí)，這時(shí)候的文檔規(guī)范才達(dá)標(biāo)。

顏色標(biāo)識(shí) 要想規(guī)范需求文檔，首先得有顏色標(biāo)識(shí) ，主要作用是讓產(chǎn)研同學(xué)對(duì)標(biāo)識(shí)文檔內(nèi)容的類型和重要程度有共同認(rèn)知。字體顏色可結(jié)合自身團(tuán)隊(duì)定義。比如：
- 新增內(nèi)容
黑色：代表本期需求 灰色：代表原有需求 紅色：代表重點(diǎn)需求 - 修訂內(nèi)容
藍(lán)色：代表第一次修訂需求 紫色：代表第二次及以上的修訂
修訂記錄 每個(gè)版本都需要有修訂記錄 ，主要作用是記錄每個(gè)版本的需求內(nèi)容及修訂內(nèi)容，方便快速定位，口說(shuō)無(wú)憑，記錄到文檔里才是最有依據(jù)的。一般記錄字段為：版本號(hào)、需求內(nèi)容、更新時(shí)間、修訂人等。

版本號(hào)	需求內(nèi)容	更新時(shí)間	修訂人
V1.0.0	1、XXX 2、XXX 3、XXX	2022-10-23	王大力

樣式規(guī)范 統(tǒng)一頁(yè)面樣式 左圖右字，左側(cè)原型寬度不大于1024，右側(cè)文字說(shuō)明寬度不大于500，不至于看一個(gè)頁(yè)面需要左滑右滑上滑下滑到處找地方。 頁(yè)面文案，后綴可帶上（新增）（優(yōu)化）等，便于了解業(yè)務(wù)。 原型說(shuō)明，通過(guò)數(shù)字標(biāo)簽、連接線等，便于快速定位位置。
統(tǒng)一說(shuō)明樣式，4大原則：對(duì)比、重復(fù)、對(duì)齊、親密性 對(duì)比（Contrast） 一個(gè)目的是增強(qiáng)頁(yè)面的效果，另一個(gè)目的是有助于信息的組織?？梢酝ㄟ^(guò)字體選擇，線寬、顏色、形狀、大小、空間等來(lái)增加對(duì)比。 重復(fù)（Repetition） 重復(fù)的目的就是統(tǒng)一，并增強(qiáng)視覺(jué)效果。重復(fù)可以認(rèn)為是保持一致性，把現(xiàn)有的一致性更向前推進(jìn)一步，專門做成一個(gè)母版或表格或組件。
對(duì)齊（Alignment） 對(duì)齊的根本目的是使頁(yè)面統(tǒng)一且有條理。要特別注意元素放在哪里。頁(yè)面上對(duì)齊的元素，原型、文案說(shuō)明等都需要對(duì)齊。比如：首行縮進(jìn)、字間距、行高、頁(yè)面元素、大小對(duì)齊。 親密性（Proximity） 親密性的目的是實(shí)現(xiàn)組織性。這樣更易閱讀、更易被記住。當(dāng)頁(yè)面上項(xiàng)超過(guò)3~5個(gè)，就要考慮哪些元素更加親密，使之成為一個(gè)視覺(jué)單元。 需求說(shuō)明

文字說(shuō)明 ，多用于說(shuō)明表單控件等

一般說(shuō)明包含：表單類型、字段類型、是否必填、長(zhǎng)度規(guī)則、格式規(guī)則、校驗(yàn)規(guī)則（為空校驗(yàn)、格式校驗(yàn)、唯一性校驗(yàn)）、數(shù)據(jù)說(shuō)明（數(shù)據(jù)來(lái)源、數(shù)據(jù)范圍）、排序方式、展示效果、交互邏輯、影響范圍等。

表格說(shuō)明 ，多用于統(tǒng)計(jì)體系、狀態(tài)機(jī)、公共屬性、導(dǎo)入、導(dǎo)出等

統(tǒng)計(jì)類需要定義好名詞、指標(biāo)、維度、表報(bào)等。 狀態(tài)機(jī)一般定義好就不會(huì)輕易改變，后面需求會(huì)經(jīng)常復(fù)用，一般有：編號(hào)、狀態(tài)名稱、狀態(tài)屬性等。 公共屬性則是一些公共的功能、組件等，便于各入口復(fù)用。一般有：模塊、頁(yè)面、導(dǎo)出、站內(nèi)信、搜索查詢、列表排序、刪除處理等。 導(dǎo)入說(shuō)明校驗(yàn)類型：必填校驗(yàn)、格式校驗(yàn)、字典校驗(yàn)、唯一校驗(yàn)、聯(lián)合校驗(yàn)等。
導(dǎo)出說(shuō)明，需要定義清楚導(dǎo)出類型（同步、異步），導(dǎo)出名稱、導(dǎo)出數(shù)量、導(dǎo)出字段、導(dǎo)出驗(yàn)證、導(dǎo)出記錄、自定義導(dǎo)出、導(dǎo)出模版等。 非功能需求說(shuō)明 ，多用于埋點(diǎn)等，埋點(diǎn)一般需要定義數(shù)據(jù)：時(shí)間范圍、地區(qū)、日期、事件名（PV、元素點(diǎn)擊量、耗時(shí)等）、分類（一級(jí)、二級(jí)、三級(jí)）、ID、名稱。 總結(jié) 輸出需求文檔的方式有很多種：全景圖、思維導(dǎo)圖、流程圖、原型、表格、文本等方式。根據(jù)不同的需求類型，找到合適的載體輸出成文檔，這樣一篇規(guī)范的需求文檔就形成了。 后臺(tái)留言“ 元件庫(kù) ” 可免費(fèi)獲取Web端、移動(dòng)端元件庫(kù)~ 好看的人才能點(diǎn)