詳細設(shè)計說明書(模板).doc

1、詳細設(shè)計說明書 ( 模板 )東軟機密文件編號： D05-PDT073詳細設(shè)計說明書模板版本： 0.0.0-1.2.02009-6-30東軟集團股份有限公司軟件開發(fā)事業(yè)部( 版權(quán)所有，翻版必究)文件修改控制修改編號版本修改條款及內(nèi)容10.0.0-1.1.0 修改 LOGO20.0.0-1.1.1 1、修改公司標識為 “東軟集團股份有限公司 ”。2、修改文件密級標識為 “東軟機密 ”。3、將 “單體測試 ”改為 “單元測試 ”30.0.0-1.2.0 根據(jù)公司要求，轉(zhuǎn)換為 OpenOffice格式修改日期2005-7-292008-8-252009-06-17東軟機密文件編號：項目編號分冊名稱：D

2、DR順序號第版第冊/共冊項目名稱（項目編號）詳細設(shè)計說明書(軟件開發(fā)事業(yè)部 )東軟集團股份有限公司總頁數(shù)正文附錄生效日期編制批準修改記錄變更控制報告版本號更改條款及內(nèi)容 更改人 審批人 更改日期編號目錄1 引言11.1目的 .11.2背景 .11.3詞匯表11.4參考資料12 系統(tǒng)結(jié)構(gòu)12.1需求概述12.2總體設(shè)計23. 系統(tǒng)詳細設(shè)計說 明23.1包及類結(jié)構(gòu)設(shè)計23.2模塊設(shè)計23.3 Message文件管理 Module23.4 LOG管理 Module23.5配置文件管理Module23.6異常模塊說明34. 其他設(shè)計要求34.1單元測試34.2注釋及代碼風(fēng)格34.3尚未解決 問題35

3、附件說明3詳細設(shè)計說明書版本： 0.0.0-1.2.0第 1 頁編寫指南：本模板力圖給出軟件詳細設(shè)計階段可能包括的基本信息。如果某個章節(jié)在項目或當前階段中無法描述，則可保留其標題，注明 “不適用 ”；如果需要對本模板的個別章節(jié)詳細描述，也可將其形成單獨的文檔，成為本文檔附件。若文檔中的某個章節(jié)已經(jīng)在其他項目文檔中加以描述，可保留標題，注明 “參見（文檔編號）（文檔名稱）（條款） ”。形成正式文檔后須刪除斜體字內(nèi)容。1 引言1.1 目的說明編寫這份詳細設(shè)計說明書的目的，指出預(yù)期的讀者。1.2 背景敘述該項軟件開發(fā)的意圖、應(yīng)用目標、作用范圍以及其他應(yīng)向讀者說明的有關(guān)該軟件開發(fā)的背景材料。1.3 詞

4、匯表列出本軟件詳細設(shè)計中專門術(shù)語的定義、英文縮寫詞的原詞組和意義、項目組內(nèi)達成一致意見的專用詞匯，同時要求繼承全部的先前過程中定義過的詞匯，一般不包括需求或概要設(shè)計中已經(jīng)定義的部分，通過參見方式表示其他地方定義內(nèi)容。東軟集團股份有限公司軟件開發(fā)事業(yè)部詳細設(shè)計說明書版本： 0.0.0-1.2.0第 1 頁詞匯名稱詞匯含義備注備注中注明該詞匯的來源，或有其他更詳細的解釋的文檔位置；以及對該詞匯的其他叫法。1.4 參考資料列出編寫本報告時參考的文件、資料、技術(shù)標準以及他們的作者、標題、編號、出版日期和出版單位。列出編寫本報告時查閱的 Internet上雜志、專業(yè)著作、技術(shù)標準以及其網(wǎng)址。2 系統(tǒng)結(jié)構(gòu)

5、2.1 需求概述引用需求規(guī)格說明書中系統(tǒng)軟件概述部分內(nèi)容2.2 總體設(shè)計該系統(tǒng)的目的，該系統(tǒng)的用途，功能。對系統(tǒng)的業(yè)務(wù)概要性敘述，并對系統(tǒng)的擴展性及重用性要求進行描述。提供系統(tǒng)使用的技術(shù)路線，包括使用2 次開發(fā)平臺、系統(tǒng)重用組件內(nèi)容、應(yīng)用框架等?？膳浜细乓O(shè)計進行描述。東軟集團股份有限公司軟件開發(fā)事業(yè)部詳細設(shè)計說明書版本： 0.0.0-1.2.0第 1 頁提供系統(tǒng)架構(gòu)設(shè)計，對于使用Rose、Visio 等 UML工具編制內(nèi)容，同時可以將關(guān)鍵或外部接口類圖及說明貼入并附以簡單描述，具體內(nèi)容描述可以直接提出參見UML文檔的“ XXX模塊”內(nèi)容?？梢孟到y(tǒng)概要設(shè)計報告內(nèi)容進行描述東軟集團股份有限公司

6、軟件開發(fā)事業(yè)部詳細設(shè)計說明書版本： 0.0.0-1.2.0第 2 頁3. 系統(tǒng)詳細設(shè)計說明3.1 包及類結(jié)構(gòu)設(shè)計參見 UML設(shè)計圖中“ logic View/DD/Layer ”包中說明3.2 模塊設(shè)計參見 UML設(shè)計圖中“ logic View/DD/ Use-Case Realizations ”包中說明3.3 Message 文件管理 Module有指導(dǎo)意義的說明，開發(fā)人員進行細化，有系統(tǒng)信息提示處理要求的系統(tǒng)可在此處對系統(tǒng)提示信息和關(guān)鍵內(nèi)容進行定義（可選）3.4 LOG 管理 Module可在此處定義系統(tǒng)日志的記錄方法和文件格式要求（可選，功能日志通過需求提出）3.5 配置文件管理Mo

7、dule列舉系統(tǒng)的可配置內(nèi)容，并指定系統(tǒng)配置文件格式及相關(guān)處理機制，例如：使用XX組件進行文件解析，配置文件的文件類型等等。（可選）對配置文件內(nèi)容的瀏覽（表格）段值健值說明DATABASE DBNAME數(shù)據(jù)庫名PASSWORD密碼東軟集團股份有限公司軟件開發(fā)事業(yè)部詳細設(shè)計說明書版本： 0.0.0-1.2.0第 2 頁DIRECTORTEMP臨時文件目錄Y3.6 異常模塊說明定義系統(tǒng)異常處理機制，一般分為系統(tǒng)級異常處理要求和業(yè)務(wù)類異常處理要求，并指定處理異常后的相應(yīng)業(yè)務(wù)需求和處理方法，針對不同的框架結(jié)構(gòu)提出可實現(xiàn)的異常處理辦法，可在 UML圖中對系統(tǒng)異常處理詳細描述。4. 其他設(shè)計要求4.1 單元測試在用戶無特殊規(guī)定時，可使用部門統(tǒng)一約束要求（可選）。4.2注釋及代碼風(fēng)格在用戶