文檔模板分享:后臺(tái)產(chǎn)品需求用例
因?yàn)楣ぷ髦袑懽疃嗟木褪呛笈_(tái)產(chǎn)品的需求用例,所以先整理了這份文檔模板,在往后的文章中會(huì)陸續(xù)總結(jié)PRD中其他部分的模板。
1. 文檔模板背景介紹
- 需求用例:我團(tuán)隊(duì)把一個(gè)需求(可理解為功能矩陣中的一行)的詳細(xì)描述、頁面、交互、數(shù)據(jù)項(xiàng)、基本流程這些能盡可能多描述地需求細(xì)節(jié)的內(nèi)容稱為一個(gè)需求用例。
- 閱讀者:需求開發(fā)者、需求測(cè)試人
- 工具:Confluence(+JIRA)
我團(tuán)隊(duì)寫文檔都是使用Confluence(一款在線文檔協(xié)作軟件,企業(yè)Wiki),結(jié)合同系列的JIRA進(jìn)行項(xiàng)目管理,好用到飛起。
需求用例都是盡我所能寫得詳細(xì),并且結(jié)合程序員們的反饋,不斷迭代。所以我的模板是最適合我團(tuán)隊(duì)和業(yè)務(wù)的,并不是普世的,我提倡每個(gè)人都輸出自己的文檔模板。
這一版模板完成后大大提升了我的寫作效率,一個(gè)簡單的增刪改查需求,使用模板約30分鐘能完成。
希望這個(gè)模板能拋磚引玉,為你的模板提供一點(diǎn)思路。
2. 需求用例屬性
這一模塊代表了需求用例的基本屬性,尤其是文檔的狀態(tài),在線協(xié)作時(shí)能提示開發(fā)和測(cè)試這個(gè)文檔進(jìn)行到哪一步了,流程需要團(tuán)隊(duì)內(nèi)部達(dá)成一致。
可使用表格規(guī)范需求用例屬性,方便查閱。
暫時(shí)為空的項(xiàng),填寫“暫無”。
3. 文檔正文
后臺(tái)產(chǎn)品的需求用例,我把正文分成關(guān)聯(lián)、描述、VI&UI、數(shù)據(jù)項(xiàng)和流程等幾個(gè)部分。實(shí)際應(yīng)用后發(fā)現(xiàn)這是比較合理的方式,能最大程度上讓開發(fā)者根據(jù)不同時(shí)期的不同需要去理解需求。
例如在評(píng)審會(huì)時(shí),大家只需要看用例描述和VI部分就能對(duì)需求有大致了解;計(jì)劃會(huì)時(shí)主要講解描述、VI&UI和流程部分;開發(fā)者實(shí)際開發(fā)時(shí)會(huì)著重看VI&UI和數(shù)據(jù)項(xiàng)部分。
我寫需求文檔有幾大準(zhǔn)則,是需要時(shí)刻銘記和實(shí)踐的:
- 字不如表,表不如圖;
- 使用最少的字去描述,多利用各種符號(hào);
- 排版要舒適,不能反人類;
- 盡量無歧義、準(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í),則需鏈接該需求的前一版本的用例,可進(jìn)行適當(dāng)文字描述。
3.1.3 相關(guān)用例
用例對(duì)其他用例有影響時(shí),需關(guān)聯(lián),如后臺(tái)需求用例會(huì)和前端需求用例聯(lián)系,可進(jìn)行適當(dāng)文字描述。
3.1.4 前臺(tái)用例
該需求用例功能所需要支持的前臺(tái)功能。如一個(gè)廣告Banner的增刪改查功能,對(duì)應(yīng)前臺(tái)的Banner用例。
3.2 用例詳細(xì)描述
3.2.1 需求目的
實(shí)現(xiàn)需求的目的,和需求設(shè)計(jì)的目的,1…2…3…逐條列出
3.2.2 需求場(chǎng)景
實(shí)際場(chǎng)景,可用作圖表示,配合文字描述。
3.2.3 需求流程圖
需求中的業(yè)務(wù)流程圖、狀態(tài)流轉(zhuǎn)、操作流程等流程圖,少量文字描述。
3.2.4 需求規(guī)則
需求中若涉及規(guī)則,則需描述清楚,可配合實(shí)例,注意考慮極限情況。
3.3 VI&UI設(shè)計(jì)
這部分建議使用“左圖右字”的排版,便于閱讀。(Confluence中有“節(jié)”的設(shè)置,排版非常好用)
3.3.1 P00 頁面名稱
設(shè)置頁面編號(hào)和名稱,插入視覺圖,使用數(shù)字標(biāo)注,標(biāo)明交互、初始狀態(tài)數(shù)據(jù)項(xiàng)等內(nèi)容。
每條交互都需要有編號(hào)。
使用標(biāo)號(hào)和“→”描述交互過程,注意標(biāo)清錯(cuò)誤提示語;可使用動(dòng)圖等形式表現(xiàn)稍稍復(fù)雜的交互。
圖片較長時(shí),交互內(nèi)容盡量標(biāo)注在圖中對(duì)應(yīng)位置旁邊。
3.3.2 交互
UC000.1:“P00 頁面名稱” 初始狀態(tài)(常見舉例)
描述該頁面初始進(jìn)入時(shí)的樣子。不同業(yè)務(wù)頁面的初始狀態(tài)不同,但很多情況下可以復(fù)用。以下就是我經(jīng)常使用的初始狀態(tài)描述:
列表頁面:
- 各查詢項(xiàng)為空,展示占位文本;
- 后臺(tái)分頁;
- 默認(rèn)每頁顯示10項(xiàng)結(jié)果;
- 列表中可查看所有該登錄賬戶有權(quán)限查看的數(shù)據(jù);
- 默認(rèn)按更新時(shí)間排序。
新增頁面:
- 各輸入項(xiàng)為空,展示占位文本;
- 默認(rèn)選擇….
修改頁面:本條數(shù)據(jù)上次成功保存內(nèi)容。
數(shù)據(jù)頁面:
- 展示當(dāng)前實(shí)時(shí)數(shù)據(jù);
- 默認(rèn)展示最近7天數(shù)據(jù)趨勢(shì)圖。
UC000.2:…
UC000.3:…
3.4 數(shù)據(jù)項(xiàng)
使用列表標(biāo)明涉及頁面中的數(shù)據(jù)項(xiàng)
3.4.1 輸入項(xiàng)
需要用戶輸入的數(shù)據(jù)項(xiàng),例如篩選、新建時(shí)的輸入項(xiàng)
- 每個(gè)輸入項(xiàng)需要考慮:
- 字段名稱(簡潔、易于理解,注意與概念相似字段進(jìn)行區(qū)分)
- 是否必填(填寫與否有何影響?)
- 使用組件(從規(guī)定的組件庫中選取,適當(dāng)描述組件性質(zhì))
- 占位文本(Input字段,輸入框中的占位文字,提示用戶可輸入的內(nèi)容)
- 數(shù)據(jù)來源(可選選項(xiàng)的來源)
- 權(quán)限限制(用戶權(quán)限對(duì)本字段有無影響?)
- 字段單位
- 字段類型(整數(shù)、小數(shù)、字母、符號(hào)等)
- 字段長度(≤?漢字)
- 字段范圍(數(shù)值范圍,可否為0?最大為?小數(shù)是否自動(dòng)補(bǔ)齊?)
- 數(shù)據(jù)格式
- 搜索特點(diǎn)(模糊搜索)
- 可選選項(xiàng)(1- …;2-…)
- 解釋說明(是否需要文字提示用戶字段含義或用法)
- 極限情況(初始狀態(tài)、極限狀態(tài))
- 可否重復(fù)(能否與其他條目的同一字段重復(fù))
- 可否修改(修改后對(duì)本條數(shù)據(jù)、或其他系統(tǒng)的數(shù)據(jù)的影響、對(duì)客戶端的影響;什么時(shí)候可以修改)
- 是否聯(lián)動(dòng)(與其他數(shù)據(jù)、與其他系統(tǒng)、與客戶端)
- 是否排序(排序規(guī)則)
- 展示預(yù)覽(為空時(shí);輸入時(shí);輸入完;查看時(shí);列表中;客戶端;極限時(shí))
- 只讀字段(不同情況下怎么展示只讀)
- 錯(cuò)誤提示(為空或不滿足約束條件時(shí)的提示語,提示方式)
- 備注說明
約束條件需要結(jié)合業(yè)務(wù),在每次的文檔寫作中不斷積累和總結(jié)。
3.4.2 展示/列表項(xiàng)
用戶在列表中查看或展示給用戶,不能進(jìn)行操作的數(shù)據(jù)項(xiàng)
每個(gè)展示項(xiàng)需要考慮:
- 字段名稱
- 字段來源(新建、其他系統(tǒng))
- 初始狀態(tài)(列表、預(yù)覽、數(shù)據(jù)報(bào)表…)
- 分頁類型(前臺(tái)or后臺(tái),默認(rèn)一頁幾條數(shù)據(jù))
- 無數(shù)據(jù)時(shí)(如何展示?)
- 展示樣式(多種情況:為空時(shí)、多個(gè)值、很長時(shí))
- 排序規(guī)則
- 備注說明
3.5 用例流程(基本流、備選流、異常流)
主要寫清流程描述,因?yàn)椤?.2.3 需求流程圖”中已有流程圖,這一部分可以省略。
同樣,每個(gè)流程都需要編號(hào),寫清前置、描述和預(yù)期結(jié)果。尤其是異常流,需要和開發(fā)、測(cè)試多進(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)錯(cuò)誤提示:網(wǎng)絡(luò)異常,請(qǐng)稍后重試。
【UC000-D】輸入時(shí)不滿足約束(輸入后即能直接判斷)
控件下方錯(cuò)誤提示,提示語詳見 4.數(shù)據(jù)項(xiàng) 中的 “約束條件” 一列。
【UC000-E】保存失敗
Massage(1s)錯(cuò)誤提示:保存失敗,請(qǐng)稍后重試。繼續(xù)留在本頁。
..
3.6 名詞說明
用例中關(guān)于一些業(yè)務(wù)名詞的定義與說明。
3.7 測(cè)試方案
使用超鏈接關(guān)聯(lián)測(cè)試文檔,方便查看。
3.8 文檔版本
這里我使用的是Confluence的一個(gè)文檔版本插件,可以查看文檔不同版本之間的差異,但是和文檔狀態(tài)沒能關(guān)聯(lián)起來看,所以用的不多,但是對(duì)于查看文檔修改和修改內(nèi)容還是很好用的。
本文由 @ZoeSunPM 原創(chuàng)發(fā)布于人人都是產(chǎn)品經(jīng)理。未經(jīng)許可,禁止轉(zhuǎn)載。
題圖來自u(píng)nsplash,基于CC0協(xié)議
一套下來,時(shí)間已經(jīng)過去大半了吧?
感謝作者,已三連,能出一篇測(cè)試文檔中具體會(huì)包含哪些框架和元素嗎?
兩篇文章都挺不錯(cuò)的,怎么不更新了呢,跳槽了?
你是技術(shù)轉(zhuǎn)做產(chǎn)品的嗎?
不是哦~之前是念的工科
有些內(nèi)容還是不錯(cuò)的,平時(shí)都有積累。值得學(xué)習(xí)。
一起進(jìn)步~
寫后臺(tái)用例文檔時(shí)更多應(yīng)該注意的是什么?
“3.3.1 P00 頁面名稱
設(shè)置頁面編號(hào)和名稱,插入視覺圖,使用數(shù)字標(biāo)注,標(biāo)明交互、初始狀態(tài)數(shù)據(jù)項(xiàng)等內(nèi)容。”
此處描述沒有圖示很難理解,因?yàn)閮H靠文字,腦補(bǔ)畫面不容易將全部描述項(xiàng)呈現(xiàn)出來,怕會(huì)有缺失。
不介意的話,舉個(gè)圖例把,謝謝
上方的圖就是示例,因?yàn)槭悄0謇锏乃圆粔蛑庇^~下篇文章注意,感謝閱讀~
用例和需求文檔有什么區(qū)別嗎
我理解用例是需求文檔的一部分,可能會(huì)把一個(gè)簡單的增刪改查功能的需求文檔拿出來作為一個(gè)用例。
希望對(duì)你有啟發(fā),大家看完多吐槽哦~
請(qǐng)問有文檔文件嗎
文檔模板內(nèi)容其實(shí)和文章里一樣,工作實(shí)際寫的文檔可能不方便分享哦~
可以看一些實(shí)際的文檔案例嗎?后臺(tái)能找的參考實(shí)在是太少了呢