軟件詳細設計文檔模板要點

1、軟件詳細設計文檔模板要點文檔編號 版本 A1 密級 商密 A 研發(fā)生產(chǎn)中心 項目名稱 Xx 系統(tǒng) 項目來源QR-RD-022(Ver1.2)Xxx 系統(tǒng) 詳細設計說明書 ( 內(nèi)部資料 請勿外傳 ) 編 寫: 日 期: 檢 查: 日 期: 審 核: 日 期 : 批 準: 日 期:XX公司版權所有 不得復制文檔變更記錄序號 作者 版本號 日期 批準 變更 (+/-) 說明1 2目錄1. 引51.1 編寫目的和范圍 51.2 術語表 51.3 參考資料 51.4 使用的文字處理和繪圖工具 / 、 5 2. 全局數(shù)據(jù)結構說 明 52.1 常量 62.2 變量 62.3 數(shù)據(jù)結模塊設構 6 3.計 3.

2、1 用例圖 63.2 功能設計說明 63.2.1 模塊1 63.2.2 模塊2 7 4.接口設計 84.1 內(nèi)部接口 84.2 外部接口 84.2.1 接口說明 8系統(tǒng)安全保密設系統(tǒng)出錯處4.2.2 調(diào)用方式 8 5. 數(shù)據(jù)庫設計8 6.計 96.1 說明 96.2 設計 96.2.1 數(shù)據(jù)傳輸部分 96.2.2 IP 過濾分部 96.2.3 身份驗證部分 9 7. 系統(tǒng)性能設計 9 8.理 91. 引言1.1 編寫目的和范圍 說明寫這份詳細設計說明書的目的。 本詳細設計說明書編寫的目的是說明程序模塊的設計考慮，包括程序描述、輸 入/ 輸出、算法和流程邏輯等，為軟件編程和系統(tǒng)維護提供基礎。本說

