概要設(shè)計說明書模板

1、軟件概要設(shè)計說明書模板（V1.0）文檔編號：文檔名稱：編 寫：編寫日期：審 核：審核日期：批 準(zhǔn)：批準(zhǔn)日期：<項目名稱>軟件概要設(shè)計說明書（版本號）文檔編號：項目名稱：編 寫：編寫日期：審 核：審核日期：批 準(zhǔn)：批準(zhǔn)日期：文檔修訂記錄序號修改時間修改人審核人備注123456789101112131415161718目錄第1章 引言61.1 編寫目的61.2 預(yù)期讀者61.3 編寫背景7 系統(tǒng)名稱及版本號7 任務(wù)提出者7 任務(wù)承接者及實施者7 使用者7 與其它系統(tǒng)的關(guān)系71.4 文檔結(jié)構(gòu)81.5 術(shù)語定義81.6 電子文檔編寫工具81.7 參考資料8第2章 系統(tǒng)概述92.1系統(tǒng)目標(biāo)9

2、2.2設(shè)計原則92.3運行環(huán)境9硬件平臺9軟件平臺9網(wǎng)絡(luò)體系結(jié)構(gòu)92.4系統(tǒng)整體結(jié)構(gòu)概述102.5需求功能覆蓋關(guān)系說明102.6關(guān)鍵技術(shù)10第3章 系統(tǒng)功能說明113.1系統(tǒng)功能概述113.2系統(tǒng)外部接口113.3子系統(tǒng)功能說明113.4模塊層次結(jié)構(gòu)圖113.5模塊112模塊功能描述12功能模塊的主要流程說明12功能點名稱112第4章 數(shù)據(jù)庫設(shè)計13第5章 用戶界面設(shè)計135.1基本原則135.2設(shè)計規(guī)范13第6章 出錯處理設(shè)計136.1出錯信息136.2補(bǔ)救措施13第7章 需求可追蹤性14附錄15代碼表手冊15設(shè)計與編程規(guī)范、慣例及約定151數(shù)據(jù)庫設(shè)計規(guī)范152編程規(guī)范153用戶界面規(guī)范15

3、第1章 引言1.1 編寫目的【說明】 本文檔是以軟件需求分析說明書為基礎(chǔ)，進(jìn)一步就軟件需求分析說明書中的功能從計算軟件實現(xiàn)的角度給出的設(shè)計描述。即是對需求分析說明書中的功能以計算機(jī)軟件設(shè)計的角度，對上述功能的實現(xiàn)進(jìn)行合理的功能模塊的劃分、對上述功能模塊的所包含的功能點進(jìn)行描述和說明，必要的情況下可以程序流程圖的方式進(jìn)行說明，這些功能模塊的劃分和設(shè)計是以最終實現(xiàn)軟件需求分析說明書的功能描述的要求為原則的；它將作為項目驗收時重要的標(biāo)準(zhǔn)和依據(jù)。系統(tǒng)概要設(shè)計書要達(dá)到如下一些目標(biāo)：l 定義系統(tǒng)的各個組成部分l 描述各個部分的結(jié)構(gòu)l 描述各個部分的相互關(guān)系以及他們?nèi)绾螀f(xié)調(diào)與合作l 系統(tǒng)各個組成部分運行效率

4、的提高l 項目組成員對解決方案的共識l 進(jìn)行詳細(xì)設(shè)計或編碼的基礎(chǔ)系統(tǒng)概要設(shè)計書主要包括以下內(nèi)容：l 界面設(shè)計：設(shè)計用戶界面的功能和相互調(diào)用關(guān)系l 組件設(shè)計：描述各個組件部分的結(jié)構(gòu)和關(guān)系l 數(shù)據(jù)庫設(shè)計：描述數(shù)據(jù)庫結(jié)構(gòu)和關(guān)系l 外部接口設(shè)計：描述和外部接口的關(guān)聯(lián)1.2 預(yù)期讀者【說明】本文檔的閱讀對象是軟件開發(fā)人員、業(yè)務(wù)規(guī)范設(shè)計人員、軟件測試人員、系統(tǒng)安裝人員及用戶代表。1.3 編寫背景1.3.1 系統(tǒng)名稱及版本號【說明】形如“河北地方稅收征管系統(tǒng)V1.0”1.3.2 任務(wù)提出者【說明】項目組我方的領(lǐng)導(dǎo)機(jī)構(gòu)如： 1.3.3 任務(wù)承接者及實施者【說明】本項目的負(fù)責(zé)人及工作人員名單。如：項目經(jīng)理：XX

