需求用例編寫規(guī)范.

1、需求用例編寫規(guī)范-V1.0文檔編號(hào):文檔名稱:需求用例編寫規(guī)范文檔類別:設(shè)計(jì)規(guī)范密級(jí):機(jī)密版本信息:1.0建立日期：2005-08-26創(chuàng)建人:016審核者:批準(zhǔn)人:批準(zhǔn)日期:編輯軟件：Microsoft Office 2003中文版版本 編號(hào)*變化 狀態(tài)簡(jiǎn)要說明 （變更內(nèi)容和變更范圍日期變更人批準(zhǔn)日期批準(zhǔn)人更改請(qǐng)求VI. 0C參崗- g編q杠效用例016*變化狀態(tài):C創(chuàng)建,M 修改Q刪除版本 編號(hào)*變化狀態(tài)«婆說明（變更內(nèi)容和變更范圍）日期變更人批椎日期批準(zhǔn)人更改請(qǐng)求VI. 0C2OO5-OS-26016目錄1簡(jiǎn)介（11.1文檔目的(11.2有效范圍(12梗概（12.1用例定義(1

2、2.2用例格式(22.2.1非正式用例（22.2.2正式用例（33非正式用例（33.1用例名（33.2自然語(yǔ)言描述體（43.3圖例說明（44正式用例（44.1范圍(44.2級(jí)別(44.3主執(zhí)行者（44.4項(xiàng)目相關(guān)人員和利益（44.5前置條件(44.6最小保證(54.7成功保證(54.8觸發(fā)事件(54.9主成功場(chǎng)景（5 4.10擴(kuò)展場(chǎng)景（5 4.11相關(guān)信息（64.11.1解釋說明(64.11.2約束條件(74.11.3改進(jìn)建議(75編號(hào)（76批注（77超鏈接（88字體及顏色（89如何快速書寫需要用例（89.1非正式用例（89.2正式用例（910范例（101簡(jiǎn)介1.1文檔目的本文檔中的內(nèi)容是為了

3、更好的書寫與理解需求用例，閱讀本文后，達(dá)到讀者能夠 書寫規(guī)范有效的需求用例。如果讀者需要立即書寫需求用例，則可以直接閱讀第9 節(jié)如何快速書寫需求用例”本文參考Alistair Cockburn編著，王雷、張莉翻譯由機(jī)械工業(yè)出版社出版的編寫有效用例（Writing Effective Use Cases一書，有興趣的讀 者可以詳細(xì)閱讀此書。1.2有效范圍本文適用于各種軟件開發(fā)項(xiàng)目的需求分析。2梗概2.1用例定義用例是代表系統(tǒng)中各個(gè)項(xiàng)目相關(guān)人員之間就系統(tǒng)的行為所達(dá)成的契約，用例描述了在不同條件下，系統(tǒng)對(duì)某一項(xiàng)目相關(guān)人員的請(qǐng)求所作出的響應(yīng)。如果用用例來記錄一個(gè)組織的業(yè)務(wù)過程，那么被討論的系統(tǒng)是指組織

4、本身，項(xiàng)目 相關(guān)人員是指公司的股東、客戶、供應(yīng)商和政府管理部門 ，這種用例稱為業(yè)務(wù)用例， 業(yè)務(wù)用例可以作為軟件需求采集時(shí)使用；如果用用例來記錄一個(gè)軟件的行為需求，那 么被討論的系統(tǒng)是指計(jì)算機(jī)程序，項(xiàng)目相關(guān)人員是指使用該程序的人、擁有該程序 的公司、政府管理部門和其他一些計(jì)算機(jī)程序，這種用例稱為系統(tǒng)用例，系統(tǒng)用例可 以作為軟件需求分析時(shí)使用。用例不是所有的需求，用例不能詳細(xì)地描述外部接口、數(shù)據(jù)格式、業(yè)務(wù)規(guī)則和復(fù)雜公式，用例只是需要收集的所有需求中的一部分，雖然這一部分是非常重要的一部分,但畢竟僅僅是 一部分”不能全部反映 需求”。1/0瀟儀第1頁(yè)共16頁(yè)LJI霜求2.2用例格式需求用例分為正式用

5、例與非正式用例，非正式用例是用自然語(yǔ)言及圖例進(jìn)行用例描述，正式用例是具有規(guī)范格式的用例描述。讀者在此不必深究用例如何書寫，后續(xù)章節(jié)中有詳細(xì)說明。2.2.1非正式用例用例名自然講H描述 圖例說明222正式用例< ir If',in Rm I4 Br 蹇；鍾功iw；'- - H 'I MilF， J“ nwit#3非正式用例非正式用例包括三部分：用例名、自然語(yǔ)言描述體、圖例說明。3.1用例名用例名就是用例的名稱，應(yīng)是一個(gè)主動(dòng)語(yǔ)態(tài)動(dòng)詞短語(yǔ)來表示的用例目標(biāo)。3.2自然語(yǔ)言描述體用自然語(yǔ)言描述成功場(chǎng)景和可能會(huì)出現(xiàn)的失敗場(chǎng)景，及其相應(yīng)的處理動(dòng)作，還包 括用例所需要的功能操作等

6、。3.3圖例說明對(duì)于較復(fù)雜的需求用例，可以用圖表說明用例之間關(guān)系，使用例更加清晰明朗。4正式用例正式用列具有格式規(guī)范，包括:用例名、自然語(yǔ)言描述體、圖例說明、范圍、級(jí) 別、主執(zhí)行者、項(xiàng)目相關(guān)人員和利益、前置條件、最小保證、成功保證、觸發(fā)事 件、主成功場(chǎng)景、擴(kuò)展場(chǎng)景和相關(guān)信息等項(xiàng)目，用例格式并不是硬性規(guī)定必須包括這此內(nèi)容，只是為需求用例編寫者提供正式用例編寫格式參考，具體項(xiàng)目具體分析，以增減正式用例內(nèi)容，更好地為需求分析服務(wù)；用例名、自然語(yǔ)言描述體、圖例說明的 編寫方法同非正式用例，只是自然語(yǔ)言描述體只闡述不能在主成功場(chǎng)景和擴(kuò)展場(chǎng)景 中描述的部分，不必將場(chǎng)景全部說明。4.1范圍范圍（SCOpe用

7、來描述項(xiàng)目開發(fā)人員負(fù)責(zé)的設(shè)計(jì)工作的邊界,以便與應(yīng)由其他人負(fù)責(zé)的設(shè)計(jì)工作或已經(jīng)完成的設(shè)計(jì)工作相區(qū)別；范圍應(yīng)該是一個(gè)簡(jiǎn)單明確的名詞，比 如說需求人員正在對(duì)固定資產(chǎn)”項(xiàng)目進(jìn)行需求分析，則范圍”可以是固定資產(chǎn)系 統(tǒng)”4.2級(jí)別級(jí)別分為三個(gè)目標(biāo)層次：概要、用戶目標(biāo)、子功能，書寫需求用例時(shí)，只能選擇其，下面對(duì)其具體說明:?概要:包括多個(gè)用戶目標(biāo)，它有 顯示相關(guān)目標(biāo)的生命周期順序”和為低層用例 提供一個(gè)目錄表”的功能，概要用例通常需要執(zhí)行幾個(gè)小時(shí)、幾天、幾個(gè)星期、幾個(gè)月、甚至幾 年。?用戶目標(biāo)：它是主執(zhí)行者努力使工作得以完成的目標(biāo)，或是用戶使用系統(tǒng)的目標(biāo),通常情況下指系統(tǒng)為用戶提供的界面操作。?子功能:指那

8、些在實(shí)現(xiàn)用戶目標(biāo)時(shí)可能會(huì)被用到的目標(biāo)，一般是指系統(tǒng)內(nèi)部執(zhí)行,而用戶看不到界面的用例。4.3主執(zhí)行者用例的主執(zhí)行者是指任何具有行為的事物，主執(zhí)行者通常是觸發(fā)用例的執(zhí)行者，可能是一個(gè)人、一個(gè)公司或組織、一個(gè)計(jì)算機(jī)程序或一個(gè)計(jì)算機(jī)系統(tǒng)，主執(zhí)行者應(yīng)該是一個(gè)主語(yǔ)名詞，如 賬務(wù)主管” 總賬系統(tǒng)”等。4.4項(xiàng)目相關(guān)人員和利益項(xiàng)目相關(guān)人員是對(duì)行為具有特定利益的人或物，他們的利益在系統(tǒng)執(zhí)行的檢查和確認(rèn)中、在創(chuàng)建的日志中、以及在系統(tǒng)執(zhí)行的動(dòng)作中得以體現(xiàn)；項(xiàng)目相關(guān)人員是一個(gè)名詞，緊接的利益是簡(jiǎn)明扼要的短語(yǔ)。4.5前置條件前置條件是指啟動(dòng)該用例之前系統(tǒng)必須滿足的條件，通常，前置條件是已經(jīng)通過 其他用例的執(zhí)行進(jìn)行了設(shè)置

9、，前置條件必須是由主-謂-賓”構(gòu)成的短語(yǔ)，如用戶已經(jīng)登錄系統(tǒng)”系統(tǒng)已經(jīng) 存在會(huì)計(jì)科目”4.6最小保證最小保證是系統(tǒng)向項(xiàng)目相關(guān)人員作出的最低承諾，如系統(tǒng)將錯(cuò)誤信息寫入系統(tǒng) 日志”從這個(gè)例子可以看出，最小保證也是由 主-謂-賓”短語(yǔ)所構(gòu)成的。4.7成功保證成功保證說明了用例成功結(jié)束后項(xiàng)目相關(guān)人員的哪些利益得到了滿足，用例可以通過執(zhí)行主場(chǎng)景獲得成功，也可以通過執(zhí)行擴(kuò)展場(chǎng)景可選路徑獲得成功，其格式同 最小保證主-謂-賓”形式，例如系統(tǒng)保存記賬憑證”。4.8觸發(fā)事件觸發(fā)事件指明了啟動(dòng)用例的事件，一般是肯定性的短語(yǔ)，如總賬啟用后必須執(zhí)行 此用例進(jìn)行設(shè)置”。4.9主成功場(chǎng)景自頂向下進(jìn)行描述，這個(gè)描述包含一個(gè)

10、容易理解的相當(dāng)?shù)湫偷膱?chǎng)景，在該場(chǎng)景中, 主執(zhí)行者完成了目標(biāo)，所有項(xiàng)目相關(guān)人員的利益都被滿足，這個(gè)場(chǎng)景就是主成功場(chǎng)景， 其他的成功場(chǎng)景和所有錯(cuò)誤的處理，都會(huì)在主成功場(chǎng)景的擴(kuò)展中進(jìn)行描述，主成功場(chǎng) 景包括場(chǎng)景編號(hào)、場(chǎng)景動(dòng)作描述兩部門，場(chǎng)景編號(hào)是以數(shù)字為基礎(chǔ)的順序編號(hào)。主成功場(chǎng)景的書寫規(guī)則如下：?使用簡(jiǎn)單的語(yǔ)法:主-謂-賓”語(yǔ)法形式?明確地寫出執(zhí)行者?描述過程向前推移?描述執(zhí)行者的意圖而不是動(dòng)作?確認(rèn)”而不是檢查是否”?重復(fù)動(dòng)作描述 循環(huán)執(zhí)行步驟x到y(tǒng)，直到條件滿足”例如:網(wǎng)上購(gòu)物的主成功場(chǎng)景L顧客提供：一賬號(hào)信息2,3*4*系統(tǒng)杳出顧霽的煙好佶總5.顧容選擇一個(gè)曲品，并做上購(gòu)買標(biāo)記 系統(tǒng)將這個(gè)麗品

11、加入顧客的*'購(gòu)物忙中 傾客重a步驟34,置到顧客指明他完成了選購(gòu) 顧客確認(rèn)購(gòu)買購(gòu)物乍中序右商品6.4.10擴(kuò)展場(chǎng)景擴(kuò)展實(shí)質(zhì)上是一個(gè)從主用例中被拆分的用例。擴(kuò)展開始于一個(gè)與它相關(guān)的條 件。它包含了一個(gè)執(zhí)行步驟的序列，該序列描述了在這個(gè)條件下發(fā)生了什么。擴(kuò)展 以完成或放棄擴(kuò)展目標(biāo)作為結(jié)束。擴(kuò)展是為了處理多個(gè)條件和轉(zhuǎn)移，可能會(huì)遇到擴(kuò)展中又包含擴(kuò)展的情況。擴(kuò)展分為擴(kuò)展條件和處理動(dòng)作描 述兩部分，擴(kuò)展條件是指對(duì)應(yīng)的主成功場(chǎng)景出現(xiàn)的不同情況，應(yīng)該是一條肯定的條件 短語(yǔ)，不能出現(xiàn) 如果那么”這種形式的語(yǔ)句；處理動(dòng)作描述是指對(duì)擴(kuò)展條件 的處理。擴(kuò)展同樣需要進(jìn)行編號(hào)，編號(hào)格式為對(duì)應(yīng)主成功場(chǎng)景編號(hào).擴(kuò)展

12、條件編 號(hào).處理動(dòng)作編號(hào),其中擴(kuò)展條件編號(hào)以字母為序號(hào)，即az。如果處理動(dòng)作只有唯 一動(dòng)作，其格式可以是“擴(kuò)展條件：處理動(dòng)作”處理動(dòng)作不唯一則必須換行編寫。需 求用例是子用例，并且被多處引用，但由于引用子用例的用例之間可能有不需要的成 功場(chǎng)景，即存在特性主成功場(chǎng)景，此時(shí)編寫子用例時(shí)，對(duì)特性的主成功場(chǎng)景可以寫入擴(kuò) 展場(chǎng)景中，并做出相應(yīng)的解釋說明。擴(kuò)展場(chǎng)景的書寫規(guī)則如下：?使用簡(jiǎn)單的語(yǔ)法：主-謂-賓”語(yǔ)法形式?明確地寫出執(zhí)行者?描述過程根據(jù)主成功場(chǎng)景向前推移?描述執(zhí)行者的意圖而不是動(dòng)作?確認(rèn)”而不是檢查是否”?重復(fù)動(dòng)作描述 循環(huán)執(zhí)行步驟x到y(tǒng),直到條件滿足”?用檢測(cè)到什么”的方式來編寫條件例如:L

13、川戶輸入-久計(jì)科H編碼1. 系統(tǒng)鯊證通過拆.存仝訂科冃擴(kuò)展:系綻臉注科H編卜:氏股仃系統(tǒng)泄賈氏糜 n I皿I.系維:匕伽呵門."扇hv川八，1新輸人 I丄冊(cè)戶胞瀟輸人茶址執(zhí)廳步驛1 |血化卿戶放癢輸2 秦址"靑為訓(xùn)覽狀恚眾統(tǒng)躺ii倉(cāng)汁科H咅用乂空l(shuí).b l.眾統(tǒng)人斯用化井捉示川八電新輸扎 112 州門吃靳輸人.系統(tǒng)執(zhí)a步驟I Lb.J.用門膠棄城g糸統(tǒng)鶴訐數(shù)攥庫(kù)連腰火也 退出磊統(tǒng)4.11相關(guān)信息4.11.1解釋說明解釋說明業(yè)務(wù)詞語(yǔ)或定義等，便于業(yè)務(wù)人員和軟件設(shè)計(jì)人員理解。4.11.2約束條件用例中的計(jì)算公式和約束限制等，有助于軟件設(shè)計(jì)和程序設(shè)計(jì)人員進(jìn)行軟件設(shè) 計(jì)。4.11.

14、3改進(jìn)建議升級(jí)新版本時(shí)，對(duì)舊版本的改進(jìn)建議，如果不存在舊版本，則可不存在此項(xiàng)目。5編號(hào)用例之間需要進(jìn)行編號(hào)，編號(hào)以多級(jí)符號(hào)形式,即“ 1. ”“ 1.1.”通常情況下, 最頂級(jí)不進(jìn)行編號(hào)，即“XXX系統(tǒng)”而是對(duì)其下級(jí)開始多級(jí)編號(hào),例如：總賬系統(tǒng)1基礎(chǔ)設(shè)置1.1會(huì)計(jì)科目設(shè)Siisip丨杵1.2期初余®錄入2記賬憑證M川M2.1記«£憑證編制如果用例中包含圖例，則需要對(duì)圖例進(jìn)行編號(hào)，編號(hào)格式為圖<頂級(jí)用例編號(hào)>-< 圖例在頂級(jí)用例的序號(hào) >”如 圖2-3 XXXX圖”如果是最頂級(jí)用例，則以系統(tǒng)名稱的開頭漢字作為頂級(jí)用例編號(hào)，如總賬系統(tǒng)的第一張圖

15、則表示為圖總-1 XXXX圖”6批注必要時(shí)可以對(duì)公式、約束、名詞、列表內(nèi)容等項(xiàng)目編寫注釋說明，便于用例閱讀者理解用例，對(duì)于必要約束,必須添加批注，例如:IIN描述體'ji I，:'Hi>7超鏈接必要時(shí)可以對(duì)相關(guān)用例、子用例、名詞解釋等插入超鏈接 ，其中子用例必須插入超鏈接，以明確說明子用例的出處，例如:1 ! >用例名<ilif I.I IIN描述體J".心.J, '' ' "nb -"ii ' >8字體及顏色標(biāo)題字號(hào)不能小于正文字號(hào)，并且以加粗顯示，以明顯示區(qū)分，如 用例名” 主 成功場(chǎng)景”

16、等。對(duì)于不同內(nèi)容，如功能操作、新系統(tǒng)用例等使用不同顏色進(jìn)行區(qū)分，通常情況下，功能操作前景色使用“”色，新系統(tǒng)用例部分使用“”色以示區(qū)別，還可以使用其 它的顏色對(duì)不同并有警示意義的內(nèi)容進(jìn)行標(biāo)識(shí)，可以適當(dāng)?shù)卦O(shè)置背景色，但無論使用 什么樣的顏色，都應(yīng)對(duì)其說明。9如何快速書寫需要用例用例分為正式用例和非正式用例，由于時(shí)間原因,用例編寫者可能無法詳細(xì)閱讀 本規(guī)范，所以提供了此章節(jié)，希望讀者通過閱讀本章節(jié)，能夠達(dá)到快速編寫需求用例的 目的。9.1非正式用例If dmJ 小JA9.2正式用例用例名i'宀;*-ffi fl ;9 W：-_rKUT*#-1 1«寸證-痕為霍證：-主，瞠雄：理

17、SIF"-I.匸 1":t Jl * |:円-1 h - 1： I.V：i'l fU 一相軸*誕*-n* 睪 ft 砂厲說明:1.概要:包括多個(gè)用戶目標(biāo)，它有 顯示相關(guān)目標(biāo)的生命周期順序”和為低層用例 提供一個(gè)目錄表”的功能。2. 用戶目標(biāo)：它是主執(zhí)行者努力使工作得以完成的目標(biāo)，或是用戶使用系統(tǒng)的目標(biāo)。3. 子功能:指那些在實(shí)現(xiàn)用戶目標(biāo)時(shí)可能會(huì)被用到的目標(biāo)。4. 批注:必要時(shí)可以對(duì)公式、約束、名詞、名詞項(xiàng)目必須內(nèi)容等編寫注釋說明。5. 超鏈接:必要時(shí)可以對(duì)相關(guān)用例、子用例、名詞解釋等插入超鏈接。6. 字體及顏色:對(duì)于不同內(nèi)容，如功能操作、新系統(tǒng)用例等使用不同顏色進(jìn)行

18、區(qū) 分。7.圖表:對(duì)于較復(fù)雜的用例，可以用圖例說明用例之間關(guān)系。10范例wg丄c 5 w3:s .二0£-4 xcsrrxacrcves <"««?«*«« i3»*3 «s*s«ss ：M ?3< fis3 MMV STBixvaas *«ftsBS3t sc« ST 9?*SW5 msis a«?SSI«sv £ 盒-rrfvwc叮S3A S3 sv« IVT ?4rs*w -!* trs>*30ml vv »¥#<* -VTIB«2*-S