軟件工程過程資料模板-詳細設計說明書(共10頁)

1、精選優(yōu)質(zhì)文檔-傾情為你奉上（項目名稱）詳細設計說明書文件版本編寫日期發(fā)布日期專心-專注-專業(yè)文件修改記錄修改日期版本號變化狀態(tài)修改內(nèi)容修改人*變化狀態(tài)：C創(chuàng)建，A增加，M修改，D刪除文檔審批信息版本號提交人批準人批準日期發(fā)布日期備注目 錄1 引言1.1 編寫目的【說明編寫這份文檔的目的，指出預期的讀者?！?.2 適用范圍【說明此文檔在何種情況下或何種工作中使用?！?.3 術語和縮寫【列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組以及中英文全稱。】1.4 參考資料【列出有關參考資料。】2 概述【如果沒有劃分子系統(tǒng)，此章節(jié)可裁剪?！?.1 系統(tǒng)概述【說明此（子）系統(tǒng)“是什么”?！?.2

2、系統(tǒng)功能定義【說明此（子）系統(tǒng)實現(xiàn)的主要功能，可以諸條說明?！? 總體結構說明3.1 系統(tǒng)結構3.1.1 系統(tǒng)內(nèi)外部關系圖【描述此（子）系統(tǒng)內(nèi)部功能模塊的構成以及與外部模塊的接口關系，可采用圖表形式。如果概要設計說明書已描述此部分內(nèi)容，此處可刪剪?！?.1.2 功能模塊簡要說明【對此（子）系統(tǒng)功能模塊做簡要說明。如果概要設計說明書已描述此部分內(nèi)容，此處可刪剪?！?.1.3 依賴的外部接口【說明各模塊依賴的外部接口是什么，輸入?yún)?shù)、輸出參數(shù)、返回值等。】3.1.4 對外提供的接口【說明各模塊對外提供的外部接口是什么，輸入?yún)?shù)、輸出參數(shù)、返回值等?！?.2 模塊程序構件結構圖【詳細描述程序構件結構

3、圖，并做文字說明。一般是有如下兩種情況需做此描述：ü 非中間件服務結構的后臺處理進程模塊（一般是異步操作等）。ü 在前臺交互式操作的模塊中，引入了非中間件服務結構的部件。如：】4 數(shù)據(jù)模型（Data Model）設計4.1 邏輯實體模型4.1.1 實體模型1【描述本（子）系統(tǒng)核心的實體關系模型。如下圖所示。要求做到：ü 描述每一個實體的作用，指定實體標識（ID）。ü 對每一個relationship都要有說明，同時嚴格注意Mandatory(是否必須)，Cardinality(幾對幾關系)。ü ER圖中的每個表中應有表名、主鍵字段名、重要字段名

4、等信息。重要字段雖然不是ER圖本身必須的，但可以更利于理解表的屬性和關系。】4.1.2 實體模型2【如果有多個實體模型，需要按照上述的方式，諸一說明?！?.2 表結構（物理設計）【此部分主要設計表結構。一般地，實體對應于表，實體的屬性對應于表的列，實體之間的關系成為表的約束。邏輯設計中的實體大部分可以轉換成為物理設計中的表，但是他們并不一定是一一對應的。】4.2.1 表匯總序號（子）系統(tǒng)表名中文名稱和簡單描述使用方式123【注：使用方式分為：公用（所有（子）系統(tǒng)均可訪問）、自用（僅本（子）系統(tǒng)可訪問）、臨時?！?.2.2 表1字段名數(shù)據(jù)類型空/非空其他字段簡單描述表描述【基本用途、所屬數(shù)據(jù)庫、

5、表數(shù)據(jù)量、預計增長量。所屬表空間、分表說明、分區(qū)說明。】主鍵外鍵主表：外部引用主表： 索引觸發(fā)器約束字段描述字段1【字段描述】字段2【字段描述】【字段描述】4.2.3 表2【同上?！?.3 視圖列表序號（子）系統(tǒng)視圖名相關表使用方式描述123【注：使用方式分為：公用（其他（子）系統(tǒng)可訪問）、自用（僅（本）子系統(tǒng)可訪問）、臨時。】5 功能實現(xiàn)說明【本章對每個功能模塊中的每一個功能點做實現(xiàn)說明。有兩類主要的應用：以數(shù)據(jù)流為核心的，處理流程是重點；以業(yè)務操作為核心的，后臺業(yè)務模型、前臺展現(xiàn)模型是重點（強調(diào)用對象模型設計）。下面用不同的章節(jié)分別給出這兩類應用的設計文檔模板?！?.1 數(shù)據(jù)流類模塊【說明

6、：該類模塊的特點是：接口通常是數(shù)據(jù)文件或XML的形式，接口文件內(nèi)容比較穩(wěn)定?！?.1.1 數(shù)據(jù)流程圖【用數(shù)據(jù)流圖（Data Flow Diagram-DFD）描述該功能模塊總的數(shù)據(jù)流圖。并給出文字說明?！?.1.2 實現(xiàn)說明 功能點1實現(xiàn)說明【功能點實現(xiàn)說明包括以下一些內(nèi)容：ü 功能定義ü 處理流程ü 業(yè)務規(guī)則（什么條件下能做什么事情，什么條件下不能做什么事情）ü 其他說明】 功能點2實現(xiàn)說明【同上。】5.1.3 程序設計 類定義【說明類的定義，包括屬性、接口函數(shù)等?！?數(shù)據(jù)結構定義【給出數(shù)據(jù)結構或

7、數(shù)據(jù)元素（變量）的特性，包括名稱、標識符、數(shù)據(jù)類型和格式、值的有效范圍，并給出定義性描述，最好能用類C語言給出類型說明?！?目標文件定義【說明該模塊將提供哪些包（.So,.jar等）?！?接口定義【重點描述接口文件格式、接口方式（批處理、逐條；本地、遠程；遠程提供傳輸方式等）?！?.2 業(yè)務處理類模塊【說明：該類模塊的特點是：需要提供對象接口（Object Interface），對象模型是重點?！?.2.1 Object Model設計 功能點1實現(xiàn)說明.1 Sequence Diagram【所需功能的序列圖。如果包含多個業(yè)務操作，應繪制

8、多幅序列圖，原則是：ü 盡量覆蓋到對象參與此功能的所有方法。ü 如果某個業(yè)務操作非常簡單（例如兩個對象、三次調(diào)用），可以用文字簡單描述。】.2 說明【功能點實現(xiàn)說明包括以下一些內(nèi)容：ü 主要實現(xiàn)方法說明。ü 操作了哪些數(shù)據(jù)庫表的哪些字段。如：Object1.GetData(): DB_, ID, DB_ADSL.*.?！?功能點2實現(xiàn)說明【如果有多個功能點，需要按照上述的方式，逐一說明?！?.2.2 程序設計 目標文件定義【說明該模塊將提供哪些包（.So,.jar等）?！?接口定義【主要是Object Interface?！? 界面實現(xiàn)說明6.1 模塊16.1.1 總體界面結構（業(yè)務操作區(qū)）說明【可以用圖示輔助說明，可以用網(wǎng)頁、C+Builder Form等說明如下內(nèi)容：ü 有哪些界面。ü 界面的主要風格，構成元素。ü 界面流轉?！?.1.2 功能點1界面結構說明【對一些關鍵的、重要的、關系復雜的功能點界面予以特殊說明。對哪些單一