項目名稱-詳細設(shè)計說明書 (2).docx

1、初稿V發(fā)布修訂編撰：梅芝雨編撰日期：2007-05-10保密級別：機密文檔版本：3.0文件編號：Q/BS-QH-3-08項目名稱詳細設(shè)計說明書創(chuàng)業(yè)慧康科技股份有限公司界面設(shè)計的內(nèi)容可在此處展示。5.1.3詳細設(shè)計不同的系統(tǒng)可使用不同的模版。PB開發(fā)的程序聽使用以I、模版。方法、事件名稱功能處理描述InstanceVariablesOpenCloseQueryCloseUcinitWf_Veriy()Wf_Save()Cb_add(增加)ClickCb_Delete(刪除)Clickjava或.net開發(fā)的程序可使用以下模版。前臺詳細設(shè)計文件名稱繼承自方法、事件名稱功能處理描述5.

2、1.3.2后臺詳細設(shè)計模塊名稱父類或?qū)崿F(xiàn)接口方法XXX屬性XXX方法（以下是對所寫方法的詳細解析）功能描述前置條件即前提條件，寫明需要滿足什么樣的條件。輸入項輸出項后置條件發(fā)生后的結(jié)果，會產(chǎn)生哪些影響。數(shù)據(jù)結(jié)構(gòu)與算法補充說明5.2模塊02名稱5.2.1模塊說明不同的系統(tǒng)可使用不同的模版。PB開發(fā)的程序可使用以下模版。名稱窗口或用戶對象的名稱繼承自功能描述描述該模塊實現(xiàn)的功能輸入項輸入的數(shù)據(jù)項。包括從數(shù)據(jù)表中獲取的內(nèi)容。輸出項輸出的數(shù)據(jù)項，包括寫入數(shù)據(jù)表或報表展示的內(nèi)容。處理流程簡要描述業(yè)務(wù)處理流程。接口說明指和別的模塊間的接口。不包括和數(shù)據(jù)庫有關(guān)的數(shù)據(jù)交互。復(fù)用說明對使用復(fù)用項的說明備注其他需

3、要特別說明的內(nèi)容。包括該模塊的測試要點也可在其中描述。java或.net開發(fā)的程序可使用以卜.模版。名稱功能描述接口與屬性此處可選處理流程畫流程圖流程說明數(shù)據(jù)字典此處可選復(fù)用說明備注5. 2.2參考界面界面設(shè)計的內(nèi)容可在此處展示。5.2.3詳細設(shè)計不同的系統(tǒng)可使用不同的模版。PB開發(fā)的程序可使用以卜模版。java或.net開發(fā)的程序可使用以下模版。方法、事件名稱功能處理描述InstanceVariablesOpenCloseQueryCloseUcinitWf_Veriy()Wf_Save()Cb_add(增加)ClickCb_Delete(刪除)Click前臺詳細設(shè)計文件名稱繼

4、承自方法、事件名稱功能處理描述后臺詳細設(shè)計模塊名稱父類或?qū)崿F(xiàn)接口方法XXX屬性XXX方法（以下是對所寫方法的詳細解析）功能描述前置條件即前提條件，寫明需要滿足什么樣的條件。輸入項輸出項后置條件發(fā)生后的結(jié)果，會產(chǎn)生哪些影響。數(shù)據(jù)結(jié)構(gòu)與算法補充說明5.3模塊n名稱5.3.1模塊說明不同的系統(tǒng)可使用不同的模版。PB開發(fā)的程序可使用以下模版。名稱窗口或用戶對象的名稱繼承自功能描述描述該模塊實現(xiàn)的功能輸入項輸入的數(shù)據(jù)項。包括從數(shù)據(jù)表中獲取的內(nèi)容。輸出項輸出的數(shù)據(jù)項，包括寫入數(shù)據(jù)表或報表展示的內(nèi)容。處理流程簡要描述業(yè)務(wù)處理流程。接口說明指和別的模塊間的接口。不包括和數(shù)據(jù)庫有關(guān)的數(shù)據(jù)交互。復(fù)用

