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

年4月19日系統(tǒng)詳細(xì)設(shè)計(jì)說(shuō)明書模板文檔僅供參考XXXXXXXXXXXXXXXXXXX項(xiàng)目名稱詳細(xì)設(shè)計(jì)說(shuō)明書XXX公司二〇年月文檔修改記錄版本號(hào)版本描述責(zé)任人日期備注V1.0初始編制XXXX-8-版本號(hào)示例：V1.0、V2.0、V3.0、V4.0、V5.0……目錄第一章 引言 41.1 目的 41.2 背景 41.3 術(shù)語(yǔ)定義 41.4 參考資料 4第二章 系統(tǒng)概述 6第三章 程序1設(shè)計(jì)說(shuō)明 73.1 程序描述 73.1.1 模塊架構(gòu)圖 73.1.2 功能 73.1.3 類圖 73.1.4 增加功能（功能點(diǎn)） 83.1.5 程序流程 93.1.6 測(cè)試和限制條件 93.1.7 備注 9第四章 程序2設(shè)計(jì)說(shuō)明 10第五章 公用接口程序說(shuō)明 115.1 全局變量 115.2 公用界面或接口 115.3 公用方法和過(guò)程 11第六章 附件 12詳細(xì)設(shè)計(jì)評(píng)審意見(jiàn) 13引言目的提示：簡(jiǎn)要說(shuō)明編寫這份詳細(xì)設(shè)計(jì)說(shuō)明書的目的，指出預(yù)期的讀者。本詳細(xì)設(shè)計(jì)說(shuō)明書的適用讀者為：軟件開(kāi)發(fā)者、測(cè)試人員背景術(shù)語(yǔ)定義序號(hào)術(shù)語(yǔ)名稱術(shù)語(yǔ)定義1234….參考資料提示：列出所本文檔所使用的參考資料，包括：A本軟件開(kāi)發(fā)所經(jīng)核準(zhǔn)的合同或標(biāo)書或可行性報(bào)告等文檔B軟件開(kāi)發(fā)計(jì)劃書C需求分析報(bào)告D測(cè)試方案（若存在初稿的話）E概要設(shè)計(jì)說(shuō)明書F與本項(xiàng)目有關(guān)的已發(fā)表的文件或資料G本文件中各處引用的文件、資料，所采用的軟件開(kāi)發(fā)標(biāo)準(zhǔn)和規(guī)范注意：必須列出文件、資料的作者、標(biāo)題、編號(hào)、發(fā)表日期和出版單位，以說(shuō)明這些文件資料的來(lái)源。若某些文檔有保密要求的，則要說(shuō)明其保密級(jí)別。序號(hào)文檔名稱作者版本/日期123系統(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ù)、如何劃分程序的主體部分。能夠采用MVC模式表述、也能夠采用UML中的系統(tǒng)設(shè)計(jì)主要是基于MVC設(shè)計(jì)模式，M代表模型Model，V代表視圖View，C代表控制器Controller。MVC模式將系統(tǒng)分為三層，層與層之間經(jīng)過(guò)又一定的模式聯(lián)系，使數(shù)據(jù)實(shí)體與業(yè)務(wù)邏輯、業(yè)務(wù)邏輯與頁(yè)面展現(xiàn)分離。MVC模式圖舉例如下圖：

圖STYLEREF1\s2-SEQ圖\*ARABIC\s11MVC模式圖程序1設(shè)計(jì)說(shuō)明提示：從本章開(kāi)始，逐步將各模塊的功能和設(shè)計(jì)思想、內(nèi)容等進(jìn)行逐層解剖分析程序描述提示：給出對(duì)該程序的簡(jiǎn)要描述，主要說(shuō)明安排設(shè)計(jì)本程序的目的意義，而且，還要說(shuō)明本程序的特點(diǎn)。模塊架構(gòu)圖提示：給出模塊的代碼結(jié)構(gòu)，如典型的三層結(jié)構(gòu)，能夠用UML的組件圖表示。功能提示：簡(jiǎn)要進(jìn)行功能描述，可采用IPO（即輸入-處理-輸出圖）表示。類圖提示：用UML類圖利用面向?qū)ο笏枷朐O(shè)計(jì)模塊代碼實(shí)現(xiàn)，用類圖表示出完整的類結(jié)構(gòu)，包括類名，屬性，主要方法名稱，方法參數(shù)，關(guān)鍵的方法或算法能夠用標(biāo)注的方法，用偽碼表示出來(lái)。類圖中要表示出類與類之間關(guān)系，從屬關(guān)系、調(diào)用關(guān)系等。UML類圖舉例如下：

