軟件工程詳細設計文檔模板

1、精選優(yōu)質文檔-傾情為你奉上軟件開發(fā)中心Software Development Center 詳細設計說明書項目名稱<項目名稱> 文檔類別<文檔類別>文檔編號<文檔編號>版 本<V1.0>密 級<秘密>二一二一年十二月二十日版本修訂記錄版本日期描 述作者審核目 錄1 引言1.1. 編寫目的簡要說明編寫這份詳細設計說明書的目的，指出預期的讀者。本詳細設計說明書的編寫目的是為了說明程序系統(tǒng)的各個層次中的每個軟件對象（包括每個模塊和程序）的設計考慮，以向系統(tǒng)實現（編碼和測試）階段提供關于程序系統(tǒng)實現方式的詳細描述，從而成為編碼的技術基礎。本

2、詳細設計說明書的適用讀者為：軟件開發(fā)者、測試人員1.2. 項目概況1.說明待開發(fā)的軟件系統(tǒng)的名稱2.列出本項目的任務委托單位、開發(fā)單位、協(xié)作單位、用戶單位3.說明項目背景，敘述該項軟件開發(fā)的意圖、應用目標、作用范圍以及其他應向讀者說明的有關該軟件開發(fā)的背景材料。如果本次開發(fā)的軟件系統(tǒng)是一個更大的系統(tǒng)的一個組成部分，則要說明該更大系統(tǒng)的組成和介紹本系統(tǒng)與其它相關系統(tǒng)的關系和接口部分4.保密說明：本項為可選項，一般的軟件公司都會要求對軟件開發(fā)的概要設計文檔進行保密，不允許被復制、使用和擴散到公司之外的范圍，如果需要強調則允許做相關的保密說明5.版權說明：本項為可選項，若有必要，才要作有關的描述。1

3、.3. 術語定義列出本文檔中所引用到的專門術語的定義和首字母縮寫詞、縮略語的原文，以便對詳細設計說明書進行適當的解釋1.4. 參考資料列出所本文檔所使用的參考資料，包括：A 本軟件開發(fā)所經核準的合同或標書或可行性報告等文檔B 軟件開發(fā)計劃書C 需求分析報告D 測試方案（若存在初稿的話）E 概要設計說明書F 與本項目有關的已發(fā)表的文件或資料G 本文件中各處引用的文件、資料，所采用的軟件開發(fā)標準和規(guī)范注意：必須列出文件、資料的作者、標題、編號、發(fā)表日期和出版單位，以說明這些文件資料的來源。若某些文檔有保密要求的，則要說明其保密級別。2 系統(tǒng)概述概要地介紹本軟件系統(tǒng)，只要求提供影響詳細設計的一般因素

4、，不必太詳細地描述大量細節(jié)，本章主要目的僅僅是使本詳細設計說明書更加易于理解，建議根據系統(tǒng)設計的實際需要可以有選擇地從以下方面進行概要描述：系統(tǒng)體系結構、系統(tǒng)功能分布和層次結構、程序實現風格或方式2.1. 系統(tǒng)體系結構畫出系統(tǒng)的體系結構圖，以說明系統(tǒng)體系結構的實現技術，所用到的數據庫主體的描述、如何實現訪問數據庫、如何劃分程序的主體部分2.2. 系統(tǒng)功能分布和層次結構主要介紹本軟件系統(tǒng)程序組織的結構，包括各個功能模塊的劃分，可以用模塊層次結構圖來表示，以說明各個模塊之間的相互調用關系，或者也可以用一系列的圖表來列出本程序系統(tǒng)內的每個程序（包括各個模塊或子程序）的名稱、標識符和它們之間的層次結構

