系統(tǒng)詳細設計說明書

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

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

3、引言1系統(tǒng)概述畫出系統(tǒng)的體系結構圖，以說明系統(tǒng)體系結構的實現技術，所用到的數據庫主體的描述、 如何實現訪問數據庫、如何劃分程序的主體部分?？梢圆捎孟到y(tǒng)設計主要是基于MVC設計模式，M代表模型Model,V代表視圖View，C代表控制器Controller。MVC模式將系統(tǒng)分為三層，層與層之間通過又一定的模式聯(lián)系，使數據實體與業(yè) 務邏輯、業(yè)務邏輯與頁面展現分離。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設計說明提示：從本章開始，逐步將各模塊的功能和設計思想、內容等進行逐層解剖分析3.1程序描述提示：給出對該程序的簡要描述，主要說明安排設計本程序的目的意義，并且，還要說明 本程序的特點。3.1.1模塊架構圖提示：給出模塊的代碼結構，如典型的三層結構，可以用UML的組件圖表達。3.1.2功能提示：簡要進行功能描述，可采用IPO（即輸入-處理-輸出圖）表

5、示。3.1.3類圖提示：用UML類圖利用面向對象思想設計模塊代碼實現，用類圖表達出完整的類結構，包 括類名，屬性，主要方法名稱，方法參數，關鍵的方法或算法可以用標注的方法，用偽碼表達 出來。類圖中要表示出類與類之間關系，從屬關系、調用關系等。UML類圖舉例如下:圖三-1類圖注意，重要的方法要做詳細的說明，舉例如下:說明:1. BaseAbsDaoa) getAll():返回所有信息的列表。b)getByld(string id):根據id檢索，并返回特定的對象。2. BaseBea：3.1.4增加功能(功能點)提示：簡要進行功能描述，可采用IPO(即輸入-處理-輸出圖)表示。3.1.4.1功能

6、描述增加機構的管理信息。3.1.4.2輸入和界面設計提示：圖、表方式清晰描述每一個輸入項的特性，包括名稱、標識、數據的類型和格式、 數據值的有效范圍、輸入的方式。數量和頻度、輸入媒體、輸入數據的來源和安全保密條件等3.1.4.3類和接口設計提示：列出本模塊與其它模塊的接口關系或要求列明所有接口，包括接口名稱，調用方 法，接口參數結構等。1.接口：接口名稱:接口方法:輸入參數:返回信息:2.數據接口:3.其他接口:3.1.5程序流程提示：以流程圖或順序圖形式給出本程序模塊流轉關系。包括一下參數:輸入參數:處理過程:涉及的數據結構:返回結果:其他參數:3.1.6測試和限制條件提示：給出詳細設計中考

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