## (五) 用例文檔(UML用例圖、流程圖) [](http://image.woshipm.com/wp-files/2014/04/c2cec3fdfc0392450d3c25f78694a4c27c1e25b9.png) 在產品和技術領域里都有UML的技能知識，而對于產品人員的UML則更多的是指用例圖，也就是我所稱呼的用戶流程圖。在講PRD文檔寫作的[第二篇文章](http://www.woshipm.com/?p=80078 "梳理需求(產品結構圖和用戶流程圖)")里，我提到了用戶流程圖的制作，實際上用戶流程圖是我在產品規則的初期對用例圖的一種結構化的表達方式，由于以結構化的方式描述用例太抽象，缺少邏輯性表達，并且那篇文章更偏向于功能性用戶流程，還不是實際意義上的用例，因此今天我補文一篇，細講一下UML用例圖和用例文檔。 用例文檔是由多個用例組成的一份文檔，主要用于技術開發與測試使用，他是PRD中的重要輔助文檔，用于講解某個環節的功能邏輯，例如用戶注冊、活動報名等等功能都是需要用例輔助說明的。用例文檔的寫作時間在原型設計之后，通常和PRD文檔同步撰寫。 用例文檔中有兩個關聯文件，分別是用例圖和流程圖。用例圖是UML的一種類圖表現方式，是從用戶角度描述產品功能，并指出該用戶在產品各功能中的操作權限。流程圖是通過線框圖形的方式描述產品功能的處理過程，主要是描述功能的執行順序、分支和循環的邏輯。 寫用戶文檔的常用軟件是Word，其中用例圖和流程圖的制作軟件常用的是Visio，當然也有用Axure RP軟件制作的，例如下面的第三步流程圖就是用Axure RP制作的。 一份完整的用例文檔分別是由以下三點內容組成，其中第3點的“用例”是描述功能邏輯的部分，根據功能的多少決定有多少個用例。 用例文檔的大概組成部分如下： 1、修改記錄：每次修改的備注記錄，同PRD文檔。 2、角色介紹：描述參與系統中的各個角色 3、用例：同下方步驟的第4步，其中第3步中的流程圖是直接插入到第4步的流程圖表格項中的。 用例文檔的模板格式如同以上三點內容，通過Word文檔繪制表格，在表格中撰寫用例描述，表格的格式和樣式參考以下示例圖。 1、撰寫用例文檔的第一步是注明使用產品的各個角色(參與者)和角色說明(角色介紹)。（如下圖） [](http://image.woshipm.com/wp-files/2014/04/29a7e96467b69a9f5a93332e29e9b0de.jpg) 2、第二步是以用例圖的方式注明角色在前后端的用例關系。（如下圖） [](http://image.woshipm.com/wp-files/2014/04/34d5d911f0aacc6c3a70b4925cb35ca3.jpg) 3、第三步是以流程圖的方式注明角色在各個功能環節的活動過程。（如下圖：以活動報名為示例） [](http://image.woshipm.com/wp-files/2014/04/cff5497121104c2b8e0cb41ed2083a9b.jpg) 4、第四步則是以用例文檔的方式將以上三步整合到一起，并撰寫各個功能環節的用例描述。（如下圖） [](http://image.woshipm.com/wp-files/2014/04/34d5d911f0aacc6c3a70b4925cb35ca31.jpg) 表格說明： 4.1、用例名：此功能環節的名稱 4.2、用例編號：在此產品中該用例的編號 4.3、行為角色：參與或操作(執行)該功能的角色 4.4、簡要說明：用最少的文字描述一下該用例的需求 4.5、前置條件：參與或操作(執行)此功能的前提條件 4.6、后置條件：執行完畢后的結果條件 4.7、流程圖：該功能的角色活動過程(處理過程)圖（第三步中的圖） 上面示范的用例描述相對簡單，也是最常用和基本的用例描述內容，當然也有稍微復雜一點的用例文檔，文檔中會詳細描述使用場景、事件流和信息字段，也有一些用例文檔還會插入產品界面效果圖。 使用場景主要描述行為角色在不同情況下使用產品時，根據情況或問題給出相應的系統反饋。事件流類似流程圖，只不過是通過文字的方式描述角色的活動過程。信息字段主要是描述用例中所用到的數據字段。 這些更多的描述內容取決于個人的習慣，最終目的都是為了描述清晰產品邏輯，因此我的原則就是用越少的文字描述清晰越多的需求說明。（畢竟這些文檔是產品開發中的執行文檔，文字不在多，表達清晰即可。）