5、用例文檔(UML用例圖、流程圖)

(五) 用例文檔(UML用例圖、流程圖)

在產(chǎn)品和技術(shù)領(lǐng)域里都有UML的技能知識(shí)，而對(duì)于產(chǎn)品人員的UML則更多的是指用例圖，也就是我所稱呼的用戶流程圖。在講PRD文檔寫作的第二篇文章里，我提到了用戶流程圖的制作，實(shí)際上用戶流程圖是我在產(chǎn)品規(guī)則的初期對(duì)用例圖的一種結(jié)構(gòu)化的表達(dá)方式，由于以結(jié)構(gòu)化的方式描述用例太抽象，缺少邏輯性表達(dá)，并且那篇文章更偏向于功能性用戶流程，還不是實(shí)際意義上的用例，因此今天我補(bǔ)文一篇，細(xì)講一下UML用例圖和用例文檔。

用例文檔是由多個(gè)用例組成的一份文檔，主要用于技術(shù)開發(fā)與測(cè)試使用，他是PRD中的重要輔助文檔，用于講解某個(gè)環(huán)節(jié)的功能邏輯，例如用戶注冊(cè)、活動(dòng)報(bào)名等等功能都是需要用例輔助說明的。用例文檔的寫作時(shí)間在原型設(shè)計(jì)之后，通常和PRD文檔同步撰寫。

用例文檔中有兩個(gè)關(guān)聯(lián)文件，分別是用例圖和流程圖。用例圖是UML的一種類圖表現(xiàn)方式，是從用戶角度描述產(chǎn)品功能，并指出該用戶在產(chǎn)品各功能中的操作權(quán)限。流程圖是通過線框圖形的方式描述產(chǎn)品功能的處理過程，主要是描述功能的執(zhí)行順序、分支和循環(huán)的邏輯。

寫用戶文檔的常用軟件是Word，其中用例圖和流程圖的制作軟件常用的是Visio，當(dāng)然也有用Axure RP軟件制作的，例如下面的第三步流程圖就是用Axure RP制作的。

一份完整的用例文檔分別是由以下三點(diǎn)內(nèi)容組成，其中第3點(diǎn)的“用例”是描述功能邏輯的部分，根據(jù)功能的多少?zèng)Q定有多少個(gè)用例。

用例文檔的大概組成部分如下：
1、修改記錄：每次修改的備注記錄，同PRD文檔。
2、角色介紹：描述參與系統(tǒng)中的各個(gè)角色
3、用例：同下方步驟的第4步，其中第3步中的流程圖是直接插入到第4步的流程圖表格項(xiàng)中的。

用例文檔的模板格式如同以上三點(diǎn)內(nèi)容，通過Word文檔繪制表格，在表格中撰寫用例描述，表格的格式和樣式參考以下示例圖。

1、撰寫用例文檔的第一步是注明使用產(chǎn)品的各個(gè)角色(參與者)和角色說明(角色介紹)。（如下圖）

2、第二步是以用例圖的方式注明角色在前后端的用例關(guān)系。（如下圖）

3、第三步是以流程圖的方式注明角色在各個(gè)功能環(huán)節(jié)的活動(dòng)過程。（如下圖：以活動(dòng)報(bào)名為示例）

4、第四步則是以用例文檔的方式將以上三步整合到一起，并撰寫各個(gè)功能環(huán)節(jié)的用例描述。（如下圖）

表格說明：
4.1、用例名：此功能環(huán)節(jié)的名稱
4.2、用例編號(hào)：在此產(chǎn)品中該用例的編號(hào)
4.3、行為角色：參與或操作(執(zhí)行)該功能的角色
4.4、簡(jiǎn)要說明：用最少的文字描述一下該用例的需求
4.5、前置條件：參與或操作(執(zhí)行)此功能的前提條件
4.6、后置條件：執(zhí)行完畢后的結(jié)果條件
4.7、流程圖：該功能的角色活動(dòng)過程(處理過程)圖（第三步中的圖）

上面示范的用例描述相對(duì)簡(jiǎn)單，也是最常用和基本的用例描述內(nèi)容，當(dāng)然也有稍微復(fù)雜一點(diǎn)的用例文檔，文檔中會(huì)詳細(xì)描述使用場(chǎng)景、事件流和信息字段，也有一些用例文檔還會(huì)插入產(chǎn)品界面效果圖。

使用場(chǎng)景主要描述行為角色在不同情況下使用產(chǎn)品時(shí)，根據(jù)情況或問題給出相應(yīng)的系統(tǒng)反饋。事件流類似流程圖，只不過是通過文字的方式描述角色的活動(dòng)過程。信息字段主要是描述用例中所用到的數(shù)據(jù)字段。

這些更多的描述內(nèi)容取決于個(gè)人的習(xí)慣，最終目的都是為了描述清晰產(chǎn)品邏輯，因此我的原則就是用越少的文字描述清晰越多的需求說明。（畢竟這些文檔是產(chǎn)品開發(fā)中的執(zhí)行文檔，文字不在多，表達(dá)清晰即可。）