5、說明對使用復(fù)用項的說明備注其他需要特別說明的內(nèi)容。包括該模塊的測試要點也可在其中描述。java或.nel開發(fā)的程序可使用以下模版。名稱功能描述接口與屬性此處可選處理流程畫流程圖流程說明數(shù)據(jù)字典此處可選復(fù)用說明備注5.3.2參考界面界面設(shè)計的內(nèi)容可在此處展示。5.3.3詳細設(shè)計不同的系統(tǒng)可使用不同的模版。PB開發(fā)的程序町使用以卜模版。方法、事件名稱功能處理描述InstanceVariablesOpenClosoQueryCloseUe_initWf_Veriy()Wf_Save()Cb_add(增加)ClickCb_Delete(刪除)Clickjava或.net開發(fā)的程序可使用以下模版。5.3

6、.3.1前臺詳細設(shè)計文件名稱繼承自方法、事件名稱功能處理描述后臺詳細設(shè)計模塊名稱父類或?qū)崿F(xiàn)接口方法XXX屬性XXX方法（以下是對所寫方法的詳細解析）功能描述前置條件即前提條件，寫明需要滿足什么樣的條件。輸入項輸出項后置條件發(fā)生后的結(jié)果，會產(chǎn)生哪些影響。數(shù)據(jù)結(jié)構(gòu)與算法補充說明6接口設(shè)計6.1接口匯總表接口名稱功能說明接口A接口B接口6.2接口APB開發(fā)的程序可使用以下格式。方法、事件名稱功能處理描述java或.net開發(fā)的程序可使用以下格式。模塊名稱父類或?qū)崿F(xiàn)接口方法屬性方法（以下是對所寫方法的詳細解析）功能描述前置條件輸入項輸出項后置條件數(shù)據(jù)結(jié)構(gòu)與算法補充說明6.3接口日7數(shù)據(jù)庫

7、設(shè)計備注：如果有完整的PDM,可寫詳見PDM文件，此章節(jié)內(nèi)容可略。7. 1數(shù)據(jù)庫匯總表7.1.1表匯總表表名中文描述功能說明表A表B表7.1.2視圖匯總表視圖名中文描述功能說明關(guān)聯(lián)的表相關(guān)聯(lián)的模塊視圖A視圖B視圖7.1.3存儲過程匯總表存儲的過程中文描述功能說明關(guān)聯(lián)的表存儲過程A存儲過程B存儲過程7.1.4觸發(fā)器匯總表觸發(fā)器名中文描述功能說明觸發(fā)器類型所在表相關(guān)聯(lián)的表觸發(fā)器A觸發(fā)器B觸發(fā)器7.2數(shù)據(jù)庫詳細設(shè)計7.2.1表詳細設(shè)計 表A表B7.2.2視圖詳細設(shè)計視圖A視圖B7.2.3存儲過程詳細設(shè)計存儲過程A存儲

8、過程B7.2.4觸發(fā)器詳細設(shè)計觸發(fā)器A觸發(fā)器B8非功能性設(shè)計8.1性能方面設(shè)計性能方面需求方面的特殊的詳細設(shè)計。2易用性方面設(shè)計對般用戶日常維護操作和系統(tǒng)管理的日常維護進行設(shè)計，如備份、恢復(fù)操作，數(shù)據(jù)物理安全。8.3其它非功能性設(shè)計系統(tǒng)在運行可靠性、安全性、擴充、容量擴大和可移植性、開放性等方面的說明。8.4錯誤處理8.4.1出錯類別如系統(tǒng)對可能出現(xiàn)的某些錯誤和故障作了專門的設(shè)計考慮，給出這些錯誤或故障的定義和對錯誤進行編碼。8.4.2出錯處理說明將使用的恢復(fù)或再啟動技術(shù)，使軟件從故障點恢復(fù)執(zhí)行或軟件從頭開始重新運行的方法。EPG版本歷史日期版本說明作者2009-0

