系統(tǒng)詳細(xì)設(shè)計(jì)說(shuō)明書

1、XXXXXXXXXXXXXXXXXXX項(xiàng)目名稱詳細(xì)設(shè)計(jì)說(shuō)明書XXX公司OXX年X月文檔修改記錄版本號(hào)版本描述責(zé)任人日期備注V1.0初始編制XXXX2012-8-31版本號(hào)示例：V1.0、V2.0、V3.0、V4.0、V5.0第一章引言1.1目的1.2背景1.3術(shù)語(yǔ)定義1.4參考資料第二章系統(tǒng)概述第三章程序1設(shè)計(jì)說(shuō)明3.1程序描述3.1.1模塊架構(gòu)圖3.1.2功能3.1.3類圖3.1.4增加功能（功能點(diǎn)）3.1.5程序流程3.1.6測(cè)試和限制條件3.1.7備注第四章程序2設(shè)計(jì)說(shuō)明第五章公用接口程序說(shuō)明5.1全局變量5.2公用界面或接口5.3公用方法和過(guò)程第六章附件詳細(xì)設(shè)計(jì)評(píng)審意見(jiàn)1.1目的提示：

2、簡(jiǎn)要說(shuō)明編寫這份詳細(xì)設(shè)計(jì)說(shuō)明書的目的，指出預(yù)期的讀者。本詳細(xì)設(shè)計(jì)說(shuō)明書的適用讀者為：軟件開(kāi)發(fā)者、測(cè)試人員1.2背景1.3術(shù)語(yǔ)定義序號(hào)術(shù)語(yǔ)名稱術(shù)語(yǔ)定義1234.1.4參考資料提示：列出所本文檔所使用的參考資料，包括:本軟件開(kāi)發(fā)所經(jīng)核準(zhǔn)的合同或標(biāo)書或可行性報(bào)告等文檔 軟件開(kāi)發(fā)計(jì)劃書 需求分析報(bào)告 測(cè)試方案（若存在初稿的話） 概要設(shè)計(jì)說(shuō)明書 與本項(xiàng)目有關(guān)的已發(fā)表的文件或資料 本文件中各處引用的文件、資料，所采用的軟件開(kāi)發(fā)標(biāo)準(zhǔn)和規(guī)范注意：必須列出文件、資料的作者、標(biāo)題、編號(hào)、發(fā)表日期和出版單位，以說(shuō)明這些文件資料的來(lái)源。若某些文檔有保密要求的，則要說(shuō)明其保密級(jí)別。序號(hào)文檔名稱作者版本/日期123第一章

3、引言1系統(tǒng)概述畫出系統(tǒng)的體系結(jié)構(gòu)圖，以說(shuō)明系統(tǒng)體系結(jié)構(gòu)的實(shí)現(xiàn)技術(shù)，所用到的數(shù)據(jù)庫(kù)主體的描述、 如何實(shí)現(xiàn)訪問(wèn)數(shù)據(jù)庫(kù)、如何劃分程序的主體部分?？梢圆捎孟到y(tǒng)設(shè)計(jì)主要是基于MVC設(shè)計(jì)模式，M代表模型Model,V代表視圖View，C代表控制器Controller。MVC模式將系統(tǒng)分為三層，層與層之間通過(guò)又一定的模式聯(lián)系，使數(shù)據(jù)實(shí)體與業(yè) 務(wù)邏輯、業(yè)務(wù)邏輯與頁(yè)面展現(xiàn)分離。MVC模式圖舉例如下圖:圖二-1 MVC模式圖MVC模式表述、也可以采用UML中Model層Web BrowseJSF Bean9: 7.returnserviceDAOEn tity Bea nDataBase5: 3.execute

4、En tityDAO6:4.op erate En tity Bea n7: 5.DB reflection8: 6.return1View層Controller層1:.Request2: 2.call method3 3.return第二章程序1設(shè)計(jì)說(shuō)明提示：從本章開(kāi)始，逐步將各模塊的功能和設(shè)計(jì)思想、內(nèi)容等進(jìn)行逐層解剖分析3.1程序描述提示：給出對(duì)該程序的簡(jiǎn)要描述，主要說(shuō)明安排設(shè)計(jì)本程序的目的意義，并且，還要說(shuō)明 本程序的特點(diǎn)。3.1.1模塊架構(gòu)圖提示：給出模塊的代碼結(jié)構(gòu)，如典型的三層結(jié)構(gòu)，可以用UML的組件圖表達(dá)。3.1.2功能提示：簡(jiǎn)要進(jìn)行功能描述，可采用IPO（即輸入-處理-輸出圖）表