5、X開發(fā)人員：XXXXXXXXX1.3.4 使用者【說明】適應(yīng)對象和范圍。主要指預(yù)期讀者，也供有關(guān)領(lǐng)導(dǎo)審閱。1.3.5 與其它系統(tǒng)的關(guān)系【說明】在用戶現(xiàn)有的及預(yù)期的整個應(yīng)用系統(tǒng)中，給本系統(tǒng)準(zhǔn)確定位。用示意圖及相應(yīng)的文字予以說明。1.4 文檔結(jié)構(gòu)【說明】章節(jié)劃分原則、內(nèi)容的取舍、重點的確定等。1.5 術(shù)語定義1.6 電子文檔編寫工具【說明】工具名、版本號、操作系統(tǒng)平臺。使用多種工具時，應(yīng)分別說明。形如： Microsoft Word 97 for Windows 95 Power-Designor 6.0 for Windows 95 1.7 參考資料【說明】格式：作者，版本號，資料來源，日期 ，

6、起止頁號。其中，質(zhì)量保證計劃與需求規(guī)格說明書是必選的參考資料。第2章 系統(tǒng)概述2.1系統(tǒng)目標(biāo)【說明】開發(fā)意圖、應(yīng)用目標(biāo)(總目標(biāo)、分期目標(biāo))、作用范圍、預(yù)期效益等。2.2設(shè)計原則【說明】給出系統(tǒng)在設(shè)計上所遵循的原則。2.3運行環(huán)境（*平臺選型）2.3.1硬件平臺【說明】指出本系統(tǒng)對硬件設(shè)備的需求、我們選型的原則和依據(jù)、推薦的型號與配置、性能綜述、技術(shù)優(yōu)勢、特殊約定等。2.3.2軟件平臺【說明】使用操作系統(tǒng)的名稱、生產(chǎn)廠家、版本號等。使用數(shù)據(jù)庫的名稱、生產(chǎn)廠家、版本號等。如使用了多種數(shù)據(jù)庫，則要說明如何 實現(xiàn)互連。其它支撐軟件：指出開發(fā)與運行時需要的工具軟件的情況。2.3.3網(wǎng)絡(luò)體系結(jié)構(gòu)【說明】寫

7、明網(wǎng)絡(luò)設(shè)計原則、技術(shù)要求、產(chǎn)品選型、拓?fù)浣Y(jié)構(gòu)、基本部件與配件、傳輸介質(zhì)、接口情況、通信協(xié)議、約束條件、結(jié)構(gòu)化綜合布線方案等。畫出網(wǎng)絡(luò)結(jié)構(gòu)圖。圖中應(yīng)標(biāo)出各類服務(wù)器與客戶機(jī)、網(wǎng)管機(jī)、路由器、網(wǎng)關(guān)等的數(shù)量與分布；應(yīng)反映出局域網(wǎng)、廣域網(wǎng)及其互連的情況；如使用國內(nèi)的公用數(shù)據(jù)網(wǎng)或Internet，也須具體標(biāo)出。用文字說明各個服務(wù)器/客戶機(jī)的作用、配置與具體位置。例如：Oracle數(shù)據(jù)庫服務(wù)器1臺，位于局信息中心，用于支撐征管業(yè)務(wù)信息處理、領(lǐng)導(dǎo)決策輔助支持、各征管業(yè)務(wù)科室的信息采集、查詢及統(tǒng)計工作。它安裝在IBM RS6000小型機(jī)上，操作系統(tǒng)是AIX 3.2。說明擬采取的網(wǎng)絡(luò)保護(hù)技術(shù)，如防火墻等。2.4系

8、統(tǒng)整體結(jié)構(gòu)概述【說明】說明本系統(tǒng)的各層模塊、公用模塊的劃分原則。如果系統(tǒng)復(fù)雜而開發(fā)者又有比較多的技術(shù)積累，應(yīng)說明其分層構(gòu)造（如組件層、構(gòu)件層與應(yīng)用子系統(tǒng)層）。 對于大的系統(tǒng)，應(yīng)畫出體系結(jié)構(gòu)圖并予以說明。*總體設(shè)計圖【說明】軟件系統(tǒng)的體系結(jié)構(gòu)圖，或反映程序模塊級別的圖示。總體設(shè)計圖，廢棄原因：體系結(jié)構(gòu)圖與系統(tǒng)整體結(jié)構(gòu)概述內(nèi)容重復(fù)*處理流程（使用圖表）2.5需求功能覆蓋關(guān)系說明與程序之間的關(guān)系【說明】（說明各項功能需求的實現(xiàn)同各塊程序的分配關(guān)系）2.6關(guān)鍵技術(shù)【說明】本系統(tǒng)采用了哪些關(guān)鍵技術(shù)，如算法、中間件、構(gòu)件等。 指出使用了那些主要工具。 解釋作出上述選擇的理由。 說明這些關(guān)鍵技術(shù)在整體結(jié)構(gòu)中

