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

1、（項(xiàng)目名稱）詳細(xì)設(shè)計(jì)說(shuō)明書- I -（項(xiàng)目名稱）詳細(xì)設(shè)計(jì)說(shuō)明書文件版本編寫日期發(fā)布日期文件修改記錄修改日期版本號(hào)變化狀態(tài)修改內(nèi)容修改人* 變化狀態(tài)： C創(chuàng)建， A增加， M修改， D刪除文檔審批信息版本號(hào)提交人批準(zhǔn)人批準(zhǔn)日期發(fā)布日期備注項(xiàng)目名）詳細(xì)設(shè)計(jì)說(shuō)明書目錄1 引言 11.1 編寫目的 . 11.2 適用范圍 . 11.3 術(shù)語(yǔ)和縮寫 . 11.4 參考資料 . 12 概述 12.1 系統(tǒng)概述 . 12.2 系統(tǒng)功能定義. 13 總體結(jié)構(gòu)說(shuō)明. 13.1 系統(tǒng)結(jié)構(gòu) . 13.1.1 系統(tǒng)內(nèi)外部關(guān)系圖. 13.1.2 功能模塊簡(jiǎn)要說(shuō)明. 13.1.3 依賴的外部接口 . 13.1.4 對(duì)外提

2、供的接口 . 13.2模塊程序構(gòu)件結(jié)構(gòu)圖. 14 數(shù)據(jù)模型（ Data Model ）設(shè)計(jì) . 24.1 邏輯實(shí)體模型 . 24.1.1 實(shí)體模型1 . 24.1.2 實(shí)體模型2 . 34.2 表結(jié)構(gòu)（物理設(shè)計(jì)）. 34.2.1 表匯總 . 34.2.2 表1. 34.2.3 表2. 34.3 視圖列表 . 45 功能實(shí)現(xiàn)說(shuō)明 . 45.1 數(shù)據(jù)流類模塊 . 45.1.1 數(shù)據(jù)流程圖 . 45.1.2 實(shí)現(xiàn)說(shuō)明. 45.1.3 程序設(shè)計(jì). 45.2 業(yè)務(wù)處理類模塊. 55.2.1 Object Model 設(shè)計(jì) . 55.2.2 程序設(shè)計(jì) . 56 界面實(shí)現(xiàn)說(shuō)明. 56.1 模塊1 . 56.

3、1.1 總體界面結(jié)構(gòu)（業(yè)務(wù)操作區(qū)）說(shuō)明 56.1.2 功能點(diǎn) 1界面結(jié)構(gòu)說(shuō)明. 56.1.3 功能點(diǎn) 2界面結(jié)構(gòu)說(shuō)明. 56.2 模塊2 . 66.2.1 總體界面結(jié)構(gòu)（業(yè)務(wù)操作區(qū)）說(shuō)明 66.2.2 功能點(diǎn) 1界面結(jié)構(gòu)說(shuō)明. 66.2.3 功能點(diǎn) 2界面結(jié)構(gòu)說(shuō)明. 6- iii -（項(xiàng)目名）詳細(xì)設(shè)計(jì)說(shuō)明書1 引言1.1 編寫目的【說(shuō)明編寫這份文檔的目的，指出預(yù)期的讀者。 】1.2 適用范圍 【說(shuō)明此文檔在何種情況下或何種工作中使用。 】1.3 術(shù)語(yǔ)和縮寫 【列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組以及中英文全稱。 】1.4 參考資料【列出有關(guān)參考資料?！? 概述 【如果沒(méi)有劃

4、分子系統(tǒng)，此章節(jié)可裁剪。 】2.1 系統(tǒng)概述 【說(shuō)明此（子）系統(tǒng)“是什么” ?！?.2 系統(tǒng)功能定義【說(shuō)明此（子）系統(tǒng)實(shí)現(xiàn)的主要功能，可以諸條說(shuō)明。 】3 總體結(jié)構(gòu)說(shuō)明3.1 系統(tǒng)結(jié)構(gòu)3.1.1 系統(tǒng)內(nèi)外部關(guān)系圖 【描述此（子）系統(tǒng)內(nèi)部功能模塊的構(gòu)成以及與外部模塊的接口關(guān)系，可采用圖表形式。如 果概要設(shè)計(jì)說(shuō)明書已描述此部分內(nèi)容，此處可刪剪。 】3.1.2 功能模塊簡(jiǎn)要說(shuō)明 【對(duì)此（子）系統(tǒng)功能模塊做簡(jiǎn)要說(shuō)明。如果概要設(shè)計(jì)說(shuō)明書已描述此部分內(nèi)容，此處可刪剪?！?.1.3 依賴的外部接口 【說(shuō)明各模塊依賴的外部接口是什么，輸入?yún)?shù)、輸出參數(shù)、返回值等。 】3.1.4 對(duì)外提供的接口 【說(shuō)明各模塊對(duì)

