面向?qū)ο蠓椒ㄏ到y(tǒng)設(shè)計(jì)說(shuō)明書(shū)模板

1、項(xiàng)目名稱(chēng)設(shè)計(jì)說(shuō)明小組名稱(chēng)：設(shè)計(jì)說(shuō)明目錄1 概述11.1 編寫(xiě)目的11.2 參考資料11.3 術(shù)語(yǔ)和縮寫(xiě)詞*12 需求概述13 結(jié)構(gòu)設(shè)計(jì)13.1 總體設(shè)計(jì)13.2 功能分配13.3 接口設(shè)計(jì)13.4 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)13.4.1 公共數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)13.4.2 數(shù)據(jù)庫(kù)設(shè)計(jì)23.4.3 數(shù)據(jù)結(jié)構(gòu)同程序的關(guān)系*23.5 出錯(cuò)處理設(shè)計(jì)*23.6 其它*24 類(lèi)的設(shè)計(jì)24.1 類(lèi)1設(shè)計(jì)24.1.1 功能說(shuō)明24.1.2 屬性說(shuō)明24.1.3 公有方法說(shuō)明24.1.4 私有方法說(shuō)明24.2 類(lèi)2設(shè)計(jì)24.2.1 功能說(shuō)明24.2.2 屬性說(shuō)明24.2.3 公有方法說(shuō)明24.2.4 私有方法說(shuō)明25 用例實(shí)現(xiàn)的設(shè)

2、計(jì)35.1 用例1設(shè)計(jì)35.1.1 功能說(shuō)明35.1.2 界面設(shè)計(jì)35.1.3 交互設(shè)計(jì)35.2 用例2設(shè)計(jì)35.2.1 功能說(shuō)明35.2.2 界面設(shè)計(jì)35.2.3 交互設(shè)計(jì)3【注】本編寫(xiě)指南中帶有“*”標(biāo)志的表示可選部分，即在文檔編寫(xiě)過(guò)程中可以依據(jù)實(shí)際項(xiàng)目的具體情況進(jìn)行取舍，文檔完成后這些“*”標(biāo)記應(yīng)該去掉。設(shè)計(jì)說(shuō)明1 概述1.1 編寫(xiě)目的本文檔的編寫(xiě)目的是：詳細(xì)定義軟件的總體功能；給出系統(tǒng)的結(jié)構(gòu)設(shè)計(jì)和過(guò)程設(shè)計(jì)，作為程序編寫(xiě)的依據(jù)。1.2 參考資料包括：a.項(xiàng)目來(lái)源；b.本文檔中引用到的規(guī)范和資料等；c.列出這些規(guī)范和資料的作者、編號(hào)、標(biāo)題、發(fā)表日期、出版單位或資料來(lái)源。1.3 術(shù)語(yǔ)和縮寫(xiě)詞

3、*列出本文檔中用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞，縮寫(xiě)詞要給出中文譯名和英文全稱(chēng)，常用的不需要定義。2 需求概述概述系統(tǒng)的特性和需求，擴(kuò)充軟件需求說(shuō)明中的信息，給出增加的細(xì)節(jié)，詳盡地指出對(duì)軟件需求說(shuō)明中有關(guān)特性和需求作出的變更。（本次大作業(yè)只寫(xiě)：需求詳細(xì)說(shuō)明見(jiàn)需求說(shuō)明）。3 結(jié)構(gòu)設(shè)計(jì)3.1 總體設(shè)計(jì)繪制類(lèi)圖（Class Diagram），必要時(shí)輔以包圖（Package Diagram）和組件圖（Component Diagram）。對(duì)系統(tǒng)體系架構(gòu)和所繪制圖形加以文字說(shuō)明。3.2 功能分配說(shuō)明需求分析文檔當(dāng)中各個(gè)用例和類(lèi)的對(duì)應(yīng)關(guān)系，參見(jiàn)下圖。用例名功能簡(jiǎn)述參與類(lèi)用例1用例1的功能描述類(lèi)1、類(lèi)2用例2用

