軟件工程詳細(xì)設(shè)計(jì)文檔模板

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

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

3、.3. 術(shù)語(yǔ)定義列出本文檔中所引用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和首字母縮寫(xiě)詞、縮略語(yǔ)的原文，以便對(duì)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)進(jìn)行適當(dāng)?shù)慕忉?.4. 參考資料列出所本文檔所使用的參考資料，包括：A 本軟件開(kāi)發(fā)所經(jīng)核準(zhǔn)的合同或標(biāo)書(shū)或可行性報(bào)告等文檔B 軟件開(kāi)發(fā)計(jì)劃書(shū)C 需求分析報(bào)告D 測(cè)試方案（若存在初稿的話）E 概要設(shè)計(jì)說(shuō)明書(shū)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í)別。2 系統(tǒng)概述概要地介紹本軟件系統(tǒng)，只要求提供影響詳細(xì)設(shè)計(jì)的一般因素

4、，不必太詳細(xì)地描述大量細(xì)節(jié)，本章主要目的僅僅是使本詳細(xì)設(shè)計(jì)說(shuō)明書(shū)更加易于理解，建議根據(jù)系統(tǒng)設(shè)計(jì)的實(shí)際需要可以有選擇地從以下方面進(jìn)行概要描述：系統(tǒng)體系結(jié)構(gòu)、系統(tǒng)功能分布和層次結(jié)構(gòu)、程序?qū)崿F(xiàn)風(fēng)格或方式2.1. 系統(tǒng)體系結(jié)構(gòu)畫(huà)出系統(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ù)、如何劃分程序的主體部分2.2. 系統(tǒng)功能分布和層次結(jié)構(gòu)主要介紹本軟件系統(tǒng)程序組織的結(jié)構(gòu)，包括各個(gè)功能模塊的劃分，可以用模塊層次結(jié)構(gòu)圖來(lái)表示，以說(shuō)明各個(gè)模塊之間的相互調(diào)用關(guān)系，或者也可以用一系列的圖表來(lái)列出本程序系統(tǒng)內(nèi)的每個(gè)程序（包括各個(gè)模塊或子程序）的名稱(chēng)、標(biāo)識(shí)符和它們之間的層次結(jié)構(gòu)

5、關(guān)系。程序組織的層次結(jié)構(gòu)關(guān)系可用表格形式進(jìn)行描述，建議如下表：模塊名稱(chēng)模塊編號(hào)子模塊名稱(chēng)功能說(shuō)明子模塊編號(hào)3 程序設(shè)計(jì)詳細(xì)描述從本章開(kāi)始，逐個(gè)地給出程序組織結(jié)構(gòu)中各個(gè)層次的每個(gè)程序的設(shè)計(jì)考慮，每一程序模塊的詳細(xì)設(shè)計(jì)描述單獨(dú)為一節(jié)，標(biāo)題格式為：模塊名稱(chēng)（模塊編號(hào)）設(shè)計(jì)說(shuō)明，例如：3.1主界面 untMsgMain frmMsgMain（）設(shè)計(jì)說(shuō)明。對(duì)每個(gè)程序模塊（包括存儲(chǔ)過(guò)程的設(shè)計(jì)），建議分別從以下幾個(gè)方面進(jìn)行描述：注明該功能模塊的編號(hào)和模塊名稱(chēng)模塊功能簡(jiǎn)述界面(包括屏幕編號(hào)，屏幕圖片，控件說(shuō)明)所調(diào)用的模塊（包括控件）的說(shuō)明變量說(shuō)明函數(shù)/過(guò)程列表函數(shù)/過(guò)程說(shuō)明（包括輸入、輸出和處理邏輯）測(cè)試要

