1、個人收集整理-僅供參考密級:*工程詳細設計說明書()揚VICSE中創軟件工程股份二0C*年*月*日1/12個人收集整理-僅供參考文件修訂記錄變更版本修訂日期原因與修改情況描述位置頁段落章P3修訂人審核人2/12個人收集整理-僅供參考詳細設計說明書編寫要求:關于封面、目錄、正文等排版要求請參閱工程文件排版指導；正文的內容參照以下要求組織,本模板只提供參考,根據工程的不同特點,對有關章節可做必要的剪裁與調整.1引言編寫目的說明一個軟件系統中的每一個程序的設計思路.該文件可作為公司軟件開發人員、 綜合測試人員的指導性文件.背景1、開發的軟件系統的名稱列出本軟件系統的中文全稱、英文全稱及英文表示簡稱.

2、2、開發的軟件系統的最終用戶或適用的領域.定義列出本文件中用到的專門術語定義和外文首字母組詞的原詞組.參考資料列出相關的參考資料,如：a與本工程有關的上級機關的批文；b屬于本工程的其他已發表的文件；c本文件中各處引用的文件、資料,包括所需用到的軟件開發標準；d與該工程工作產品有關的法律法規要求.列出這些文件資料的標題、文件編號、作者、發表日期和出版單位等,說明能夠得到這些文件資料的來源.3/12權限相關子領域依賴關系個人收集整理-僅供參考2總體設計源碼目標碼組織多工程治理對于需要劃分多個子工程的工程,必須對各子工程劃分及源碼組織方式進行描述.模塊的組織給出系統中各模塊的劃分及相互之間的依賴關系

3、.例如：用戶治理14給出對系統子系統模塊及包的組織的詳細說明.4/12個人收集整理-僅供參考模塊名模塊發布名稱模塊說明權限治理負責系統的認證及授權包的組織模塊名包路徑包的說明權限治理其中：包路徑的定義及描述要求如下:(1)命名規那么：.產品名稱.子包名稱；用戶有特殊要求的情況下可以不遵循該規那么.注：該局部內容是否由企管部統一治理？(2)各產品必須在上述描述的系統包內劃分.系統內的通用包內的內容由系統自己決定,通用包命名為.(3)在設計文檔中必須清楚地進行定義,并描述各之間的依賴關系.(4)要求在每個包的路徑下利用描述該包的涵蓋的領域說明,并作為配置項進行治理.包描述的層次必須能夠滿足工程組內

4、每個成員理解的需要.層次的劃分給出對系統中業務層、限制層、展現層等各層次的說明及各層次之間關系的說明.界面源碼存放路徑資源為(如、等)給出對各系統、子系統、模塊的圖片存放路徑統一的處理要求和約束條件模塊名稱路徑路徑的說明共性設計在此章節,對工程中用到的各構件的共性局部,進行設計說明5/12個人收集整理-僅供參考對于及的描述限制于開發,其它內容適用于開發.該局部設計要求至少包括如下內容：(1)采用的整體框架模式,各技術層次源碼劃分及組織規那么,必須明確各個層次的相關責任.如框架,必須描述清楚、各元素的代碼組織方式及命名規那么機制那么必須寫清楚.再如：如在實現中曾家()層面或層面,必須對其承當的責

5、任進行清楚的劃分.對于操作的命名規那么進行清楚描述.(2)事務處理模式(3)日志處理模式(4)異常處理模式(5)錯誤信息處理模式(6)數據庫資源獲取規那么(7)界面模式及界面展現約束(8)配置文件要求(9)通用業務處理模式,包括分頁處理等等如,給出對配置文件的說明和統一的處理要求和約束條件,如模塊化建義、等.3系統功能設計設計原那么是代碼文檔一體化,盡量利用來描述詳細設計在本章節對系統的各子系統、模塊進行設計說明.每一小節,就是一個子系統模塊的詳細設計6/12個人收集整理-僅供參考模塊功能概述頁面流盡量在原型中進行描述原型界面在此僅需指明相關路徑.查詢條件在該區域：說明對應的提交路徑,必須說明

6、等特殊需要描述的內容輸入名稱是否可空校驗規那么匹配條件說明包括默認值認可年度/、可船級社國籍/、可注:表單元素類型說明:文本輸入框,默認情況下與數據庫的對應字段:必須說明是否需要參數標簽,如果需要那么描述為標簽名稱,如果包括檢索條件那么表示為標簽名稱,條件7/12個人收集整理-僅供參考校驗規那么說明：(,正負號),其中或表示允許輸入正負號,如(),表示可輸入正負號.()表示不允許輸入負號,(),表示只能輸入負號(,正負號)：與的輸入校驗相同.()()():電子郵件:座機,輸入模式位:移動,全數字輸入,不超過位:身份證號最小輸入個字符,最大可輸入個字符,默認情況下與對應數據結構的字段長度相同.對

7、于數據結構固定長度的字段,其表示方式為口,表示輸入的字符數必須為個字符.對于沒有最小字符串限制的輸入表示為.領域內可根據自己的需要定義相應的規那么,匹配條件：表示右匹配,表示中間匹配,表示右匹配說明：其它需要注釋的工程查詢結果列表列表的排序方式內容標題內容分步【居中、居左、居右】模式信息工程格式說明8/12個人收集整理-僅供參考保存更新工程該區域明確對應的對于該局部內容,如果存在界面原型,那么該局部內容僅需描述變量或其它特殊校驗的輸入工程說明.輸入名稱是否必輸校驗規那么說明必輸可輸標簽名備注：但凡不再此描述的內容,參照界面原型及數據庫設計要求其它非關聯關系連接名稱連接的相關參數展現模式說明連接

8、名稱：表示連接對象的展示名稱或展示內容所在的名稱,如展示新聞,那么連接的名稱為“展示新聞再如,展示新聞標題列表,根據新聞標題可連接到對應的新聞.那么9/12個人收集整理-僅供參考連接的名稱為“新聞標題相關參數：必須說明參數的名稱展現模式：模式對話框、非模式對話框、新窗口、當前窗口說明：其他需要說明的內容.界面處理提交前動作說明針對提交該局部內容僅描述界面相關的動作處理,如涉及的輸入關聯的邏輯校驗,客戶端數值計算等.動作名稱處理說明其它說明保存類說明類名稱功能簡述業務邏輯處理說明注：該局部內容建議在中進行描述,除非需要更加細節的闡述處理時序對于相類似的處理,可以在概要設計中進行說明,在此僅僅參照

9、概要設計即可對于復雜的邏輯,需要利用活動圖進行描述10/12個人收集整理-僅供參考(1)清楚描述不同的條件分支(2)清楚的描述對于狀態或標志的更改(3)描述清楚業務執行過程中需要操作的對象及相關的操作(4)錯誤處理描述建立統一的出錯信息表(5)提示信息描述(6)可以利用的活動圖描述業務邏輯或時序圖對對象間的協作進行描述條件涉及的對于數據庫狀態的改變出錯提示成功信息業務代碼設計代碼工程說明標準目標用于對貨票屬性進行編碼標準化治理編碼規那么位字符,規那么如下：或空格普通貨票、-國際聯運、-水路聯運、-軍用后付取值范圍可空格或者、字段名稱數據類型()使用范圍集裝箱系統數據維護當貨票屬性代碼變更時,由鐵道部電子中央負責務-維護,保證數據的TW生.可通過數據庫的數據維護功能來實現,不能在應用系統中單獨設立維護模塊