5、示。3.1.3類圖提示：用UML類圖利用面向?qū)ο笏枷朐O(shè)計(jì)模塊代碼實(shí)現(xiàn)，用類圖表達(dá)出完整的類結(jié)構(gòu)，包 括類名，屬性，主要方法名稱，方法參數(shù)，關(guān)鍵的方法或算法可以用標(biāo)注的方法，用偽碼表達(dá) 出來(lái)。類圖中要表示出類與類之間關(guān)系，從屬關(guān)系、調(diào)用關(guān)系等。UML類圖舉例如下:圖三-1類圖注意，重要的方法要做詳細(xì)的說(shuō)明，舉例如下:說(shuō)明:1. BaseAbsDaoa) getAll():返回所有信息的列表。b)getByld(string id):根據(jù)id檢索，并返回特定的對(duì)象。2. BaseBea：3.1.4增加功能(功能點(diǎn))提示：簡(jiǎn)要進(jìn)行功能描述，可采用IPO(即輸入-處理-輸出圖)表示。3.1.4.1功能

6、描述增加機(jī)構(gòu)的管理信息。3.1.4.2輸入和界面設(shè)計(jì)提示：圖、表方式清晰描述每一個(gè)輸入項(xiàng)的特性，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式、 數(shù)據(jù)值的有效范圍、輸入的方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來(lái)源和安全保密條件等3.1.4.3類和接口設(shè)計(jì)提示：列出本模塊與其它模塊的接口關(guān)系或要求列明所有接口，包括接口名稱，調(diào)用方 法，接口參數(shù)結(jié)構(gòu)等。1.接口：接口名稱:接口方法:輸入?yún)?shù):返回信息:2.數(shù)據(jù)接口:3.其他接口:3.1.5程序流程提示：以流程圖或順序圖形式給出本程序模塊流轉(zhuǎn)關(guān)系。包括一下參數(shù):輸入?yún)?shù):處理過(guò)程:涉及的數(shù)據(jù)結(jié)構(gòu):返回結(jié)果:其他參數(shù):3.1.6測(cè)試和限制條件提示：給出詳細(xì)設(shè)計(jì)中考

7、慮的測(cè)試程序測(cè)試點(diǎn)和狀態(tài)、參數(shù)等，以及對(duì)系統(tǒng)在程序運(yùn)行、 測(cè)試時(shí)需要做出的各種限制等。3.1.7備注第四章 程序2設(shè)計(jì)說(shuō)明提示：與上一章類似，若有N個(gè)，則需要分開(kāi)N項(xiàng)描述。第六章附件第五章公用接口程序說(shuō)明提示：給出各類公用接口的程序的設(shè)計(jì)考慮，如全局變量、數(shù)據(jù)字典、公用界面、公用方法和過(guò)程等。5.1全局變量提示：羅列各個(gè)全局變量的屬性要求，包括全局變量名稱、說(shuō)明、數(shù)據(jù)類型、長(zhǎng)度、取值范圍等信息名稱說(shuō)明數(shù)據(jù)類型長(zhǎng)度取值范圍5.2公用界面或接口提示：要求描述清楚公用界面的界面布局情況，以及界面上所涉及到的各種數(shù)據(jù)項(xiàng)的相關(guān)屬性，與界面相關(guān)的詳細(xì)處理說(shuō)明（有邏輯算法和計(jì)算公式，則要詳細(xì)說(shuō)明）、輸入和輸出數(shù)據(jù)要求等等，要求要附有界面的書面格式，可詳細(xì)注明參見(jiàn)某個(gè)圖表或某個(gè)相關(guān)附件5.3公用方法和過(guò)程提示：介紹公用方法和過(guò)程所實(shí)現(xiàn)的主要功能，說(shuō)明公用方法和過(guò)程所需調(diào)用的輸入?yún)?shù)、輸出參數(shù)以及邏輯處理和相關(guān)算法描述，并注明該公用方法和過(guò)程的適用范圍。可以使用表格形式表述。提示：羅列與本詳細(xì)設(shè)計(jì)報(bào)告相關(guān)的文檔資料，可包括以下內(nèi)容：1.數(shù)據(jù)庫(kù)設(shè)計(jì)的有關(guān)文檔資料，如：數(shù)據(jù)字典2.用戶界面有關(guān)約定、相關(guān)報(bào)表或模板格式、各種常規(guī)底稿模板等3.編程語(yǔ)言程序設(shè)計(jì)規(guī)范4.其它相關(guān)資料第六章附件詳細(xì)設(shè)計(jì)評(píng)審意見(jiàn)我方根據(jù)合同的有關(guān)規(guī)定完成了項(xiàng)目 制，并經(jīng)項(xiàng)目經(jīng)理審查批準(zhǔn)，請(qǐng)