9、的位置及內(nèi)外接口。第3章 系統(tǒng)功能說明3.1系統(tǒng)功能概述【說明】描述系統(tǒng)由哪幾個子系統(tǒng)組成，以及它們之間的關(guān)系，同時對各個子系統(tǒng)的功能進(jìn)行概述?？梢砸韵到y(tǒng)邏輯結(jié)構(gòu)圖的形式進(jìn)行說明。*針對系統(tǒng)模塊級別的用戶權(quán)限管理3.2系統(tǒng)外部接口廢棄原因：在下面的模塊說明中，應(yīng)該有對應(yīng)的模塊來說明用戶權(quán)限管理。【說明】描述對外的接口1.8 *系統(tǒng)的內(nèi)部接口【說明】本系統(tǒng)之內(nèi)的各個系統(tǒng)元素之間的接口的安排。系統(tǒng)框架接口關(guān)系：3.3子系統(tǒng)功能說明【說明】根據(jù)對系統(tǒng)所劃分的子系統(tǒng)數(shù)量隊本節(jié)平級括展，如：3.4、3.5等；對在此處對子系統(tǒng)地功能進(jìn)行說明，同時對子系統(tǒng)地邏輯結(jié)構(gòu)，設(shè)計原則進(jìn)行說明3.4模塊層次結(jié)構(gòu)圖表明

10、各模塊的數(shù)據(jù)關(guān)系和調(diào)用關(guān)系。xzcd如：bcchxlrbcbcbc程序結(jié)構(gòu)圖模塊劃分【說明】以對子系統(tǒng)從系統(tǒng)軟件設(shè)計的角度進(jìn)行功能劃分；3.5模塊13.5.1模塊功能描述【說明】對模塊的功能進(jìn)行描述，包括模塊內(nèi)部的功能組成，以及他們之間的關(guān)系。3.5.2功能模塊的主要流程說明【說明】對模塊內(nèi)部的主要典型流程進(jìn)行描述，詳細(xì)程度可以達(dá)到功能點內(nèi)部方法或函數(shù)的級別。3.5.3功能點名稱13.5.3.1 功能點編號3.5.3.2功能描述【說明】對該功能點的功能進(jìn)行描述3.5.3.3數(shù)據(jù)結(jié)構(gòu)說明【說明】對這個功能點的主要數(shù)據(jù)結(jié)構(gòu)進(jìn)行說明，第4章 數(shù)據(jù)庫設(shè)計詳見數(shù)據(jù)庫設(shè)計文檔（）第5章 用戶界面設(shè)計5.1

11、基本原則【說明】指出基本風(fēng)格、屏幕總體布局和輸入/輸出的常規(guī)手段。5.2設(shè)計規(guī)范【說明】本節(jié)的內(nèi)容也可以歸入附錄“設(shè)計與編程規(guī)范、慣例及約定”中，而不在這里敘述。運行設(shè)計需求或第6章 出錯處理設(shè)計6.1出錯信息用一覽表的方式說明每種可能的出錯或故障情況出現(xiàn)時，系統(tǒng)輸出信息的形式、含意及處理方法。6.2補(bǔ)救措施說明故障出現(xiàn)后可能采取的變通措施，包括： a.后備技術(shù)說明準(zhǔn)備采用的后備技術(shù)，當(dāng)原始系統(tǒng)數(shù)據(jù)萬一丟失時啟用的副本的建立和啟動的技術(shù)，例如周期性地把磁盤信息記錄到磁帶上去就是對于磁盤媒體的一種后備技術(shù)； b降效技術(shù)說明準(zhǔn)備采用的后備技術(shù)，使用另一個效率稍低的系統(tǒng)或方法來求得所需結(jié)果的某些部分，例如一個自動系統(tǒng)的降效技術(shù)可以是手工操作和數(shù)據(jù)的人工記錄； c恢復(fù)及再啟