詳細設計說明書

1、詳細設計說明書1 導言（Introduction）本章對該文檔的目的、功能范圍、術語、相關文檔、參考資料、版本更新進行說 明。1.1 目的（Purpose本文檔的目旨在推動軟件工程的規(guī)范化， 使設計人員遵循統(tǒng)一的詳細設計書寫規(guī) 范，節(jié)省制作文檔的時間，降低系統(tǒng)實現(xiàn)的風險，做到系統(tǒng)設計資料的規(guī)范性與 全面性，以利于系統(tǒng)的實現(xiàn)、測試、維護、版本升級等。詳細設計的詳細程度， 應達到可以編寫程序的程度。1.2 范圍（Scope本文檔用于軟件設計階段的詳細設計，它的上游（依據(jù)的基線）是概要設計說明書，它的下游是源程序清單及單元測試計劃，并為單元測試報告提供測試依 據(jù)。該范圍應覆蓋概要設計說明書中的功能點

2、列表、性能點列表、接口列表。 軟件詳細設計的范圍是：各子系統(tǒng)的公用模塊實現(xiàn)設計、專用模塊實現(xiàn)設計、存 儲過程實現(xiàn)設計、觸發(fā)器實現(xiàn)設計、外部接口實現(xiàn)設計、部門角色授權(quán)設計、 其 他詳細設計等。按照3層結(jié)構(gòu)（B/A/S）的布局，詳細設計應從下面 3個方面進行。數(shù)據(jù)庫服務 器上的面向數(shù)據(jù)的設計：數(shù)據(jù)字典物理設計、基本表物理設計、中間表物理設計（報表設計）、臨時表物理設計、視圖物理設計、存儲過程物理設計、觸發(fā)器物 理設計。應用服務器上的面向業(yè)務邏輯的設計：接口數(shù)據(jù)設計、中間件設計、數(shù)據(jù)通信傳輸設計、可視構(gòu)件設計、非可視構(gòu)件設計、角色授權(quán)設計、功能點設計（功能點列表設計）。瀏覽器上的面向?qū)ο蟮脑O計：錄入

3、修改界面設計、瀏覽查 詢界面設計、登錄注冊界面設計、信息發(fā)布界面設計。1.3 術語定義（Terms Glossary術語定義，如表6-16所示。表6-16 術語定義序 號術語名 稱術語定義1詳細設 計在概要設計的基礎上，對其功能模塊或部件進行實現(xiàn) 設計，使編程人員據(jù)此能順利書寫出程序代碼2存儲過程存放在數(shù)據(jù)庫服務器上的一段程序，它能被其他程序 調(diào)用，以完成對數(shù)據(jù)庫表的某些規(guī)定操作3觸發(fā)器存放在數(shù)據(jù)庫服務器上的一段程序，當觸發(fā)條件滿足 時它就被執(zhí)行，以完成對數(shù)據(jù)庫表的某些規(guī)定操作4算法詳細設計中實現(xiàn)某項功能的數(shù)據(jù)處理方法及處理流程1.4 參考資料（Reference91 概要設計說明書2 需求分