3、明書的預期 讀者為系統(tǒng)設計人員、軟件開發(fā)人員、軟件測試人員和項目評審人員。1.2 術語表 定義系統(tǒng)或產(chǎn)品中涉及的重要術語，為讀者在閱讀文檔時提供必要的參考信 息。 序號 術語或縮略語 說明性定義1 PM Project Manager, 項目經(jīng)理21.3 參考資料 列出有關資料的名稱、作者、文件編號或版本等。參考資料包括 : a( 需求說明書、架構設計說明書等 ;b( 本項目的其他已發(fā)表的文件 ;c( 引用文件、資料、軟件開發(fā)標準等。資料名稱 作者 文件編號、版本 資料存放地點1.4 使用的文字處理和繪圖工具 文字處理軟件 : 編寫設計文檔使用的文字處理軟件，如 RedOffice 繪圖工具：

4、使用的UML工具，女口 Rose Jude、Visio2. 全局數(shù)據(jù)結構說明本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結構。2.1 常量包括數(shù)據(jù)文件名稱及其所在目錄，功能說明，具體常量說明等。2.2 變量本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結構。2.3 數(shù)據(jù)結構包括數(shù)據(jù)結構名稱，功能說明，具體數(shù)據(jù)結構說明 （定義、注釋、取值 ） 等。 3. 模塊設計3.1 用例圖3.2 功能設計說明3.2.1 模塊 1模塊 1 主要分為以下幾個子模塊 : 子模塊 1、子模塊 2 和子模塊 N。 子模塊 .1 設計圖.2 功能描述簡要描述子模塊

5、 1 的業(yè)務功能。.3 輸入數(shù)據(jù)詳細描述用戶輸入的數(shù)據(jù) （包括任何輸入設備 ） 以及這些數(shù)據(jù)的有效性檢驗規(guī) 則。詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。.4 輸出數(shù)據(jù)詳細描述子功能 1 所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。 .5 業(yè)務 算法和流程從業(yè)務角度詳細描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務算法和流程。.6 數(shù)據(jù)設計給出本程序中的局部數(shù)據(jù)結構說明，包括數(shù)據(jù)結構名稱，功能說明，具體數(shù)據(jù) 結構說明 （定義、注釋設計、取值 ） 等。相關數(shù)據(jù)庫表，數(shù)據(jù)存儲設計 （具體說明需 要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲格式、數(shù)據(jù)項

6、及屬性等。 ）.7 源程序文件說明 給出本程序的各源程序文件的說明，包括源程序文件名稱及其所在目錄，功能 說明，包含的前導文件及函數(shù)名稱等。.8 函數(shù)說明 具體說明本程序中的各個函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參 數(shù)，全局變量，局部變量，返回值，算法說明，使用約束等。.9 限制條件.10 其他說明3.2.2 模塊 2模塊 1主要分為以下幾個子模塊 :子模塊 1、子模塊 2和子模塊 N。 子模塊 .1 設計圖.2 功能描述簡要描述子模塊 1 的業(yè)務功能。.3 輸入數(shù)據(jù)詳

7、細描述用戶輸入的數(shù)據(jù) （包括任何輸入設備 ） 以及這些數(shù)據(jù)的有效性檢驗規(guī) 則。詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。.4 輸出數(shù)據(jù)詳細描述子功能 1 所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。.5 業(yè)務算法和流程從業(yè)務角度詳細描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務算法和流程。.6 數(shù)據(jù)設計 給出本程序中的局部數(shù)據(jù)結構說明，包括數(shù)據(jù)結構名稱，功能說明，具體數(shù)據(jù) 結構說明 （定義、注釋設計、取值 ） 等。相關數(shù)據(jù)庫表，數(shù)據(jù)存儲設計 （具體說明需 要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲格式、數(shù)據(jù)項及屬性等。 ）.7 源程序文件說明

8、給出本程序的各源程序文件的說明，包括源程序文件名稱及其所在目錄，功能 說明，包含的前導文件及函數(shù)名稱等。.8 函數(shù)說明 具體說明本程序中的各個函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參 數(shù)，全局變量，局部變量，返回值，算法說明，使用約束等。.9 限制條件.10 其他說明4. 接口設計4.1 內(nèi)部接口4.2 外部接口4.2.1 接口說明例如 :xx 子系統(tǒng)通過 xx 從 xx 子系統(tǒng)取得 xx 等，相關標準，調(diào)用示例，可根據(jù) 需要增加章節(jié)描述接口。4.2.2 調(diào)用方式例如: 內(nèi)部接口調(diào)用 :例:/* 通過用戶服務號碼取得該客戶認證密碼等信息，如果該客

9、戶存在返回為0，其他情況參考錯誤編碼*/public RUserInfo getUserInfo (String userNo);5. 數(shù)據(jù)庫設計詳見 xxx 數(shù)據(jù)庫設計說明書 如果數(shù)據(jù)庫設計內(nèi)容比較少，則直接在此處描述。6. 系統(tǒng)安全保密設計6.1 說明例如: 由于存在與外部系統(tǒng)的接口 ,所以需要考慮訪問安全的問題 . 6.2 設計 例如:分為數(shù)據(jù)傳輸部分 ,IP 過濾部分 ,身份驗證部分 . 章節(jié)可補充 6.2.1 數(shù) 據(jù)傳輸部分例如: 在部分數(shù)據(jù)傳遞的時候 ,考慮以 https 協(xié)議,需要在部署的時候作相關處 理. 6.2.2 IP 過濾分部例如:可在系統(tǒng)前端通過 Filter 實現(xiàn),該

10、 Filter 實現(xiàn)對該地址訪問的 IP 過濾 作用.可信任 IP 地址通過 xml 文件進行配置 .6.2.3 身份驗證部分例如:對信任的用戶 ,頒發(fā)身份驗證碼 ,通過該標識進行身份識別 .7. 系統(tǒng)性能設計8. 系統(tǒng)出錯處理例如: 為了在系統(tǒng)出現(xiàn)異常情況下給用戶以明確的提示，可采用兩種方式予以 提示:1( 使用 Javascript 的 alert() 函數(shù)直接提示，這主要在輸入或修改的情況下使 用;2( 使用統(tǒng)一的錯誤界面提示，該界面對應于 errorpage.jsp 頁面。錯誤界面樣 式如下圖所示:錯誤提示 : “錯誤提示內(nèi)容”返回錯誤提示界面 古今名言敏而好學，不恥下問孔子業(yè)精于勤，荒于嬉 ; 行成于思，毀于隨韓愈 興于詩，立于禮，成于 樂孔子 己所不欲，勿施于人孔子讀書破萬卷，下筆如有神杜甫讀書有三到，謂心到，眼到，口到朱熹 立身以立學為先，立學以讀書為 本歐陽修 讀萬卷書，行萬里路劉彝黑發(fā)不知勤學早，白首方悔讀書遲顏真卿 書卷多情似故人，晨昏憂樂每 相親于謙 書猶藥也，善讀之可以醫(yī)愚劉向莫等閑，白了少年頭，空悲切岳飛 發(fā)奮識遍天下字，立志讀盡人間書 蘇軾 鳥欲高飛先振翅，人求上進先讀書李苦禪立志宜思真品格，讀書須盡苦功夫阮元 非淡泊無以明志，非寧靜無以致遠諸葛亮 熟讀唐詩三百首，不會作詩也會