5、關系。程序組織的層次結構關系可用表格形式進行描述，建議如下表：模塊名稱模塊編號子模塊名稱功能說明子模塊編號3 程序設計詳細描述從本章開始，逐個地給出程序組織結構中各個層次的每個程序的設計考慮，每一程序模塊的詳細設計描述單獨為一節(jié)，標題格式為：模塊名稱（模塊編號）設計說明，例如：3.1主界面 untMsgMain frmMsgMain（）設計說明。對每個程序模塊（包括存儲過程的設計），建議分別從以下幾個方面進行描述：注明該功能模塊的編號和模塊名稱模塊功能簡述界面(包括屏幕編號，屏幕圖片，控件說明)所調用的模塊（包括控件）的說明變量說明函數/過程列表函數/過程說明（包括輸入、輸出和處理邏輯）測試要

6、求：主要說明本模塊進行單元測試的要點或注意事項出錯處理尚未解決的問題參考以下范例，允許根據實際需要進行裁剪：3.1. 客戶開銷戶分類(Sp)設計說明模塊編號052 盤后查詢源程序文件Sp源程序名稱客戶開銷戶分類功能查詢客戶的開銷戶情況匯總，包括開戶數、銷戶數，正?？蛻?源碼類型后臺SP相關源程序文件khkxhfl.jsp修改歷史紀錄修改人日期描述XieYing05/22/2000Initial被調用模塊Web前臺khkxhfl.jsp調用模塊輸入參數iyybdmChar(3)營業(yè)部代碼iksrqChar(8)開始日期ijsrqChar(8)結束日期輸出參數oerrorChar(20)錯誤代碼o

7、textChar(100)錯誤信息結果集列表Numeric柜臺開戶數Numeric柜臺銷戶數Numeric條碼開戶數Numeric條碼銷戶數Numeric銀行開戶數Numeric銀行銷戶數Numeric滬A股開戶數Numeric滬A股銷戶數Numeric深A股開戶數Numeric深A股銷戶數Numeric滬B股開戶數Numeric滬B股銷戶數Numeric深B股開戶數Numeric深B股銷戶數數據域說明臨時表要訪問的表要做修改的表客戶基本資料 Khjbzl股東代碼表 Gddmb客戶條碼 khtm客戶銀行帳號 Khyhzh報表提示信息備注邏輯處理說明分解參數。（包括參數出錯處理）調用SP WEB

8、MENUCHK，傳入參數ibycs4（userid）、ibycs5（菜單代碼）、ibycs6（password）、ibycs7（客戶端IP）執(zhí)行權限校驗，獲得其返回參數oerror,otext.3If （SP WEBMENUCHK的返回參數oerror<> “CCS0000” ）then把SP WEBMENUCHK的返回參數oerror,otext. 分別賦給此sp 的返回參數oerror,otext.并返回。End program。Else31計算數據柜臺開戶：SELECT COUNT（*）FROM 客戶基本資料KHJBZLWHERE 開戶時間前8位 滿足 輸入日期或日期段AND

9、 營業(yè)部代碼 = 輸入的營業(yè)部代碼。柜臺銷戶：SELECT COUNT（*）FROM 客戶基本資料KHJBZLWHERE 銷戶時間前8位 滿足 輸入日期或日期段AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。銀行開戶：SELECT COUNT（*）FROM 銀行表_客戶銀行帳號KHYHZHWHERE 開戶時間前8位 滿足 輸入日期或日期段AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。銀行銷戶：SELECT COUNT（*）FROM 銀行表_客戶銀行帳號KHYHZHWHERE 銷戶時間前8位 滿足 輸入日期或日期段AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。條碼開戶：SELECT COUNT（*）FROM

10、客戶條碼表KHTMWHERE 開戶時間前8位 滿足 輸入日期或日期段AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。條碼銷戶：SELECT COUNT（*）FROM 客戶條碼表KHTMWHERE 銷戶時間前8位 滿足 輸入日期或日期段AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。深A股開戶：SELECT COUNT（*）FROM 股東帳號表GDDMBWHERE 開戶時間前8位 滿足 輸入日期或日期段 AND 市場代碼 = “2”/*深A*/AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。深A股銷戶：SELECT COUNT（*）FROM 股東帳號表GDDMBWHERE 銷戶時間前8位 滿足 輸入日期或日期段A

