需求、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)文檔模板-軟件工程

需求、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)文檔模板—軟件工程需求文檔結(jié)構(gòu)1目的2范圍3業(yè)務(wù)分析與建模4系統(tǒng)功能需求–4.1系統(tǒng)功能架構(gòu)–4.2用例建模4.2.1用例簡(jiǎn)要描述:4.2.2用例角色:4.2.3用例前置條件:4.2.4用例后置條件:4.2.5用例事件流–基本事件流–備選事件流4.2.6用例場(chǎng)景(Use-CaseScenario)包括成功場(chǎng)景和失敗場(chǎng)景，場(chǎng)景主要是由基本流和備選流組合而成的。4.2.7用例非功能性需求:5系統(tǒng)非功能需求6系統(tǒng)接口7術(shù)語(yǔ)表8附錄OO軟件設(shè)計(jì)概要說(shuō)明書(shū)1概述系統(tǒng)簡(jiǎn)述、軟件設(shè)計(jì)目標(biāo)、參考資料、修訂版本記錄這部分論述整個(gè)系統(tǒng)的設(shè)計(jì)目標(biāo)，明確地說(shuō)明哪些功能是系統(tǒng)決定實(shí)現(xiàn)而哪些時(shí)不準(zhǔn)備實(shí)現(xiàn)的。同時(shí)，對(duì)于非功能性的需求例如性能、可用性等，亦需提及。需求規(guī)格說(shuō)明書(shū)對(duì)于這部分的內(nèi)容來(lái)說(shuō)是很重要的參考，看看其中明確了的功能性以及非功能性的需求。2術(shù)語(yǔ)表對(duì)本文檔中所使用的各種術(shù)語(yǔ)進(jìn)行說(shuō)明。如果一些術(shù)語(yǔ)在需求規(guī)格說(shuō)明書(shū)中已經(jīng)說(shuō)明過(guò)了，此處不用再重復(fù)，可以指引讀者參考需求說(shuō)明。3用例此處要求系統(tǒng)用用例圖表述（UML），對(duì)每個(gè)用例（正常處理的情況）要有中文敘述。OO軟件設(shè)計(jì)概要說(shuō)明書(shū)4設(shè)計(jì)概述4.1系統(tǒng)結(jié)構(gòu)設(shè)計(jì)這部分要求提供高層系統(tǒng)結(jié)構(gòu)（頂層系統(tǒng)結(jié)構(gòu)、各子系統(tǒng)結(jié)構(gòu)）的描述，使用方框圖來(lái)顯示主要的組件及組件間的交互。最好是把邏輯結(jié)構(gòu)同物理結(jié)構(gòu)分離，對(duì)前者進(jìn)行描述。別忘了說(shuō)明圖中用到的俗語(yǔ)和符號(hào)。1.系統(tǒng)邊界2.系統(tǒng)功能架構(gòu)（構(gòu)件模型）3.系統(tǒng)邏輯架構(gòu)（技術(shù)架構(gòu)）4.系統(tǒng)物理架構(gòu)（配置模型）5.系統(tǒng)數(shù)據(jù)模型（系統(tǒng)邏輯數(shù)據(jù)模型）4.2系統(tǒng)接口設(shè)計(jì)各種提供給用戶(hù)的界面以及外部系統(tǒng)在此處要予以說(shuō)明。OO軟件設(shè)計(jì)概要說(shuō)明書(shū)4.4約束和假定描述系統(tǒng)設(shè)計(jì)中最主要的約束，這些是由客戶(hù)強(qiáng)制要求并在需求說(shuō)明書(shū)寫(xiě)明的。說(shuō)明系統(tǒng)是如何來(lái)適應(yīng)這些約束的。實(shí)現(xiàn)的語(yǔ)言和平臺(tái)也會(huì)對(duì)系統(tǒng)有約束，同樣在此予以說(shuō)明。對(duì)于因選擇具體的設(shè)計(jì)實(shí)現(xiàn)而導(dǎo)致對(duì)系統(tǒng)的約束，簡(jiǎn)要地描述你的想法思路，經(jīng)過(guò)怎么樣的權(quán)衡，為什么要采取這樣的設(shè)計(jì)等等。OO軟件設(shè)計(jì)概要說(shuō)明書(shū)5對(duì)象模型提供整個(gè)系統(tǒng)的對(duì)象模型。對(duì)象描述在這個(gè)部分?jǐn)⑹雒總€(gè)對(duì)象的細(xì)節(jié)，它的屬性、它的方法。在這之前必須從邏輯上對(duì)對(duì)象進(jìn)行組織。OO軟件設(shè)計(jì)概要說(shuō)明書(shū)6動(dòng)態(tài)模型這部分的作用是描述系統(tǒng)如何響應(yīng)各種事件。一般使用順序圖和狀態(tài)圖。確定不同的場(chǎng)景（Scenario）是第一步，不需要確定所有可能的場(chǎng)景，但是必須至少要覆蓋典型的系統(tǒng)用例。不要自己去想當(dāng)然地創(chuàng)造場(chǎng)景，通常的策略是描述那些客戶(hù)可以感受得到的場(chǎng)景。7非功能性設(shè)計(jì)OO軟件詳細(xì)設(shè)計(jì)說(shuō)明書(shū)1概述系統(tǒng)簡(jiǎn)述、軟件設(shè)計(jì)目標(biāo)、參考資料、修訂版本記錄這部分論述整個(gè)系統(tǒng)的設(shè)計(jì)目標(biāo)，明確地說(shuō)明哪些功能是系統(tǒng)決定實(shí)現(xiàn)而哪些時(shí)不準(zhǔn)備實(shí)現(xiàn)的。同時(shí)，對(duì)于非功能性的需求例如性能、可用性等，亦需提及。需求規(guī)格說(shuō)明書(shū)對(duì)于這部分的內(nèi)容來(lái)說(shuō)是很重要的參考，看看其中明確了的功能性以及非功能性的需求。2術(shù)語(yǔ)表對(duì)本文檔中所使用的各種術(shù)語(yǔ)進(jìn)行說(shuō)明。如果一些術(shù)語(yǔ)在需求規(guī)格說(shuō)明書(shū)中已經(jīng)說(shuō)明過(guò)了，此處不用再重復(fù)，可以指引讀者參考需求說(shuō)明。3用例此處要求系統(tǒng)用用例圖表述（UML），對(duì)每個(gè)用例（正常處理的情況）要有中文敘述。OO軟件詳細(xì)設(shè)計(jì)說(shuō)明書(shū)4設(shè)計(jì)概述4.1簡(jiǎn)述這部分要求突出整個(gè)設(shè)計(jì)所采用的方法（是面向?qū)ο笤O(shè)計(jì)還是結(jié)構(gòu)化設(shè)計(jì)）、系統(tǒng)的體系結(jié)構(gòu)（例如客戶(hù)/服務(wù)器結(jié)構(gòu)）以及使用到的相應(yīng)技術(shù)和工具（例如OMT、Rose）4.2系統(tǒng)非功能描述、約束與估算：系統(tǒng)非功能指標(biāo)的描述與估算，如：軟件系統(tǒng)所需要的硬件資源配置要求（內(nèi)存、CPU、數(shù)據(jù)存儲(chǔ)量等要求），此配置下，系統(tǒng)的性能指標(biāo)估算4.3系統(tǒng)的復(fù)用計(jì)劃：庫(kù)、框架、模式、構(gòu)件等方面的復(fù)用4.4系統(tǒng)結(jié)構(gòu)設(shè)計(jì)系統(tǒng)邊界模型（系統(tǒng)上下文模型）系統(tǒng)功能架構(gòu)：系統(tǒng)邏輯架構(gòu)系統(tǒng)物理架構(gòu)系統(tǒng)數(shù)據(jù)字典系統(tǒng)數(shù)據(jù)模型（系統(tǒng)物理數(shù)據(jù)模型）OO軟件詳細(xì)設(shè)計(jì)說(shuō)明書(shū)–4.5系統(tǒng)接口設(shè)計(jì)各種提供給用戶(hù)的界面系統(tǒng)外部接口設(shè)計(jì)：與外部系統(tǒng)的交互設(shè)計(jì)系統(tǒng)內(nèi)部接口設(shè)計(jì)：各子系統(tǒng)、各模塊間的接口設(shè)計(jì)–4.6系統(tǒng)約束與策略：描述系統(tǒng)的主要約束：包括需求中的功能和非功能的約束、實(shí)現(xiàn)方面的約束、接口方面的約束等等系統(tǒng)的一些主要策略：系統(tǒng)優(yōu)先級(jí)策略、系統(tǒng)全局資源策略、系統(tǒng)架構(gòu)風(fēng)格策略、系統(tǒng)針對(duì)系統(tǒng)約束的策略等等。OO軟件詳細(xì)設(shè)計(jì)說(shuō)明書(shū)–4.7對(duì)象模型設(shè)計(jì)對(duì)象模型：提供整個(gè)系統(tǒng)的對(duì)象模型，在其中應(yīng)該包含所有的系統(tǒng)對(duì)象。所有對(duì)象之間的關(guān)聯(lián)必須被確定并且必須指明聯(lián)系的基數(shù)。對(duì)象描述:在這個(gè)部分?jǐn)⑹雒總€(gè)對(duì)象的細(xì)節(jié)，它的屬性、它的方法。對(duì)每個(gè)對(duì)象的每個(gè)屬性詳細(xì)說(shuō)明：名字、類(lèi)型;對(duì)每個(gè)對(duì)象的每個(gè)方法詳細(xì)說(shuō)明：方法名，返回類(lèi)型，返回值，參數(shù)，用途以及使用的算法的簡(jiǎn)要說(shuō)明。OO軟件詳細(xì)設(shè)計(jì)說(shuō)明書(shū)–4.8動(dòng)態(tài)模型設(shè)計(jì)這部分的作用是描述系統(tǒng)如何響應(yīng)各種事件。一般使用順序圖和狀態(tài)圖。有需要的話(huà)也可以用活動(dòng)圖描述系統(tǒng)的主要場(chǎng)景的流程圖確定不同的場(chǎng)景（Scenario）是第一步，不需要確定所有可能的場(chǎng)景，但是必須至少要覆蓋典型的系統(tǒng)用例。不要自己去想當(dāng)然地創(chuàng)造場(chǎng)景，通常的策略是描述那些客戶(hù)可以感受得到的場(chǎng)景。–場(chǎng)景（Scenarios）（重要的業(yè)務(wù)場(chǎng)景）對(duì)每個(gè)場(chǎng)景做一則條目，包括以下內(nèi)容：場(chǎng)景名：給它一個(gè)可以望文生義的名字場(chǎng)景描述：簡(jiǎn)要敘述場(chǎng)景是干什么的以及發(fā)生的動(dòng)作的順序。–順序圖：描述各種事件及事件發(fā)生的相對(duì)時(shí)間順序。–活動(dòng)圖：描述場(chǎng)景的流程O(píng)O軟件詳細(xì)設(shè)計(jì)說(shuō)明書(shū)狀態(tài)圖這部分的內(nèi)容包括系統(tǒng)動(dòng)態(tài)模型重要的部分的狀態(tài)圖?？赡苣阆霝槊總€(gè)對(duì)象畫(huà)一個(gè)狀態(tài)圖，但事實(shí)上會(huì)導(dǎo)致太多不期望的細(xì)節(jié)信息，只需要確定系統(tǒng)中一些重要的對(duì)象并為之提供狀態(tài)圖即可。–4.9系統(tǒng)非功能設(shè)計(jì)針對(duì)系統(tǒng)非功能需求進(jìn)行的系統(tǒng)設(shè)計(jì)標(biāo)準(zhǔn)建模語(yǔ)言UML（類(lèi)圖）類(lèi)圖中的圖符：類(lèi)：表示一個(gè)類(lèi)，其中第一欄是類(lèi)的名，第二欄是類(lèi)的屬性，第三欄是類(lèi)的操作。包：包是一種分組機(jī)制，表示一個(gè)類(lèi)圖集合。關(guān)聯(lián)：用于表示類(lèi)的對(duì)象之間的關(guān)系。其特殊形式有組成關(guān)聯(lián)和聚集關(guān)聯(lián)。OperationsAttributesClassPackage標(biāo)準(zhǔn)建模語(yǔ)言UML（類(lèi)圖）類(lèi)圖中的圖符：聚集關(guān)聯(lián)：用于表示類(lèi)的對(duì)象之間的關(guān)系是整體與部分的關(guān)系。組成關(guān)聯(lián)：用于表示類(lèi)的對(duì)象之間的關(guān)系：整體擁有各部分，部分與整體共存，如整體不存在了，部分也會(huì)隨之消失。泛化關(guān)聯(lián)：泛化關(guān)系（繼承關(guān)系）定義了類(lèi)、包間的一般元素和特殊元素之間的分類(lèi)關(guān)系。標(biāo)準(zhǔn)建模語(yǔ)言UML（類(lèi)圖）類(lèi)圖中的圖符：依賴(lài)關(guān)系：有兩個(gè)類(lèi)或包元素X、Y，修改元素X的定義可能會(huì)引起對(duì)另一個(gè)元素Y的定義的修改，則稱(chēng)元素Y依賴(lài)于元素X。對(duì)象：類(lèi)的一個(gè)實(shí)例。鏈接：用于表示對(duì)象間的關(guān)聯(lián)關(guān)系的一個(gè)實(shí)例。ValuesObject將類(lèi)圖上出現(xiàn)的元素轉(zhuǎn)換到Java關(guān)聯(lián)（Association）實(shí)體之間的一個(gè)結(jié)構(gòu)化關(guān)系表明對(duì)象是相互連接的。箭頭是可選的，它用于指定導(dǎo)航能力。如果沒(méi)有箭頭，暗示是一種雙向的導(dǎo)航能力。在Java中，關(guān)聯(lián)轉(zhuǎn)換為一個(gè)實(shí)例作用域的變量，“Java”區(qū)域所展示的代碼那樣?？蔀橐粋€(gè)關(guān)聯(lián)附加其他修飾符。多重性（Multiplicity）修飾符暗示著實(shí)例之間的關(guān)系。在示范代碼中，Employee可以有0個(gè)或更多的TimeCard對(duì)象。但是，每個(gè)TimeCard只從屬于單獨(dú)一個(gè)Employee。將類(lèi)圖上出現(xiàn)的元素轉(zhuǎn)換到Java依賴(lài)（Dependency）實(shí)體之間