9、6-12V2.1修改EPG2011-03-15V2.2修改EPG2011-10-15V2.3將模塊設(shè)計說明書、接口設(shè)計說明書、數(shù)據(jù)庫設(shè)計說明書、用戶界面設(shè)計說明書合并成一份詳細設(shè)計說明書李定軍2013-02-04V2.4修改模塊設(shè)計和接口設(shè)計的內(nèi)容倪慧敏2019-03-29V2.5修改公司名稱及LOGO張巧英2021-03-25V3.0公司審批，正式發(fā)布EPG項目組版本歷史日期版本說明作者xxxx-xx-xx8.4.3系統(tǒng)調(diào)整及再次開發(fā)問題未來可能對系統(tǒng)進行的一些調(diào)整、限制和再次開發(fā)等問題，以及詳細設(shè)計中尚未解決但開發(fā)者認為在開發(fā)階段必須解決的問題。9關(guān)鍵技術(shù)關(guān)鍵技術(shù)指項目所采用的核心技術(shù)或技

10、術(shù)難點、新技術(shù)（如果有的話）。在詳細設(shè)計階段應(yīng)確認概要設(shè)計中關(guān)鍵技術(shù)的設(shè)置，對每一項關(guān)鍵技術(shù)進一步明確詳細的解決方案。9.1關(guān)鍵技術(shù)的一般說明說明關(guān)鍵技術(shù)的名稱、必要性、技術(shù)難點、進度、計劃等（可以用表格）。2關(guān)鍵技術(shù)的實現(xiàn)方案詳細介紹各項關(guān)鍵技術(shù)的實現(xiàn)方案。10其他1 引言51.1 系統(tǒng)簡述51.2 軟件設(shè)計目標(biāo)51.3 參考資料51.4 術(shù)語與縮寫詞5規(guī)范和要求62. 1命名規(guī)則62.2 界面設(shè)計規(guī)范62.3 接口規(guī)范6模塊匯總63. 1庫文件說明63.2 模塊列表7設(shè)計概述71.5 系統(tǒng)總體設(shè)計71.6 約束和假定7模塊設(shè)計85.1模塊01名稱85.1.1模塊說明85.1.2參考界面85

11、.1.3詳細設(shè)計95.2 模塊02名稱105.2.1模塊說明105.2.2參考界面11詳細設(shè)計115.3.1模塊說明125.3.2參考界面135.3.3詳細設(shè)計13接口設(shè)計156.1接口匯總表156.2 接口A156. 3接口B16數(shù)據(jù)庫設(shè)計167. 1數(shù)據(jù)庫匯總表161.1表匯總表167. 1.2視圖匯總表16存儲過程匯總表167.1.3 觸發(fā)器匯總表167.2 數(shù)據(jù)庫詳細設(shè)計177.2.1表詳細設(shè)計177.2.2視圖詳細設(shè)計177.2.3存儲過程詳細設(shè)計177. 2.4觸發(fā)器詳細設(shè)計17非功能性設(shè)計188. 1性能方面設(shè)計188.2 易用性方面設(shè)計188.3 其它非功能性設(shè)計188.4 錯

12、誤處理188.4.1出錯類別188. 4.2出錯處理187. 4.3系統(tǒng)調(diào)整及再次開發(fā)問題19關(guān)鍵技術(shù)199.1關(guān)鍵技術(shù)的一般說明199.2關(guān)鍵技術(shù)的實現(xiàn)方案19其他191引言1.1系統(tǒng)簡述對系統(tǒng)要完成什么，所面向的用戶以及系統(tǒng)運行的環(huán)境的簡短描述，這部分主要來源于需求說明書的開始部分。1.2軟件設(shè)計目標(biāo)這部分論述整個系統(tǒng)的設(shè)計目標(biāo)，明確地說明哪些功能是系統(tǒng)決定實現(xiàn)而哪些時不準(zhǔn)備實現(xiàn)的。同時，對于非功能性的需求例如性能、可用性等，亦需提及。需求規(guī)格說明書對于這部分的內(nèi)容來說是很重要的參考，看看其中明確了的功能性以及非功能性的需求。這部分必須說清楚設(shè)計的全貌如何，務(wù)必使讀者看后知道將實現(xiàn)的系統(tǒng)有

