詳細設計說明書模板

××××詳細設計說明書文檔編號：CMMI_TS_TEM_PARD文檔信息：詳細設計說明書文檔名稱：詳細設計說明書文檔類別：CMMI模板密級：內部秘密版本信息：1.1建立日期：2020-1-1創(chuàng)建人：XXX批準人：XXX批準日期：2020.1.1存放位置：集成公司組織資產庫/組織標準過程編輯軟件：MicrosoftOffice2019中文版

文檔修訂記錄（引用時請修改為實際項目的信息）版本編號或者更改記錄編號變化狀態(tài)簡要說明（變更內容和變更范圍）修改日期變更人批準日期批準人V1.0C創(chuàng)建V1.0M文檔編號去掉版本號*變化狀態(tài)：C――創(chuàng)建，A——增加，M——修改，D——刪除目錄1 導言 41.1 目的 41.2 范圍 41.3 術語定義 41.4 相關文檔 41.5 參考資料 42 功能模塊實現(xiàn)設計 52.1 功能模塊清單 52.2 一級功能模塊名稱 52.2.1 二級功能模塊名稱 53 數(shù)據(jù)庫實現(xiàn)設計 63.1 數(shù)據(jù)庫模塊清單 63.2 存儲過程實現(xiàn)設計 63.2.1 存儲過程名稱1 63.3 函數(shù)實現(xiàn)設計 73.3.1 函數(shù)名稱1 73.4 觸發(fā)器實現(xiàn)設計 84 外部接口實現(xiàn)設計 84.1 外部接口模塊清單 84.2 外部接口1實現(xiàn)設計 84.3 外部接口2實現(xiàn)設計 95 其它實現(xiàn)設計 95.1 設計名稱1 106 程序文件清單 10導言[本章對該文檔的目的、功能范圍、術語、相關文檔、參考資料、版本更新進行說明。]目的[本文檔的目的旨在推動軟件工程的規(guī)范化，使設計人員遵循統(tǒng)一的詳細設計書寫規(guī)范，節(jié)省制作文檔的時間，降低系統(tǒng)實現(xiàn)的風險，做到系統(tǒng)設計資料的規(guī)范性與全面性，以利于系統(tǒng)的實現(xiàn)、測試、維護、版本升級等。詳細設計的詳細程度，應達到可以編寫程序的水平。[范圍[本文檔用于軟件設計階段的詳細設計，它的上游（依據(jù)的基線）是概要設計說明書，它的下游是源程序清單及單元測試計劃，并為單元測試報告提供測試依據(jù)。軟件詳細設計的范圍是：各功能模塊實現(xiàn)設計、數(shù)據(jù)庫實現(xiàn)設計。[術語定義序號術語名稱術語定義1詳細設計在概要設計的基礎上，對其功能模塊或部件進行實現(xiàn)設計，使編程人員據(jù)此能順利書寫出程序代碼。2存儲過程存放在數(shù)據(jù)庫服務器上的一段程序，它能被其它程序調用，以完成對數(shù)據(jù)庫表的某些規(guī)定操作。3觸發(fā)器存放在數(shù)據(jù)庫服務器上的一段程序，當觸發(fā)條件滿足時它就被執(zhí)行，以完成對數(shù)據(jù)庫表的某些規(guī)定操作。相關文檔源程序清單單元測試計劃及報告用戶使用手冊參考資料軟件需求規(guī)格說明書概要設計說明書軟件合同命名規(guī)范

功能模塊實現(xiàn)設計[詳細設計是面向模塊的，或者說是面向部件（組件或構件）的，不是面向組織結構或部門單位的。一個組織或單位，根據(jù)角色的授權，可以掛上某些功能模塊。]功能模塊清單[編碼規(guī)則：DM_[一級模塊英文簡稱]_{}_001DM_[一級模塊英文簡稱]_{}_002……其中{}中的內容為可選項，如果在模塊中還需要進一步細分模塊，則采用{}中的內容進一步對模塊進行區(qū)分，但最多下分一級，即模塊編號最多分四段。下表模塊可只寫到一級模塊，詳細模塊見下。需求跟蹤時跟蹤到葉子節(jié)點，需求跟蹤矩陣中只填寫葉子節(jié)點。]模塊編號模塊名稱模塊英文名稱模塊功能簡述模塊的接口說明一級功能模塊名稱二級功能模塊名稱模塊編號DM_XXX_001模塊名稱英文名稱功能描述接口標準提供調用背景描述[對背景進行簡單的描述。為什么需要此模塊功能，其上下文環(huán)境。涉及業(yè)務背景內容，與需求相結合。]模塊提供接口描述[詳細列出提供的接口方法、入口參數(shù)、出口參數(shù)、異常處理（針對公用方法）]相關表[說明引用的主要業(yè)務表，說明對表所進行的操作（讀/寫）]模塊算法設計[描述具體的操作步驟。描述操作步驟，簡單的說明書內容?？梢圆捎脠D形交互。]模塊編寫者[寫上編寫者姓名]模塊編寫日期[寫上編寫日期：yyyy/mm/dd]模塊修訂者[寫上修訂者姓名，如果未進行修訂，填寫“無”]模塊修訂日期[寫上編寫日期：yyyy/mm/dd，如果未進行修訂，填寫“無”]注意事項[實現(xiàn)該功能項需注意的問題]數(shù)據(jù)庫實現(xiàn)設計數(shù)據(jù)庫模塊清單[編號規(guī)則：存儲過程（procedure），以DP開頭：DP_{}_001、DP_{}_002函數(shù)（function），以DF開頭：DF_{}_001、DF_{}_002觸發(fā)器（trigger），以DT開頭：DT_{}_001、DT_{}_002其中{}中的內容為可選項，如果在模塊中還需要進一步細分模塊，則采用{}中的內容進一步對模塊進行區(qū)分，但最多下分一級，即模塊編號最多分四段。下表模塊可只寫到一級模塊，詳細模塊見下。需求跟蹤時跟蹤到葉子節(jié)點，需求跟蹤矩陣中只填寫葉子節(jié)點。]模塊編號模塊名稱模塊英文名稱模塊功能簡述存儲過程實現(xiàn)設計存儲過程名稱1[存儲過程是一種特殊的公用模塊，它在數(shù)據(jù)庫服務器上執(zhí)行，這里將它單獨列出來，規(guī)定其詳細設計模板為：]模板編號存儲過程中文名存儲過程英文名稱功能描述[詳細描述其功能]過程算法[用形式語言詳細描述其算法分析，使編程人員據(jù)此能順利書寫程序]調用方式參數(shù)入口參數(shù)出口參數(shù)模塊編寫者[寫上編寫者姓名]模塊編寫日期[寫上編寫日期：yyyy/mm/dd]模塊修訂者[寫上修訂者姓名，如果未進行修訂，填寫“無”]模塊修訂日期[寫上編寫日期：yyyy/mm/dd，如果未進行修訂，填寫“無”]注意事項[實現(xiàn)該功能項需注意的問題]函數(shù)實現(xiàn)設計函數(shù)名稱1[函數(shù)是一種特殊的公用模塊，它在數(shù)據(jù)庫服務器上執(zhí)行，這里將它單獨列出來，規(guī)定其詳細設計模板為：]模板編號函數(shù)過程中文名函數(shù)英文名稱功能描述[詳細描述其功能]過程算法[用形式語言詳細描述其算法分析，使編程人員據(jù)此能順利書寫程序]調用方式參數(shù)入口參數(shù)出口參數(shù)模塊編寫者[寫上編寫者姓名]模塊編寫日期[寫上編寫日期：yyyy/mm/dd]模塊修訂者[寫上修訂者姓名，如果未進行修訂，填寫“無”]模塊修訂日期[寫上編寫日期：yyyy/mm/dd，如果未進行修訂，填寫“無”]注意事項[實現(xiàn)該功能項需注意的問題]觸發(fā)器實現(xiàn)設計[觸發(fā)器也是一種公用的模塊，不過它是隱式執(zhí)行，這里將它單獨列出來，規(guī)定其詳細設計模板為：注意：過多地使用觸發(fā)器反而會使系統(tǒng)的效率降低。因此，凡是能用存儲過程代替觸發(fā)器功能的地方，一律用存儲過程來實現(xiàn)。]模板編號觸發(fā)器中文名觸發(fā)器英文名稱功能描述[詳細描述其功能]過程算法[用形式語言詳細描述其算法分析，使編程人員據(jù)此能順利書寫程序]激活條件模塊編寫者[寫上編寫者姓名]模塊編寫日期[寫上編寫日期：yyyy/mm/dd]模塊修訂者[寫上修訂者姓名，如果未進行修訂，填寫“無”]模塊修訂日期[寫上編寫日期：yyyy/mm/dd，如果未進行修訂，填寫“無”]注意事項[實現(xiàn)該功能項需注意的問題]外部接口實現(xiàn)設計外部接口模塊清單[編號規(guī)則：DOM_[一級模塊英文簡稱]_{}_001DOM_[一級模塊英文簡稱]_{}_002……其中{}中的內容為可選項，如果在模塊中還需要進一步細分模塊，則采用{}中的內容進一步對模塊進行區(qū)分，但最多下分一級，即模塊編號最多分四段。下表模塊可只寫到一級模塊，詳細模塊見下。需求跟蹤時跟蹤到葉子節(jié)點，需求跟蹤矩陣中只填寫葉子節(jié)點。]接口編號接口名稱接口英文名稱模塊功能簡述外部接口1實現(xiàn)設計接口中文名稱：接口英文名稱：接口內容與功能：詳細描述接口的內容與功能，如實現(xiàn)數(shù)據(jù)傳輸或數(shù)據(jù)交換。接口硬件設施：詳細描述接口的硬件設施，如交換機、傳感器或輸出設備。接口軟件或中間件：詳細描述接口軟件或中間件的名稱、功能、使用方法、生產廠商。接口的數(shù)據(jù)結構：詳細描述接口的數(shù)據(jù)結構，如文件結構、數(shù)據(jù)庫表結構。這是描述的重點之一。接口的傳輸頻率（兆/秒）：定量說明每秒最大流量。接口帶寬：定量說明帶寬，如多少兆。接口協(xié)議：說明具體協(xié)議。接口程序的算法分析：這是重點之二，要求用形式語言描述具體算法，使編碼人員據(jù)此能順利書寫程序。外部接口2實現(xiàn)設計接口中文名稱：接口英文名稱：接口內容與功能：詳細描述接口的內容與功能，如實現(xiàn)數(shù)據(jù)傳輸或數(shù)據(jù)交換。接口硬件設施：詳細描述接口的硬件設施，如交換機、傳感器或輸出設備。接口軟件或中間件：詳細描述接口軟件或中間件的名稱、功能、使用方法、生產廠商。接口的數(shù)據(jù)結構：詳細描述接口的數(shù)據(jù)結構，如文件結構、數(shù)據(jù)庫表結構。這是描述的重點之一。接口的傳輸頻率（兆/秒）：定量說明每秒最大流量。接口帶寬：定量說明帶寬，如多少兆。接口協(xié)議：說明具體協(xié)議。接口程序的算法分析：這是重點之二，要求用形式語言描述具體算法，使編碼人員據(jù)此能順利書寫程序。其它實現(xiàn)設計本章描述前面沒有說明的設計，可參考概要設計說明書，可部門角色授權設計、界面設計、包裝設計、維護設計、數(shù)據(jù)倉庫設計等等。[編碼規(guī)則：DNM_[一級模塊英文簡稱]_{}_001DNM_[一級模塊英文簡稱]_{}_002……其中{}中的內容為可選項，如果在模塊中還需要進一步細分模塊，