4、例2的功能描述類(lèi)2、類(lèi)33.3 接口設(shè)計(jì)對(duì)和硬件及其他外部系統(tǒng)的接口進(jìn)行說(shuō)明。3.4 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)3.4.1 公共數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)對(duì)程序當(dāng)中所定義的全局變量、全局?jǐn)?shù)據(jù)結(jié)構(gòu)或類(lèi)當(dāng)中Public數(shù)據(jù)結(jié)構(gòu)進(jìn)行定義和說(shuō)明。3.4.2 數(shù)據(jù)庫(kù)設(shè)計(jì)對(duì)程序當(dāng)中所采用的數(shù)據(jù)庫(kù)相關(guān)的名稱(chēng)和標(biāo)識(shí)符、在數(shù)據(jù)庫(kù)當(dāng)中的位置、定義、度量單位、格式和值域、敏感程度、數(shù)據(jù)項(xiàng)名、縮寫(xiě)詞和代碼，包括用于數(shù)據(jù)庫(kù)的規(guī)格說(shuō)明等進(jìn)行定義。建議給出數(shù)據(jù)庫(kù)表結(jié)構(gòu)。表3-1 商品表(Product)字段名類(lèi)型描述備注ProductIdint商品編號(hào)主鍵（自增）ProductName varchar(50)商品名稱(chēng)ProductTypevarcha

5、r(30)商品類(lèi)別SubTypevarchar(30)商品子類(lèi)別3.4.3 數(shù)據(jù)結(jié)構(gòu)同程序的關(guān)系*數(shù)據(jù)結(jié)構(gòu)影響最后的構(gòu)件（模塊）過(guò)程設(shè)計(jì)。因此，需要說(shuō)明數(shù)據(jù)結(jié)構(gòu)如何影響程序的數(shù)據(jù)組織、存取方式、結(jié)合程度和處理方法。3.5 出錯(cuò)處理設(shè)計(jì)*包括對(duì)出錯(cuò)輸出信息、出錯(cuò)處理對(duì)策的說(shuō)明。3.6 其它*說(shuō)明設(shè)計(jì)當(dāng)中對(duì)于安全保密、維護(hù)等情況的設(shè)計(jì)考慮。4 類(lèi)的設(shè)計(jì)對(duì)系統(tǒng)當(dāng)中主要的類(lèi)逐一進(jìn)行說(shuō)明。4.1 類(lèi)1設(shè)計(jì)4.1.1 功能說(shuō)明用文字形式簡(jiǎn)單的描述該類(lèi)的主要屬性、公用接口和內(nèi)部方法。4.1.2 屬性說(shuō)明4.1.3 公有方法說(shuō)明詳細(xì)描述類(lèi)的Public方法，包括輸入、輸出和實(shí)現(xiàn)算法。4.1.4 私有方法說(shuō)明詳

6、細(xì)描述類(lèi)的私有或保護(hù)方法，包括輸入、輸出和實(shí)現(xiàn)算法。4.2 類(lèi)2設(shè)計(jì)4.2.1 功能說(shuō)明用文字形式簡(jiǎn)單的描述該類(lèi)的主要屬性、公用接口和內(nèi)部方法。4.2.2 屬性說(shuō)明4.2.3 公有方法說(shuō)明詳細(xì)描述類(lèi)的Public方法，包括輸入、輸出和實(shí)現(xiàn)算法，復(fù)雜算法可以采用流程圖、PDL等方式加以說(shuō)明。4.2.4 私有方法說(shuō)明詳細(xì)描述類(lèi)的私有或保護(hù)方法，包括輸入、輸出和實(shí)現(xiàn)算法，復(fù)雜算法可以采用流程圖、PDL等方式加以說(shuō)明。5 用例實(shí)現(xiàn)的設(shè)計(jì)對(duì)需求分析文檔當(dāng)中所有用例的具體實(shí)現(xiàn)逐一進(jìn)行說(shuō)明。5.1 用例1設(shè)計(jì)5.1.1 功能說(shuō)明用文字形式簡(jiǎn)單的描述該用例的功能。5.1.2 界面設(shè)計(jì)采用用戶(hù)界面原型（如VB窗口）描述該用例的操作界面，說(shuō)明數(shù)據(jù)的輸入形式和驗(yàn)證手段，特殊的界面操作控制流程可適當(dāng)說(shuō)明。5.1.3 交互設(shè)計(jì)用順序圖（時(shí)序圖）描述該用例的具體實(shí)現(xiàn)，必要時(shí)可用多張交互圖描述。5.2 用例2設(shè)計(jì)5.2.1 功能說(shuō)明用文字形式簡(jiǎn)單的描述該用例的功能。5.2.2 界面設(shè)計(jì)采用用戶(hù)界面原