13、什么特點和功能。在隨后的文檔部分，將解釋設(shè)計是怎么來實現(xiàn)這些的。1.3參考資料列出編寫本報告時參考的文件（如經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級機關(guān)的批文等）、資料、技術(shù)標(biāo)準(zhǔn),以及他們的作者、標(biāo)題、編號、發(fā)布口期和出版單位。參考文檔名稱作者備注說明1.4術(shù)語與縮寫詞列出本報告中用到的專門術(shù)語的定義。術(shù)語縮寫詞說明2規(guī)范和要求2.1命名規(guī)則模塊設(shè)計人員確定本軟件的模塊命名規(guī)則（例如類、函數(shù)、變更等），數(shù)據(jù)庫設(shè)計人員命名規(guī)則（例如：表、視圖、存儲過程、觸發(fā)器等），確保設(shè)計文檔的風(fēng)格與代碼的風(fēng)格保持一致。可以從組織的編程規(guī)范中摘取或引用。2界面設(shè)計規(guī)范結(jié)合用戶需求和組織定義的實現(xiàn)與測試過程中的軟件開發(fā)規(guī)范

14、（軟件界面設(shè)計標(biāo)準(zhǔn)規(guī)范），闡述軟件用戶界面設(shè)計應(yīng)遵循的規(guī)范（原則、建議等）。2.3接口規(guī)范模塊設(shè)計人員確定木軟件的模塊命名規(guī)則（例如類、函數(shù)、變更等），確保模塊設(shè)計文檔的風(fēng)格與代碼的風(fēng)格保持一致?？梢詮慕M織的編程規(guī)范中摘取或引用。3模塊匯總3.1庫文件說明序號文件名稱說明支持庫1庫文件的名稱該文件包含的內(nèi)容支持庫的文件名稱234562. 2模塊列表編號模塊名稱功能簡述01020304050607084設(shè)計概述4.1系統(tǒng)總體設(shè)計這部分要求提供高層系統(tǒng)結(jié)構(gòu)的描述，使用方框圖來顯示主要的組件及組件間的交互。最好是把邏輯結(jié)構(gòu)同物理結(jié)構(gòu)分離，對前者進行描述。別忘了說明圖中用到的俗語和符號。備注：如果項目

15、有概要設(shè)計說明書，可寫詳見項目名稱-概要設(shè)計說明書，此章節(jié)內(nèi)容可略。3. 2約束和假定描述系統(tǒng)設(shè)計中最主要的約束，這些是由客戶強制要求并在需求說明書寫明的。說明系統(tǒng)是如何來適應(yīng)這些約束的。另外如果本系統(tǒng)跟其它外部系統(tǒng)交互或者依賴其它外部系統(tǒng)提供一些功能輔助，那么系統(tǒng)可能還受到其它的約束。這種情況下，要求清楚地描述與本系統(tǒng)有交互的軟件類型（比如某某某數(shù)據(jù)庫軟件，某某某EMail軟件）以及這樣導(dǎo)致的約束（比如只允許純文本的Email）。實現(xiàn)的語言和平臺也會對系統(tǒng)有約束，同樣在此予以說明。對于因選擇具體的設(shè)計實現(xiàn)而導(dǎo)致對系統(tǒng)的約束，簡要地描述你的想法思路，經(jīng)過怎么樣的權(quán)衡,為什么要采取這樣的設(shè)計等等。5模塊設(shè)計5.1模塊01名稱5.1.1模塊說明不同的系統(tǒng)可使用不同的模版。PB開發(fā)的程序