5、外提供的外部接口是什么，輸入?yún)?shù)、輸出參數(shù)、返回值等。 】3.2 模塊程序構(gòu)件結(jié)構(gòu)圖 【詳細(xì)描述程序構(gòu)件結(jié)構(gòu)圖，并做文字說(shuō)明。一般是有如下兩種情況需做此描述：? 非中間件服務(wù)結(jié)構(gòu)的后臺(tái)處理進(jìn)程模塊（一般是異步操作等） 。? 在前臺(tái)交互式操作的模塊中，引入了非中間件服務(wù)結(jié)構(gòu)的部件。如： 】4 數(shù)據(jù)模型（ Data Model ）設(shè)計(jì)4.1 邏輯實(shí)體模型4.1.1 實(shí)體模型 1 【描述本（子）系統(tǒng)核心的實(shí)體關(guān)系模型。如下圖所示。要求做到：描述每一個(gè)實(shí)體的作用，指定實(shí)體標(biāo)識(shí)（ ID）。對(duì)每一個(gè) relationship 都要有說(shuō)明，同時(shí)嚴(yán)格注意 Mandatory（ 是否必須 ） ， Cardina

6、lity（ 幾對(duì)幾關(guān)系 ） 。ER圖中的每個(gè)表中應(yīng)有表名、主鍵字段名、重要字段名等信息。重要字段雖然不 是 ER圖本身必須的，但可以更利于理解表的屬性和關(guān)系。 】構(gòu)成關(guān)系parent ofcompos父子關(guān)系report towith匯報(bào)關(guān)ed ofcompos雇傭關(guān)系defi ned職位職責(zé)bi l i tyN9Employee AgentEmployee CompetencyEmp idVA15員工技能Competency IdVA15一對(duì)一member ofUs er LoginLoginNameVA154.1.2 實(shí)體模型 2 【如果有多個(gè)實(shí)體模型，需要按照上述的方式，諸一說(shuō)明。 】4

7、.2 表結(jié)構(gòu)（物理設(shè)計(jì)） 【此部分主要設(shè)計(jì)表結(jié)構(gòu)。一般地，實(shí)體對(duì)應(yīng)于表，實(shí)體的屬性對(duì)應(yīng)于表的列，實(shí)體之間的 關(guān)系成為表的約束。 邏輯設(shè)計(jì)中的實(shí)體大部分可以轉(zhuǎn)換成為物理設(shè)計(jì)中的表， 但是他們并不一定 是一一對(duì)應(yīng)的?！?.2.1 表匯總序號(hào)（子）系統(tǒng)表名中文名稱和簡(jiǎn)單描述使用方式123【注：使用方式分為：公用（所有（子）系統(tǒng)均可訪問(wèn)） 、自用（僅本（子）系統(tǒng)可訪問(wèn)） 臨時(shí)?！?.2.2 表 1字段名數(shù)據(jù)類型空/ 非空其他字段簡(jiǎn)單描述表描述【基本用途、所屬數(shù)據(jù)庫(kù)、表數(shù)據(jù)量、預(yù)計(jì)增長(zhǎng)量。所屬表空間、分表說(shuō)明、分區(qū)說(shuō)明。 】主鍵外鍵主表：外部引 用主表：索引觸發(fā)器約束字段描述字段 1【字段描述】字段 2

8、【字段描述】【字段描述】4.2.3 表 2【同上?！康?3 頁(yè) 共 6 頁(yè)（項(xiàng)目名）詳細(xì)設(shè)計(jì)說(shuō)明書4.3 視圖列表序號(hào)（子） 系統(tǒng)視圖名相關(guān)表使用方式描述123注：使用方式分為：公用（其他（子）系統(tǒng)可訪問(wèn)） 、自用（僅（本）子系統(tǒng)可訪問(wèn)） 、臨時(shí)。】5 功能實(shí)現(xiàn)說(shuō)明【本章對(duì)每個(gè)功能模塊中的每一個(gè)功能點(diǎn)做實(shí)現(xiàn)說(shuō)明。 有兩類主要的應(yīng)用： 以數(shù)據(jù)流為核心 的，處理流程是重點(diǎn)；以業(yè)務(wù)操作為核心的，后臺(tái)業(yè)務(wù)模型、前臺(tái)展現(xiàn)模型是重點(diǎn)（強(qiáng)調(diào)用對(duì)象 模型設(shè)計(jì)）。下面用不同的章節(jié)分別給出這兩類應(yīng)用的設(shè)計(jì)文檔模板。 】5.1 數(shù)據(jù)流類模塊【說(shuō)明： 該類模塊的特點(diǎn)是： 接口通常是數(shù)據(jù)文件或 XML的形式，接口文件內(nèi)

