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

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

圖STYLEREF1\s2-SEQ圖\*ARABIC\s11MVC模式圖程序1設(shè)計闡明提示：從本章開始，逐步將各模塊的功效和設(shè)計思想、內(nèi)容等進(jìn)行逐級解剖分析程序描述提示：給出對該程序的簡要描述，重要闡明安排設(shè)計本程序的目的意義，并且，還要闡明本程序的特點。模塊架構(gòu)圖提示：給出模塊的代碼構(gòu)造，如典型的三層構(gòu)造，能夠用UML的組件圖體現(xiàn)。功效提示：簡要進(jìn)行功效描述，可采用IPO（即輸入-解決-輸出圖）表達(dá)。類圖提示：用UML類圖運(yùn)用面對對象思想設(shè)計模塊代碼實現(xiàn)，用類圖體現(xiàn)出完整的類構(gòu)造，涉及類名，屬性，重要辦法名稱，辦法參數(shù)，核心的辦法或算法能夠用標(biāo)注的辦法，用偽碼體現(xiàn)出來。類圖中要表達(dá)出類與類之間關(guān)系，附屬關(guān)系、調(diào)用關(guān)系等。UML類圖舉例以下：

圖STYLEREF1\s3-SEQ圖\*ARABIC\s11類圖注意，重要的辦法要做具體的闡明，舉例以下：闡明：BaseAbsDao：getAll():返回全部信息的列表。getById(stringid):根據(jù)id檢索，并返回特定的對象。BaseBean：……增加功效（功效點）提示：簡要進(jìn)行功效描述，可采用IPO（即輸入-解決-輸出圖）表達(dá)。功效描述增加機(jī)構(gòu)的管理信息。輸入和界面設(shè)計提示：圖、表方式清晰描述每一種輸入項的特性，涉及名稱、標(biāo)記、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范疇、輸入的方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來源和安全保密條件等類和接口設(shè)計提示：列出本模塊與其它模塊的接口關(guān)系或規(guī)定列明全部接口，涉及接口名稱，調(diào)用辦法，接口參數(shù)構(gòu)造等。接口：接口名稱：接口辦法：輸入?yún)?shù)：返回信息：數(shù)據(jù)接口：其它接口：程序流程提示：以流程圖或次序圖形式給出本程序模塊流轉(zhuǎn)關(guān)系。涉及一下參數(shù)：輸入?yún)?shù)：解決過程：涉及的數(shù)據(jù)構(gòu)造：返回成果：其它參數(shù)：測試和限制條件提示：給出具體設(shè)計中考慮的測試程序測試點和狀態(tài)、參數(shù)等，以及對系統(tǒng)在程序運(yùn)行、測試時需要做出的多個限制等。備注程序2設(shè)計闡明提示：與上一章類似，若有N個，則需要分開N項描述。公用接口程序闡明提示：給出各類公用接口的程序的設(shè)計考慮，如全局變量、數(shù)據(jù)字典、公用界面、公用辦法和過程等。全局變量提示：羅列各個全局變量的屬性規(guī)定，涉及全局變量名稱、闡明、數(shù)據(jù)類型、長度、取值范疇等信息名稱闡明數(shù)據(jù)類型長度取值范疇公用界面或接口提示：規(guī)定描述清晰公用界面的界面布局狀況，以及界面上所涉及到的多個數(shù)據(jù)項的有關(guān)屬性，與界面有關(guān)的具體解決闡明（有邏輯算法和計算公式，則要具體闡明）、輸入和輸出數(shù)據(jù)規(guī)定等等，規(guī)定要附有界面的書面格式，可具體注明參見某個圖表或某個有關(guān)附件公用辦法和過程提示：介紹公用辦法和過程所實現(xiàn)的重要功效，闡明公用辦法和過程所需調(diào)用的輸入?yún)?shù)、輸出參數(shù)以及邏輯解決和有關(guān)算法描述，并注明該公用辦法和過程的合用范疇。能夠使用表格形式表述。 附件提示：羅列與本具體設(shè)計報告有關(guān)的文檔資料，可涉及下列內(nèi)容：數(shù)據(jù)庫設(shè)計的有關(guān)文檔資料，如：數(shù)據(jù)字典顧客界面有關(guān)商定、有關(guān)報表或模板格式、多個常規(guī)底稿模板等編程語言程序設(shè)計規(guī)范其它有關(guān)資料具體設(shè)計評審意見項目名稱：致：（建設(shè)單位）抄送：（監(jiān)理單位）我方根據(jù)合同的有關(guān)規(guī)定完畢了項目具體設(shè)計闡明書的編制，并經(jīng)項目經(jīng)理審查同意，請予以審查。承建單位（蓋章）項目經(jīng)理（簽字）：日期：年月日監(jiān)理單位意見：總/專業(yè)監(jiān)理工程師（簽字）：