1、需求用例編寫規范-V1.0文檔編號:文檔名稱:需求用例編寫規范文檔類別:設計規范密級:機密版本信息:1.0建立日期:2005-08-26創建人:016審核者:批準人:批準日期:編輯軟件:Microsoft Office 2003 中文版 *變化狀態:C創建,M修改,D刪除 目錄1簡介 (11.1文檔目的 (11.2有效范圍 (12梗概 (12.1用例定義 (12.2用例格式 (23非正式用例 (33.1用例名 (33.2自然語言描述體 (43.3圖例說明 (44正式用例 (44.1范圍 (44.2級別 (44.3主執行者 (44.4項目相關人員和利益 (44.5前置條件 (44.6最小保證 (

2、54.7成功保證 (54.8觸發事件 (54.9主成功場景 (54.10擴展場景 (54.11相關信息 (65編號 (76批注 (77超鏈接 (88字體及顏色 (89如何快速書寫需要用例 (89.1非正式用例 (89.2正式用例 (910范例 (101簡介1.1文檔目的本文檔中的內容是為了更好的書寫與理解需求用例,閱讀本文后,達到讀者能夠書寫規范有效的需求用例。如果讀者需要立即書寫需求用例,則可以直接閱讀第9節“如何快速書寫需求用例”。本文參考Alistair Cockburn 編著,王雷、張莉翻譯由機械工業出版社出版的編寫有效用例(Writing Effective Use Cases一書,

3、有興趣的讀者可以詳細閱讀此書。1.2有效范圍本文適用于各種軟件開發項目的需求分析。2梗概2.1用例定義用例是代表系統中各個項目相關人員之間就系統的行為所達成的契約,用例描述了在不同條件下,系統對某一項目相關人員的請求所作出的響應。如果用用例來記錄一個組織的業務過程,那么被討論的系統是指組織本身,項目相關人員是指公司的股東、客戶、供應商和政府管理部門,這種用例稱為業務用例,業務用例可以作為軟件需求采集時使用;如果用用例來記錄一個軟件的行為需求,那么被討論的系統是指計算機程序,項目相關人員是指使用該程序的人、擁有該程序的公司、政府管理部門和其他一些計算機程序,這種用例稱為系統用例,系統用例可以作為

4、軟件需求分析時使用。用例不是所有的需求,用例不能詳細地描述外部接口、數據格式、業務規則和復雜公式,用例只是需要收集的所有需求中的一部分,雖然這一部分是非常重要的一部分,但畢竟僅僅是“一部分”,不能全部反映“需求”。 第 1 頁共16 頁2.2用例格式需求用例分為正式用例與非正式用例,非正式用例是用自然語言及圖例進行用例描述,正式用例是具有規范格式的用例描述。讀者在此不必深究用例如何書寫,后續章節中有詳細說明。 3非正式用例非正式用例包括三部分:用例名、自然語言描述體、圖例說明。3.1用例名用例名就是用例的名稱,應是一個主動語態動詞短語來表示的用例目標。3.2自然語言描述體用自然語言描述成功場景

5、和可能會出現的失敗場景,及其相應的處理動作,還包括用例所需要的功能操作等。3.3圖例說明對于較復雜的需求用例,可以用圖表說明用例之間關系,使用例更加清晰明朗。4正式用例正式用列具有格式規范,包括:用例名、自然語言描述體、圖例說明、范圍、級別、主執行者、項目相關人員和利益、前置條件、最小保證、成功保證、觸發事件、主成功場景、擴展場景和相關信息等項目,用例格式并不是硬性規定必須包括這此內容,只是為需求用例編寫者提供正式用例編寫格式參考,具體項目具體分析,以增減正式用例內容,更好地為需求分析服務;用例名、自然語言描述體、圖例說明的編寫方法同非正式用例,只是自然語言描述體只闡述不能在主成功場景和擴展場

6、景中描述的部分,不必將場景全部說明。4.1范圍范圍(scope用來描述項目開發人員負責的設計工作的邊界,以便與應由其他人負責的設計工作或已經完成的設計工作相區別;范圍應該是一個簡單明確的名詞,比如說需求人員正在對“固定資產”項目進行需求分析,則“范圍”可以是“固定資產系統”。4.2級別級別分為三個目標層次:概要、用戶目標、子功能,書寫需求用例時,只能選擇其一,下面對其具體說明:概要:包括多個用戶目標,它有“顯示相關目標的生命周期順序”和“為低層用例提供一個目錄表”的功能,概要用例通常需要執行幾個小時、幾天、幾個星期、幾個月、甚至幾年。用戶目標:它是主執行者努力使工作得以完成的目標,或是用戶使用

7、系統的目標,通常情況下指系統為用戶提供的界面操作。子功能:指那些在實現用戶目標時可能會被用到的目標,一般是指系統內部執行,而用戶看不到界面的用例。4.3主執行者用例的主執行者是指任何具有行為的事物,主執行者通常是觸發用例的執行者,可能是一個人、一個公司或組織、一個計算機程序或一個計算機系統,主執行者應該是一個主語名詞,如“賬務主管”、“總賬系統”等。4.4項目相關人員和利益項目相關人員是對行為具有特定利益的人或物,他們的利益在系統執行的檢查和確認中、在創建的日志中、以及在系統執行的動作中得以體現;項目相關人員是一個名詞,緊接的利益是簡明扼要的短語。4.5前置條件前置條件是指啟動該用例之前系統必

8、須滿足的條件,通常,前置條件是已經通過其他用例的執行進行了設置,前置條件必須是由“主-謂-賓”構成的短語,如“用戶已經登錄系統”、“系統已經存在會計科目”。4.6 最小保證最小保證是系統向項目相關人員作出的最低承諾,如“系統將錯誤信息寫入系統日志”,從這個例子可以看出,最小保證也是由“主-謂-賓”短語所構成的。4.7 成功保證成功保證說明了用例成功結束后項目相關人員的哪些利益得到了滿足,用例可以通過執行主場景獲得成功,也可以通過執行擴展場景可選路徑獲得成功,其格式同最小保證“主-謂-賓”形式,例如“系統保存記賬憑證”。4.8 觸發事件觸發事件指明了啟動用例的事件,一般是肯定性的短語,如“總賬啟

9、用后必須執行此用例進行設置”。4.9 主成功場景自頂向下進行描述,這個描述包含一個容易理解的相當典型的場景,在該場景中,主執行者完成了目標,所有項目相關人員的利益都被滿足,這個場景就是主成功場景,其他的成功場景和所有錯誤的處理,都會在主成功場景的擴展中進行描述,主成功場景包括場景編號、場景動作描述兩部門,場景編號是以數字為基礎的順序編號。主成功場景的書寫規則如下: 使用簡單的語法:“主-謂-賓”語法形式 明確地寫出執行者 描述過程向前推移 描述執行者的意圖而不是動作 “確認”而不是“檢查是否” 重復動作描述“循環執行步驟x 到y ,直到條件滿足”例如:網上購物的主成功場景 4.10 擴展場景擴

10、展實質上是一個從主用例中被拆分的用例。擴展開始于一個與它相關的條件。它包含了一個執行步驟的序列,該序列描述了在這個條件下發生了什么。擴展以完成或放棄擴展目標作為結束。擴展是為了處理多個條件和轉移,可能會遇到擴展中又包含擴展的情況。擴展分為擴展條件和處理動作描述兩部分,擴展條件是指對應的主成功場景出現的不同情況,應該是一條肯定的條件短語,不能出現“如果那么”這種形式的語句;處理動作描述是指對擴展條件的處理。擴展同樣需要進行編號,編號格式為對應主成功場景編號.擴展條件編號.處理動作編號,其中擴展條件編號以字母為序號,即az。如果處理動作只有唯一動作,其格式可以是“擴展條件:處理動作”,處理動作不唯

11、一則必須換行編寫。需求用例是子用例,并且被多處引用,但由于引用子用例的用例之間可能有不需要的成功場景,即存在特性主成功場景,此時編寫子用例時,對特性的主成功場景可以寫入擴展場景中,并做出相應的解釋說明。擴展場景的書寫規則如下:使用簡單的語法:“主-謂-賓”語法形式明確地寫出執行者描述過程根據主成功場景向前推移描述執行者的意圖而不是動作“確認”而不是“檢查是否”重復動作描述“循環執行步驟x到y,直到條件滿足”用“檢測到什么”的方式來編寫條件例如: 4.11相關信息解釋說明業務詞語或定義等,便于業務人員和軟件設計人員理解。用例中的計算公式和約束限制等,有助于軟件設計和程序設計人員進行軟件設計。升級

12、新版本時,對舊版本的改進建議,如果不存在舊版本,則可不存在此項目。5編號 如果用例中包含圖例,則需要對圖例進行編號,編號格式為“圖<頂級用例編號>-<圖例在頂級用例的序號>”,如“圖2-3 xxxx圖”,如果是最頂級用例,則以系統名稱的開頭漢字作為頂級用例編號,如總賬系統的第一張圖則表示為“圖總-1 xxxx圖”。6批注必要時可以對公式、約束、名詞、列表內容等項目編寫注釋說明,便于用例閱讀者理解用例,對于必要約束,必須添加批注,例如: 7超鏈接必要時可以對相關用例、子用例、名詞解釋等插入超鏈接,其中子用例必須插入超鏈接,以明確說明子用例的出處,例如: 8字體及顏色標題字

13、號不能小于正文字號,并且以加粗顯示,以明顯示區分,如“用例名”、“主成功場景”等。對于不同內容,如功能操作、新系統用例等使用不同顏色進行區分,通常情況下,功能操作前景色使用“”顏色,新系統用例部分使用“”顏色以示區別,還可以使用其它的顏色對不同并有警示意義的內容進行標識,可以適當地設置背景色,但無論使用什么樣的顏色,都應對其說明。9如何快速書寫需要用例用例分為正式用例和非正式用例,由于時間原因,用例編寫者可能無法詳細閱讀本規范,所以提供了此章節,希望讀者通過閱讀本章節,能夠達到快速編寫需求用例的目的。9.1非正式用例 9.2正式用例 說明:1.概要:包括多個用戶目標,它有“顯示相關目標的生命周期順序”和“為低層用例提供一個目錄表”的