圖STYLEREF1\s3-SEQ圖\*ARABIC\s11類圖注意，重要的方法要做詳細(xì)的說(shuō)明，舉例如下：說(shuō)明：BaseAbsDao：getAll():返回所有信息的列表。getById(stringid):根據(jù)id檢索，并返回特定的對(duì)象。BaseBean：……增加功能（功能點(diǎn)）提示：簡(jiǎn)要進(jìn)行功能描述，可采用IPO（即輸入-處理-輸出圖）表示。功能描述增加機(jī)構(gòu)的管理信息。輸入和界面設(shè)計(jì)提示：圖、表方式清晰描述每一個(gè)輸入項(xiàng)的特性，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入的方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來(lái)源和安全保密條件等類和接口設(shè)計(jì)提示：列出本模塊與其它模塊的接口關(guān)系或要求列明所有接口，包括接口名稱，調(diào)用方法，接口參數(shù)結(jié)構(gòu)等。接口：接口名稱：接口方法：輸入?yún)?shù)：返回信息：數(shù)據(jù)接口：其它接口：程序流程提示：以流程圖或順序圖形式給出本程序模塊流轉(zhuǎn)關(guān)系。包括一下參數(shù)：輸入?yún)?shù)：處理過(guò)程：涉及的數(shù)據(jù)結(jié)構(gòu)：返回結(jié)果：其它參數(shù)：測(cè)試和限制條件提示：給出詳細(xì)設(shè)計(jì)中考慮的測(cè)試程序測(cè)試點(diǎn)和狀態(tài)、參數(shù)等，以及對(duì)系統(tǒng)在程序運(yùn)行、測(cè)試時(shí)需要做出的各種限制等。備注程序2設(shè)計(jì)說(shuō)明提示：與上一章類似，若有N個(gè)，則需要分開(kāi)N項(xiàng)描述。公用接口程序說(shuō)明提示：給出各類公用接口的程序的設(shè)計(jì)考慮，如全局變量、數(shù)據(jù)字典、公用界面、公用方法和過(guò)程等。全局變量提示：羅列各個(gè)全局變量的屬性要求，包括全局變量名稱、說(shuō)明、數(shù)據(jù)類型、長(zhǎng)度、取值范圍等信息名稱說(shuō)明數(shù)據(jù)類型長(zhǎng)度取值范圍公用界面或接口提示：要求描述清楚公用界面的界面布局情況，以及界面上所涉及到的各種數(shù)據(jù)項(xiàng)的相關(guān)屬性，與界面相關(guān)的詳細(xì)處理說(shuō)明（有邏輯算法和計(jì)算公式，則要詳細(xì)說(shuō)明）、輸入和輸出數(shù)據(jù)要求等等，要求要附有界面的書面格式，可詳細(xì)注明參見(jiàn)某個(gè)圖表或某個(gè)相關(guān)附件公用方法和過(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)容：數(shù)據(jù)庫(kù)設(shè)計(jì)的有關(guān)文檔資料，如：數(shù)據(jù)字典用戶界面有關(guān)約定、相關(guān)報(bào)表或模板格式、各種常規(guī)底稿模板等編程語(yǔ)言程序設(shè)計(jì)規(guī)范其它相關(guān)資料詳細(xì)設(shè)計(jì)評(píng)審意見(jiàn)項(xiàng)目名稱：致：（建設(shè)單位）抄送：（監(jiān)理單位）我方根據(jù)合同的有關(guān)規(guī)定完成了項(xiàng)目詳細(xì)設(shè)計(jì)說(shuō)明書的編制，并經(jīng)項(xiàng)目經(jīng)理審查批準(zhǔn)，請(qǐng)予以審查。承建單位（蓋章）項(xiàng)目經(jīng)理（簽字）：日期：年