4、析說明書3 軟件合同4 命名規(guī)范程序設計規(guī)范界面設計規(guī)范1.5 相關文檔(Related DocumentS1 源程序清單2 單元測試計劃及報告3 用戶使用手冊1.6 版本更新記錄(Version Updated Rcord 版本更新記錄，如表6-17所示。表6-17版本更新記錄版本 號創(chuàng)建 者創(chuàng)建日 期維護 者維護日 期維護紀要V1.0王大林2001/0318V1.0.1王小林2001/03/26報表4格式維護2 .模塊實現(xiàn)設計 (Implemental Design of Module功能模塊包括：登錄注冊模塊、信息發(fā)布模塊、菜單模塊、錄入修改模塊、查詢 統(tǒng)計模塊、數(shù)據(jù)處理模塊、報表輸出模

5、塊、前臺網(wǎng)站模塊、后臺處理模塊、數(shù)據(jù) 傳輸與接收模塊等等。詳細設計是面向模塊的，或者說是面向部件(或構(gòu)件)的, 不是面向組織結(jié)構(gòu)或部門單位的。 一個組織或單位，根據(jù)角色的授權(quán)，可以掛上 某些功能模塊。若為C/S或B/A/S結(jié)構(gòu)，則要說明該模塊運行在哪一層上。2.1 公用模塊設計(Design of Public Module公用模塊的提取與設計特別重要， 設計它的目的是為了復用，因此它直接影響到 系統(tǒng)的詳細設計、編程、運行的質(zhì)量。每個公用模塊的設計要包括如下內(nèi)容：(1) 模塊編號：按照命名規(guī)則，如：G-XXX，將此公用模塊編號寫上。(2) 模塊名稱：此公用模塊的英文名。(3) 模塊功能：詳細列

6、出此公用模塊的所有功能。(4) 模塊背景描述：對背景進行簡單的描述。為什么需要此模塊功能，其上下文環(huán)境。涉及業(yè)務背景內(nèi)容，與需求相結(jié)合。(5) 模塊算法設計:用偽語言(例如,ifendifcaseendcase doenddo,) 詳細描述出此公用模塊的算法，標準是使程序人員據(jù)此能順利地書寫程序。(6) 模塊調(diào)用方法：詳細列出調(diào)用的方式、入口參數(shù)、出口參數(shù)、異常處理。(7) 模塊編寫者：編寫者姓名。(8) 模塊編寫日期：編寫日期：yyyy/mm/dd。(9) 模塊修訂者：修訂者姓名。(10) 模塊修訂日期：修訂日期：yyyy/mm/dd。(11) 模塊測試者：測試者姓名。(12) 模塊測試日期

7、：測試日期：yyyy/mm/dd。2.2 專用模塊設計(Design of Expert Module非公用模塊是為了處理一些特殊需求，它不可復用，每個非公用模塊設計包括如下內(nèi)容：( 1)模塊編號：按照命名規(guī)則，如： M1-XXX ，將此專用模塊編號寫上。(2) 模塊名稱：此模塊的中文名。(3) 模塊功能：詳細列出此模塊的所有功能。(4) 模塊背景描述：對背景進行簡單的描述。為什么需要此模塊功能，其上 下文環(huán)境。涉及業(yè)務背景內(nèi)容，與需求相結(jié)合。(5) 模塊算法設計：用偽語言(例如，ifendifcaseendcase doenddo,)詳細描述出此專用模塊的算法，標準是使程序人員據(jù)此能順利地書

8、寫程序。( 6)模塊編寫者：編寫者姓名。( 7)模塊編寫日期：編寫日期： yyyy/mm/d d 。( 8)模塊修訂者：修訂者姓名。( 9)模塊修訂日期：修訂日期： yyyy/mm/d d 。( 10)模塊測試者：測試者姓名。( 11)模塊測試日期：測試日期： yyyy/mm/dd。2.3 存儲過程設計(Design of Storage Process存儲過程是一種特殊的公用模塊, 它在數(shù)據(jù)庫服務器上執(zhí)行, 這里將它單獨列出 來,規(guī)定其詳細設計模板為：( 1)存儲過程中文名：此存儲過程的中文名。( 2)存儲過程英文名：此存儲過程的英文名。( 3)存儲過程功能 : 詳細描述其功能。( 4)存儲

9、過程算法 : 用偽語言詳細描述其算法,使編程人員據(jù)此能順利書寫 程序。( 5)存儲過程調(diào)用方式：詳細列出調(diào)用的方式、入口參數(shù)、出口參數(shù)、異常處理。( 6)模塊編寫者：編寫者姓名。( 7)模塊編寫日期：編寫日期： yyyy/mm/d d 。( 8)模塊修訂者：修訂者姓名。( 9)模塊修訂日期：修訂日期： yyyy/mm/d d 。( 10)模塊測試者：測試者姓名。( 11)模塊測試日期：測試日期： yyyy/mm/dd。2.4 觸發(fā)器設計( Design of Trigger)觸發(fā)器也是一種公用模塊, 不過它是隱式執(zhí)行, 這里將它單獨列出來, 規(guī)定其詳細設計模板為：( 1)觸發(fā)器中文名：此觸發(fā)器

10、的中文名。( 2)觸發(fā)器英文名：此觸發(fā)器的英文名。( 3)觸發(fā)器功能：詳細描述其功能。( 4)觸發(fā)器算法： 用偽語言詳細描述其算法, 使編程人員據(jù)此能順利書寫程 序。( 5)觸發(fā)器激活條件： 詳細描述其激活條件, 使編輯人員據(jù)此能順利書寫程序。( 6)觸發(fā)器編寫者：編寫者姓名。( 7)觸發(fā)器編寫日期：編寫日期：yyyy/mm/dd。( 8)觸發(fā)器修訂者：修訂者姓名。( 9)觸發(fā)器修訂日期：修訂日期：yyyy/mm/dd。（10）觸發(fā)器測試者：測試者姓名。（11） 觸發(fā)器測試日期：測試日期：yyyy/mm/dd。注意：過多地使用觸發(fā)器反而會使系統(tǒng)的效率降低。因此，凡是能用存儲過程代替觸發(fā)器功能的

11、地方，一律用存儲過程來實現(xiàn)。3. 接口實現(xiàn)設計（Implemental Design of Interface）每個外部接口實現(xiàn)模塊的設計要包括如下內(nèi)容：（1）接口中文名稱：此接口的中文名。（2）接口英文名稱：此接口的英文名。（3）接口內(nèi)容與功能：詳細描述接口的內(nèi)容與功能，如實現(xiàn)數(shù)據(jù)傳輸或數(shù)據(jù) 交換。（4）接口硬件設施：詳細描述接口的硬件設施，如交換機、傳感器或輸出設 備。（5）接口軟件或中間件：詳細描述接口軟件或中間件的名稱、功能、使用方 法、生產(chǎn)廠商。（6）接口的數(shù)據(jù)結(jié)構(gòu)：詳細描述接口的數(shù)據(jù)結(jié)構(gòu)，如文件結(jié)構(gòu)、數(shù)據(jù)庫表結(jié) 構(gòu)。（7）接口的傳輸速率（Mbps）:定量說明每秒最大流量。（8）接口

12、帶寬：定量說明帶寬，如 XXMbps。（9）接口協(xié)議：說明具體協(xié)議。（10）接口程序的算法：用偽語言詳細描述其算法，使編碼人員據(jù)此能順利 書寫程序。（11）接口編寫者：編寫者姓名。（12）接口編寫日期：編寫日期：yyyy/mm/dd。（13）接口修訂者：修訂者姓名。（14）接口修訂日期：修訂日期：yyyy/mm/dd。（15）接口測試者：測試者姓名。（16）接口測試日期：測試日期：yyyy/mm/dd。4. 其他實現(xiàn)設計 （Other Impleme ntal Desig ns本章描述前面沒有說明的設計。 如部門角色授權(quán)設計、界面設計、包裝設計、維 護設計等。4.1 角色授權(quán)設計（Accred

13、ited Design of Role）授權(quán)表的橫坐標表示角色（部件、單位或崗位），縱坐標表示功能模塊，“”表 示授權(quán)。該授權(quán)表是工作站上菜單設計的依據(jù)，如表6-18所示。表6-18角色授權(quán)設計模塊名角色1角色2角色3角色4角色5模塊英文名1模塊英文名2模塊英文名3模塊英文名4模塊英文名5模塊英文名6模塊英文名7模塊英文名8J4.2 其他詳細設計(Other Particular DesignS根據(jù)需要進行設計。如界面設計、包裝設計、維護設計等。5. 詳細設計檢查列表 (Check-up List of Design)按照概要設計文檔的功能、性能和接口 3個列表，設計出詳細設計檢查列表，以 檢

14、查詳細設計是否覆蓋概要，沒有覆蓋就是不符合項，并將檢查結(jié)果列出。5.1 功能設計檢查列表(Check-up List of Function Design功能設計檢查列表，如表6-19所示。表6-19 功能設計檢查列表編 號功能 名稱使用部 門使用 崗位功能 描述輸入 內(nèi)容系統(tǒng) 響應出容 輸內(nèi)是否 實現(xiàn)1235.2 性能設計檢查列表(Check-up List of Performanee Design 性能設計檢查列表，如表6-20所示。表6-20性能設計檢查列表編 號性能 名稱使用部 門使用 崗位性能 描述輸入 內(nèi)容系統(tǒng) 響應出容 輸內(nèi)是否 實現(xiàn)1235.3 接口設計檢查列表(Check-up List of In terface Design) 接口設計檢查列表，如表6-21所示。表6-21接口