概要設(shè)計說明書

概要設(shè)計說明書編寫指南文件編號：CP/B05-C03版本號：V1.0.0受控狀態(tài)：受控發(fā)放號：編制部門:編制日期:審核日期:編制日期:審核日期:批準(zhǔn)日期:審核人：批準(zhǔn)人：XXX公司發(fā)布

變更記錄序號修改條款修改單號頁號修改人/日期批準(zhǔn)人/日期實施日期地址電話項目名稱概要設(shè)計說明書管制文件請勿翻印'｛等中電鑿軍概要設(shè)計說明書文件編號：CP/B05-C03版本號：V1.0.0文檔變更記錄序號修改條款修改說明頁號修改人/日期批準(zhǔn)人/日期備注成蟄GhinmPowEr'｛等中電管軍概要設(shè)計說明書文件編號：CP/B05-C03版本號：V1.0.0評審記錄評審名稱評審時間評審地點記錄人評審方式會議式（）傳閱式（）批準(zhǔn)式（）其它對象目的評審內(nèi)容（可附后）評審意見評審結(jié)論備注參評人簽字職務(wù)參評人簽字職務(wù)參評人簽字職務(wù)批準(zhǔn)人批準(zhǔn)日期概要設(shè)計說明書文件編號：CP/B05-C03版本號：V1.0.01-引言1.1目的概述本文檔的編寫目的、主要闡述內(nèi)容以及通過編寫此文檔能夠達(dá)到的目的。1.2范圍概述本文檔適用的范圍以及預(yù)期讀者。1-3定義、首字母縮寫詞和縮略語建議提供全部術(shù)語、縮寫詞及略語的定義，以便對本文檔進(jìn)行適當(dāng)?shù)慕忉尅?參考資料建議按文檔號和標(biāo)題列出本報告引用的所有文檔，包括所使用的標(biāo)準(zhǔn)等。整體說明2.1系統(tǒng)概述簡要介紹系統(tǒng)開發(fā)背景、目的和意義、應(yīng)用目標(biāo)等相關(guān)情況。2.2系統(tǒng)結(jié)構(gòu)2-2.1功能結(jié)構(gòu)以系統(tǒng)用例圖、系統(tǒng)模塊組成圖或系統(tǒng)邏輯關(guān)系圖等方式描述系統(tǒng)功能組成，同時對圖中每個組成部分以文字方式進(jìn)行簡要說明。2.2.2技術(shù)結(jié)構(gòu)簡要介紹系統(tǒng)采用的技術(shù)路線、技術(shù)手段、整體技術(shù)架構(gòu)及實現(xiàn)思路等。2.2.3軟硬件及網(wǎng)絡(luò)構(gòu)成簡要介紹系統(tǒng)要求的硬件設(shè)備、支持軟件及網(wǎng)絡(luò)構(gòu)成，可根據(jù)應(yīng)用系統(tǒng)實際特點進(jìn)行有所側(cè)重的說明。2.3安全保密設(shè)計介紹系統(tǒng)采用的安全措施與手段，包括應(yīng)用安全、數(shù)據(jù)安全、備份與恢復(fù)及其他情況。第1頁概要設(shè)計說明書文件編號：CP/B05-C03版本號：V1.0.0應(yīng)用安全內(nèi)容廣泛，包括權(quán)限管理機(jī)制、身份認(rèn)證等；數(shù)據(jù)安全包括關(guān)鍵數(shù)據(jù)的加密解密，傳輸安全等；數(shù)據(jù)的定期備份與故障恢復(fù)等；另外如有其他方面的安全保密設(shè)計，可根據(jù)系統(tǒng)實際情況進(jìn)行說明。2.4與其他外部系統(tǒng)的關(guān)系簡要介紹系統(tǒng)與其他外部系統(tǒng)的關(guān)系，包括系統(tǒng)能夠為外部系統(tǒng)提供的服務(wù)，需要外部系統(tǒng)提供的服務(wù)及服務(wù)內(nèi)容的簡要說明。如無可空缺。2.5系統(tǒng)移植方案（備用）介紹對系統(tǒng)進(jìn)行數(shù)據(jù)庫移植、操作系統(tǒng)移植等操作時的注意事項。2.6系統(tǒng)運行（備用）簡要介紹系統(tǒng)運行的計劃周期、頻度、數(shù)據(jù)量、數(shù)據(jù)增長速率、系統(tǒng)承受能力，并發(fā)用戶數(shù)以及緊急情況的對應(yīng)方法等系統(tǒng)運行相關(guān)內(nèi)容，以及系統(tǒng)的升級計劃和系統(tǒng)維護(hù)方式。系統(tǒng)設(shè)計從4.1節(jié)開始編號。分節(jié)標(biāo)識和描述各功能模塊。3.XoOO（X代表子系統(tǒng)序號）3.X.1流程以流程圖的形式描述復(fù)雜功能模塊的內(nèi)部實現(xiàn)邏輯。畫流程圖的目的是為了更清晰描述復(fù)雜的功能模塊，因此不要求對每個功能模塊都進(jìn)行流程說明。如果功能模塊內(nèi)部還可分為子系統(tǒng)，且子系統(tǒng)的流程也較復(fù)雜，則可以按照子系統(tǒng)再向下分解，向下探測到每個子系統(tǒng)的內(nèi)部實現(xiàn)。目的就在于將系統(tǒng)中復(fù)雜流程的控制邏輯描述清楚。3.X.2概念級類圖建議包含概念級類圖及對類圖中各個類的簡要說明，對類進(jìn)行說明時建議至少包含類的主要屬性和方法，以及各個類之間的相互關(guān)系。3.X.3類與需求用例或模塊之間的關(guān)系可以表格的形式說明類圖中的各個類與需求用例或模塊之間的實現(xiàn)對應(yīng)關(guān)系。3.X.4時序圖概要設(shè)計說明書文件編號：CP/B05-C03版本號：V1.0.0為進(jìn)一步明確模塊功能，可用時序圖的方式對需求用例中的典型場景進(jìn)行進(jìn)一步描述。時序圖與流程控制圖不同，后者偏重于整體流程的控制，前者說明的是用例的某個場景，表明類對象之間的交互關(guān)系。3.X.5數(shù)據(jù)庫邏輯接口簡要說明本功能模塊用到的數(shù)據(jù)庫與其它功能模塊之間的接口。3.X.6數(shù)據(jù)庫表與類之間的關(guān)系可以表格的形式說明本模塊中主要的數(shù)據(jù)庫表，以及數(shù)據(jù)庫表與類之間的關(guān)系。3.X.7接口簡要介紹模塊的接口方法、用戶界面、硬件接口、軟件接口等相關(guān)內(nèi)容。其中接口方法能夠說明本模塊與其他模塊之間的交互即可，在需求相對明確的前提下，盡量將接口主要參數(shù)等確定。可以使用類圖的形式描述用戶界面，將主要頁面表示成界面類，類圖能夠說明界面類之間的關(guān)系即可，盡量與真正的界面流程一致。硬件接口指與其他硬件設(shè)備的接口說明，軟件接口指與其他軟件系統(tǒng)的接口說明。接口說明可視系統(tǒng)具體情況而定，如有其他需說明的內(nèi)容，可在此處補充說明。公共設(shè)計4.1公共程序、基類設(shè)計從4.1.1節(jié)開始編號。分節(jié)標(biāo)識和描述各公共程序、基類。4.1.X°°°（X代表公共程序、基類序號）4.1.X.1公用程序、基類設(shè)計簡要介紹公用程序、基類的功能，接口，屬性和方法等內(nèi)容。具體說明方法可參考系統(tǒng)設(shè)計中對各功能模塊的說明。4.1.X.2公用數(shù)據(jù)結(jié)構(gòu)、數(shù)據(jù)庫表設(shè)計簡要介紹公用程序、基類的數(shù)據(jù)庫結(jié)構(gòu)，包括主要數(shù)據(jù)庫表說明，及數(shù)據(jù)庫表與類之間的對應(yīng)關(guān)系等內(nèi)容。4.2異常處理、錯誤處理方案簡要介紹系統(tǒng)采用的異常處理方式、錯誤處