因為工作中寫最多的就是后臺產(chǎn)品的需求用例，所以先整理了這份文檔模板，在往后的文章中會陸續(xù)總結(jié)PRD中其他部分的模板。

1. 文檔模板背景介紹

• 需求用例：我團(tuán)隊把一個需求（可理解為功能矩陣中的一行）的詳細(xì)描述、頁面、交互、數(shù)據(jù)項、基本流程這些能盡可能多描述地需求細(xì)節(jié)的內(nèi)容稱為一個需求用例。
• 閱讀者：需求開發(fā)者、需求測試人
• 工具：Confluence（+JIRA）

我團(tuán)隊寫文檔都是使用Confluence（一款在線文檔協(xié)作軟件，企業(yè)Wiki），結(jié)合同系列的JIRA進(jìn)行項目管理，好用到飛起。

需求用例都是盡我所能寫得詳細(xì)，并且結(jié)合程序員們的反饋，不斷迭代。所以我的模板是最適合我團(tuán)隊和業(yè)務(wù)的，并不是普世的，我提倡每個人都輸出自己的文檔模板。

這一版模板完成后大大提升了我的寫作效率，一個簡單的增刪改查需求，使用模板約30分鐘能完成。

希望這個模板能拋磚引玉，為你的模板提供一點思路。

2. 需求用例屬性

這一模塊代表了需求用例的基本屬性，尤其是文檔的狀態(tài)，在線協(xié)作時能提示開發(fā)和測試這個文檔進(jìn)行到哪一步了，流程需要團(tuán)隊內(nèi)部達(dá)成一致。

可使用表格規(guī)范需求用例屬性，方便查閱。

暫時為空的項，填寫“暫無”。

3. 文檔正文

后臺產(chǎn)品的需求用例，我把正文分成關(guān)聯(lián)、描述、VI&UI、數(shù)據(jù)項和流程等幾個部分。實際應(yīng)用后發(fā)現(xiàn)這是比較合理的方式，能最大程度上讓開發(fā)者根據(jù)不同時期的不同需要去理解需求。

例如在評審會時，大家只需要看用例描述和VI部分就能對需求有大致了解；計劃會時主要講解描述、VI&UI和流程部分；開發(fā)者實際開發(fā)時會著重看VI&UI和數(shù)據(jù)項部分。

我寫需求文檔有幾大準(zhǔn)則，是需要時刻銘記和實踐的：

• 字不如表，表不如圖；
• 使用最少的字去描述，多利用各種符號；
• 排版要舒適，不能反人類；
• 盡量無歧義、準(zhǔn)確、全面。

3.1 關(guān)聯(lián)用例