11、ND 市場代碼 = “2” /*深A*/AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。深B股開戶：SELECT COUNT（*）FROM 股東帳號表GDDMBWHERE 開戶時間前8位 滿足 輸入日期或日期段 AND 市場代碼 = “4” /*深B*/AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。深B股銷戶：SELECT COUNT（*）FROM 股東帳號表GDDMBWHERE 銷戶時間前8位 滿足 輸入日期或日期段AND 市場代碼 = “4” /*深B*/AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。滬A股開戶：SELECT COUNT（*）FROM 股東帳號表GDDMBWHERE 開戶時間前8位 滿足

12、 輸入日期或日期段 AND 市場代碼 = “1”/*滬A*/AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。滬A股銷戶：SELECT COUNT（*）FROM 股東帳號表GDDMBWHERE 銷戶時間前8位 滿足 輸入日期或日期段AND 市場代碼 = “1” /*滬A*/AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。滬B股開戶：SELECT COUNT（*）FROM 股東帳號表GDDMBWHERE 開戶時間前8位 滿足 輸入日期或日期段 AND 市場代碼 = “3” /*滬B*/AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。滬B股銷戶：SELECT COUNT（*）FROM 股東帳號表GDDMBWHERE

13、銷戶時間前8位 滿足 輸入日期或日期段AND 市場代碼 = “3” /*滬B*/AND 營業(yè)部代碼 = 輸入的營業(yè)部代碼。股東開戶：滬A股開戶+深A股開戶+滬B股開戶 + 深B股開戶股東銷戶：滬A股銷戶+深A股銷戶+滬B股銷戶 + 深B股銷戶if 取數據出錯 then 非“CCS0000”的錯誤代碼賦值給本sp 的返回參數oerror；出錯信息返回給本sp 的返回參數otext；返回參數；end program；else if 沒有取到數據該數據強制為其缺省值；32 取表Cxtjlsb中，字段“序列號”的最大值，并加1，作為此次插入的一批數據的序列號insert序列號；柜臺開戶數；柜臺銷戶數；

14、條碼開戶數；條碼銷戶數；銀行開戶數；銀行銷戶數；股東開戶數；滬A股開戶數；深A股開戶數；滬B股開戶數；深B股開戶數。 Into Cxtjlsbdeclare cursor for select 柜臺開戶數；柜臺銷戶數；條碼開戶數；條碼銷戶數；銀行開戶數；銀行銷戶數；股東開戶數；滬A股開戶數；深A股開戶數；滬B股開戶數；深B股開戶數。Where 表中字段“序列號” = 此批插入數據的序列號。open cursor 35 把SP WEBMENUCHK的返回參數oerror,otext. 分別賦給此sp 的返回參數oerror,otext.并返回。36 end program。輸入界面屏幕編號：a主

15、要控件說明：輸出界面屏幕編號：b主要控件說明：測試要求出錯處理遺留問題4 公用接口程序設計說明給出各類公用接口的程序的設計考慮，如全局變量、公用界面、公用函數和過程等。4.1. 全局變量羅列各個全局變量的屬性要求，包括全局變量名稱、說明、數據類型、長度、取值范圍等信息4.2. 公用界面要求描述清楚公用界面的界面布局情況，以及界面上所涉及到的各種數據項的相關屬性，與界面相關的詳細處理說明（有邏輯算法和計算公式，則要詳細說明）、輸入和輸出數據要求等等，要求要附有界面的書面格式，可詳細注明參見某個圖表或某個相關附件4.3. 公用函數和過程介紹公用函數和過程所實現的主要功能，說明公用函數和過程所需調用的輸入參數、輸出參數以及邏輯處理