詳細(xì)設(shè)計(jì)說(shuō)明書(shū)

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

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

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

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

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

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

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

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

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

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

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

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

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

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