9、容比較穩(wěn)定?！?.1.1 數(shù)據(jù)流程圖【用數(shù)據(jù)流圖（Data Flow Diagram-DFD）描述該功能模塊總的數(shù)據(jù)流圖。 并給出文字說(shuō)明?！?.1.2 實(shí)現(xiàn)說(shuō)明 功能點(diǎn) 1 實(shí)現(xiàn)說(shuō)明【功能點(diǎn)實(shí)現(xiàn)說(shuō)明包括以下一些內(nèi)容：? 功能定義? 處理流程? 業(yè)務(wù)規(guī)則（什么條件下能做什么事情，什么條件下不能做什么事情）? 其他說(shuō)明】 功能點(diǎn) 2 實(shí)現(xiàn)說(shuō)明【同上?！?.1.3 程序設(shè)計(jì) 類定義【說(shuō)明類的定義，包括屬性、接口函數(shù)等。 】 數(shù)據(jù)結(jié)構(gòu)定義【給出數(shù)據(jù)結(jié)構(gòu)或數(shù)據(jù)元素（變量）的特性，包括名稱、標(biāo)識(shí)符、數(shù)據(jù)類型和格式、值的有 效范圍，并給出定義性描述，

10、最好能用類 C語(yǔ)言給出類型說(shuō)明。】 目標(biāo)文件定義【說(shuō)明該模塊將提供哪些包（ .So,.jar 等）。】 接口定義（項(xiàng)目名）詳細(xì)設(shè)計(jì)說(shuō)明書 【重點(diǎn)描述接口文件格式、 接口方式（批處理、 逐條；本地、遠(yuǎn)程；遠(yuǎn)程提供傳輸方式等）?！?.2 業(yè)務(wù)處理類模塊【說(shuō)明：該類模塊的特點(diǎn)是：需要提供對(duì)象接口（ Object Interface ），對(duì)象模型是重點(diǎn)。】5.2.1 Object Model 設(shè)計(jì) 功能點(diǎn) 1 實(shí)現(xiàn)說(shuō)明.1 Sequence Diagram 【所需功能的序列圖。如果包含多個(gè)業(yè)務(wù)操作，應(yīng)繪制多幅序列圖，原則是：? 盡量覆蓋到對(duì)象參與

11、此功能的所有方法。? 如果某個(gè)業(yè)務(wù)操作非常簡(jiǎn)單（例如兩個(gè)對(duì)象、三次調(diào)用） ，可以用文字簡(jiǎn)單描述。】.2 說(shuō)明【功能點(diǎn)實(shí)現(xiàn)說(shuō)明包括以下一些內(nèi)容：? 主要實(shí)現(xiàn)方法說(shuō)明。? 操作了哪些數(shù)據(jù)庫(kù)表的哪些字段。如： Object1.GetData（）: DB_, ID, DB_ADSL.*. 。】 功能點(diǎn) 2 實(shí)現(xiàn)說(shuō)明 【如果有多個(gè)功能點(diǎn)，需要按照上述的方式，逐一說(shuō)明。 】5.2.2 程序設(shè)計(jì) 目標(biāo)文件定義【說(shuō)明該模塊將提供哪些包（ .So,.jar 等）。】 接口定義【主要是 Object Interface ?！? 界面實(shí)現(xiàn)說(shuō)明6.1 模塊 16.1.1 總體界面結(jié)構(gòu)（業(yè)務(wù)操作區(qū)）說(shuō)明 【可以用圖示輔助說(shuō)明，可以用網(wǎng)頁(yè)、 C+Builder Form 等說(shuō)明如下內(nèi)容： ? 有哪些界面。? 界面的主要風(fēng)格，構(gòu)成元素。? 界面流轉(zhuǎn)?！?.1.2 功能點(diǎn) 1 界面結(jié)構(gòu)說(shuō)明 【對(duì)一些關(guān)鍵的、