6、求：主要說(shuō)明本模塊進(jìn)行單元測(cè)試的要點(diǎn)或注意事項(xiàng)出錯(cuò)處理尚未解決的問(wèn)題參考以下范例，允許根據(jù)實(shí)際需要進(jìn)行裁剪：3.1. 客戶(hù)開(kāi)銷(xiāo)戶(hù)分類(lèi)(Sp)設(shè)計(jì)說(shuō)明模塊編號(hào)052 盤(pán)后查詢(xún)?cè)闯绦蛭募p源程序名稱(chēng)客戶(hù)開(kāi)銷(xiāo)戶(hù)分類(lèi)功能查詢(xún)客戶(hù)的開(kāi)銷(xiāo)戶(hù)情況匯總，包括開(kāi)戶(hù)數(shù)、銷(xiāo)戶(hù)數(shù)，正常客戶(hù).源碼類(lèi)型后臺(tái)SP相關(guān)源程序文件khkxhfl.jsp修改歷史紀(jì)錄修改人日期描述XieYing05/22/2000Initial被調(diào)用模塊Web前臺(tái)khkxhfl.jsp調(diào)用模塊輸入?yún)?shù)iyybdmChar(3)營(yíng)業(yè)部代碼iksrqChar(8)開(kāi)始日期ijsrqChar(8)結(jié)束日期輸出參數(shù)oerrorChar(20)錯(cuò)誤代碼o

7、textChar(100)錯(cuò)誤信息結(jié)果集列表Numeric柜臺(tái)開(kāi)戶(hù)數(shù)Numeric柜臺(tái)銷(xiāo)戶(hù)數(shù)Numeric條碼開(kāi)戶(hù)數(shù)Numeric條碼銷(xiāo)戶(hù)數(shù)Numeric銀行開(kāi)戶(hù)數(shù)Numeric銀行銷(xiāo)戶(hù)數(shù)Numeric滬A股開(kāi)戶(hù)數(shù)Numeric滬A股銷(xiāo)戶(hù)數(shù)Numeric深A(yù)股開(kāi)戶(hù)數(shù)Numeric深A(yù)股銷(xiāo)戶(hù)數(shù)Numeric滬B股開(kāi)戶(hù)數(shù)Numeric滬B股銷(xiāo)戶(hù)數(shù)Numeric深B股開(kāi)戶(hù)數(shù)Numeric深B股銷(xiāo)戶(hù)數(shù)數(shù)據(jù)域說(shuō)明臨時(shí)表要訪問(wèn)的表要做修改的表客戶(hù)基本資料 Khjbzl股東代碼表 Gddmb客戶(hù)條碼 khtm客戶(hù)銀行帳號(hào) Khyhzh報(bào)表提示信息備注邏輯處理說(shuō)明分解參數(shù)。（包括參數(shù)出錯(cuò)處理）調(diào)用SP WEB

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

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

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

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

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

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

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

15、要控件說(shuō)明：輸出界面屏幕編號(hào)：b主要控件說(shuō)明：測(cè)試要求出錯(cuò)處理遺留問(wèn)題4 公用接口程序設(shè)計(jì)說(shuō)明給出各類(lèi)公用接口的程序的設(shè)計(jì)考慮，如全局變量、公用界面、公用函數(shù)和過(guò)程等。4.1. 全局變量羅列各個(gè)全局變量的屬性要求，包括全局變量名稱(chēng)、說(shuō)明、數(shù)據(jù)類(lèi)型、長(zhǎng)度、取值范圍等信息4.2. 公用界面要求描述清楚公用界面的界面布局情況，以及界面上所涉及到的各種數(shù)據(jù)項(xiàng)的相關(guān)屬性，與界面相關(guān)的詳細(xì)處理說(shuō)明（有邏輯算法和計(jì)算公式，則要詳細(xì)說(shuō)明）、輸入和輸出數(shù)據(jù)要求等等，要求要附有界面的書(shū)面格式，可詳細(xì)注明參見(jiàn)某個(gè)圖表或某個(gè)相關(guān)附件4.3. 公用函數(shù)和過(guò)程介紹公用函數(shù)和過(guò)程所實(shí)現(xiàn)的主要功能，說(shuō)明公用函數(shù)和過(guò)程所需調(diào)用的輸入?yún)?shù)、輸出參數(shù)以及邏輯處理