使用插入超鏈接快捷鍵” [ ”，關(guān)聯(lián)該需求用例的關(guān)聯(lián)用例。

3.1.1 前置用例

該需求的前置需求，可進(jìn)行適當(dāng)文字描述。

3.1.2 前版用例

若用例為優(yōu)化或升級，則需鏈接該需求的前一版本的用例，可進(jìn)行適當(dāng)文字描述。

3.1.3 相關(guān)用例

用例對其他用例有影響時，需關(guān)聯(lián)，如后臺需求用例會和前端需求用例聯(lián)系，可進(jìn)行適當(dāng)文字描述。

3.1.4 前臺用例

該需求用例功能所需要支持的前臺功能。如一個廣告Banner的增刪改查功能，對應(yīng)前臺的Banner用例。

3.2 用例詳細(xì)描述

3.2.1 需求目的

實現(xiàn)需求的目的，和需求設(shè)計的目的，1…2…3…逐條列出

3.2.2 需求場景

實際場景，可用作圖表示，配合文字描述。

3.2.3 需求流程圖

需求中的業(yè)務(wù)流程圖、狀態(tài)流轉(zhuǎn)、操作流程等流程圖，少量文字描述。

3.2.4 需求規(guī)則

需求中若涉及規(guī)則，則需描述清楚，可配合實例，注意考慮極限情況。

3.3 VI&UI設(shè)計

這部分建議使用“左圖右字”的排版，便于閱讀。（Confluence中有“節(jié)”的設(shè)置，排版非常好用）

3.3.1 P00 頁面名稱

設(shè)置頁面編號和名稱，插入視覺圖，使用數(shù)字標(biāo)注，標(biāo)明交互、初始狀態(tài)數(shù)據(jù)項等內(nèi)容。

每條交互都需要有編號。

使用標(biāo)號和“→”描述交互過程，注意標(biāo)清錯誤提示語；可使用動圖等形式表現(xiàn)稍稍復(fù)雜的交互。

圖片較長時，交互內(nèi)容盡量標(biāo)注在圖中對應(yīng)位置旁邊。

3.3.2 交互

UC000.1：“P00 頁面名稱” 初始狀態(tài)（常見舉例）

描述該頁面初始進(jìn)入時的樣子。不同業(yè)務(wù)頁面的初始狀態(tài)不同，但很多情況下可以復(fù)用。以下就是我經(jīng)常使用的初始狀態(tài)描述：

列表頁面：

1. 各查詢項為空，展示占位文本；
2. 后臺分頁；
3. 默認(rèn)每頁顯示10項結(jié)果；
4. 列表中可查看所有該登錄賬戶有權(quán)限查看的數(shù)據(jù)；
5. 默認(rèn)按更新時間排序。

新增頁面：

1. 各輸入項為空，展示占位文本；
2. 默認(rèn)選擇….

修改頁面：本條數(shù)據(jù)上次成功保存內(nèi)容。

數(shù)據(jù)頁面：

1. 展示當(dāng)前實時數(shù)據(jù)；
2. 默認(rèn)展示最近7天數(shù)據(jù)趨勢圖。

UC000.2：…

UC000.3：…

3.4 數(shù)據(jù)項

使用列表標(biāo)明涉及頁面中的數(shù)據(jù)項

3.4.1 輸入項

需要用戶輸入的數(shù)據(jù)項，例如篩選、新建時的輸入項

• 每個輸入項需要考慮：
• 字段名稱（簡潔、易于理解，注意與概念相似字段進(jìn)行區(qū)分）
• 是否必填（填寫與否有何影響？）
• 使用組件（從規(guī)定的組件庫中選取，適當(dāng)描述組件性質(zhì)）
• 占位文本（Input字段，輸入框中的占位文字，提示用戶可輸入的內(nèi)容）
• 數(shù)據(jù)來源（可選選項的來源）
• 權(quán)限限制（用戶權(quán)限對本字段有無影響？）
• 字段單位
• 字段類型（整數(shù)、小數(shù)、字母、符號等）
• 字段長度（≤？漢字）
• 字段范圍（數(shù)值范圍，可否為0？最大為？小數(shù)是否自動補(bǔ)齊？）
• 數(shù)據(jù)格式
• 搜索特點（模糊搜索）
• 可選選項（1- …；2-…）
• 解釋說明（是否需要文字提示用戶字段含義或用法）
• 極限情況（初始狀態(tài)、極限狀態(tài)）
• 可否重復(fù)（能否與其他條目的同一字段重復(fù)）
• 可否修改（修改后對本條數(shù)據(jù)、或其他系統(tǒng)的數(shù)據(jù)的影響、對客戶端的影響；什么時候可以修改）
• 是否聯(lián)動（與其他數(shù)據(jù)、與其他系統(tǒng)、與客戶端）
• 是否排序（排序規(guī)則）
• 展示預(yù)覽（為空時；輸入時；輸入完；查看時；列表中；客戶端；極限時）
• 只讀字段（不同情況下怎么展示只讀）
• 錯誤提示（為空或不滿足約束條件時的提示語，提示方式）
• 備注說明

約束條件需要結(jié)合業(yè)務(wù)，在每次的文檔寫作中不斷積累和總結(jié)。

3.4.2 展示/列表項

用戶在列表中查看或展示給用戶，不能進(jìn)行操作的數(shù)據(jù)項

每個展示項需要考慮：

• 字段名稱
• 字段來源（新建、其他系統(tǒng)）
• 初始狀態(tài)（列表、預(yù)覽、數(shù)據(jù)報表…）
• 分頁類型（前臺or后臺，默認(rèn)一頁幾條數(shù)據(jù)）
• 無數(shù)據(jù)時（如何展示？）
• 展示樣式（多種情況：為空時、多個值、很長時）
• 排序規(guī)則
• 備注說明

3.5 用例流程（基本流、備選流、異常流）

主要寫清流程描述，因為“3.2.3 需求流程圖”中已有流程圖，這一部分可以省略。

同樣，每個流程都需要編號，寫清前置、描述和預(yù)期結(jié)果。尤其是異常流，需要和開發(fā)、測試多進(jìn)行討論和溝通。

3.5.1 基本流

【UC000-A】

• 前置條件：
• 流程描述：
• 預(yù)期結(jié)果：

3.5.2 備選流

【UC000-B】

• 前置條件：
• 流程描述：
• 預(yù)期結(jié)果：

3.5.3 異常流

【UC000-C】網(wǎng)絡(luò)異常

Massage（1s）錯誤提示：網(wǎng)絡(luò)異常，請稍后重試。

【UC000-D】輸入時不滿足約束（輸入后即能直接判斷）

控件下方錯誤提示，提示語詳見 4.數(shù)據(jù)項 中的 “約束條件” 一列。

【UC000-E】保存失敗

Massage（1s）錯誤提示：保存失敗，請稍后重試。繼續(xù)留在本頁。

..

3.6 名詞說明

用例中關(guān)于一些業(yè)務(wù)名詞的定義與說明。

3.7 測試方案

使用超鏈接關(guān)聯(lián)測試文檔，方便查看。

3.8 文檔版本

這里我使用的是Confluence的一個文檔版本插件，可以查看文檔不同版本之間的差異，但是和文檔狀態(tài)沒能關(guān)聯(lián)起來看，所以用的不多，但是對于查看文檔修改和修改內(nèi)容還是很好用的。

本文由 @ZoeSunPM 原創(chuàng)發(fā)布于人人都是產(chǎn)品經(jīng)理。未經(jīng)許可，禁止轉(zhuǎn)載。

題圖來自unsplash，基于CC0協(xié)議