CMMI-工程-概要設(shè)計說明書模板-V1.0

1、 概要設(shè)計說明書概要設(shè)計說明書模板前 言前言。目 錄第一章 導(dǎo)言21.1 目的21.2 范圍21.3 命名規(guī)則21.4 術(shù)語定義21.5 相關(guān)文檔31.6 參考資料3第二章 總體結(jié)構(gòu)設(shè)計52.1 總體結(jié)構(gòu)圖設(shè)計52.2 運行環(huán)境設(shè)計52.3 子系統(tǒng)清單62.4 功能模塊清單6第三章 模塊（部件）功能分配73.1 專用模塊功能分配73.2 公用模塊功能分配7第四章 全局?jǐn)?shù)據(jù)結(jié)構(gòu)設(shè)計74.1 數(shù)據(jù)庫表名清單84.2 數(shù)據(jù)庫表之間關(guān)系說明84.3 數(shù)據(jù)庫表的詳細(xì)清單84.4 視圖的設(shè)計84.5 其它數(shù)據(jù)結(jié)構(gòu)設(shè)計8第五章 外部接口設(shè)計95.1 外部接口1設(shè)計95.2 外部接口2設(shè)計9第六章 數(shù)據(jù)結(jié)構(gòu)和

2、算法設(shè)計錯誤！未定義書簽。6.1 數(shù)據(jù)結(jié)構(gòu)和程序的關(guān)系86.2 主要算法設(shè)計8第七章 運行設(shè)計97.1 運行模塊組合107.2 運行控制107.3 運行時間10第八章 出錯處理設(shè)計108.1 出錯輸出信息108.2 出錯處理對策10第九章 其它設(shè)計11第 11 頁文檔類別使用對象文檔類別本文檔是軟件系統(tǒng)概要設(shè)計說明書的模板，是概要設(shè)計說明書的書寫標(biāo)準(zhǔn)及規(guī)范，是技術(shù)文檔。使用對象該文檔使用人員包括：l 系統(tǒng)分析人員l 系統(tǒng)設(shè)計人員l 系統(tǒng)編碼人員l 系統(tǒng)測試人員l 系統(tǒng)維護(hù)人員第一章 導(dǎo)言本章對該文檔的目的、功能范圍、術(shù)語、相關(guān)文檔、參考資料、版本更新進(jìn)行說明。1.1 目的本文檔的目的旨在推動軟

3、件工程的規(guī)范化，使設(shè)計人員遵循統(tǒng)一的概要設(shè)計書寫規(guī)范，節(jié)省制作文檔的時間，降低系統(tǒng)實現(xiàn)的風(fēng)險，做到系統(tǒng)設(shè)計資料的規(guī)范性與全面性，以利于系統(tǒng)的實現(xiàn)、測試、維護(hù)、版本升級等。1.2 范圍本文檔用于軟件設(shè)計階段的概要設(shè)計，它的上游（依據(jù)的基線）是需求分析規(guī)格書，它的下游是系統(tǒng)詳細(xì)設(shè)計說明書，并為詳細(xì)設(shè)計說明書提供測試的依據(jù)。軟件概要設(shè)計的范圍是：軟件系統(tǒng)總體結(jié)構(gòu)、外部接口、主要部件功能分配、全局?jǐn)?shù)據(jù)結(jié)構(gòu)以及部件之間的接口等方面的內(nèi)容。1.3 命名規(guī)則1. 變量對象命名規(guī)則申明全局變量、局部變量對象的命名規(guī)則。2. 數(shù)據(jù)庫對象命名規(guī)則申明數(shù)據(jù)庫表名、字段名、索引名、視圖名對象的命名規(guī)則。1.4 術(shù)語定

4、義序號術(shù)語名稱術(shù)語定義1總體結(jié)構(gòu)軟件系統(tǒng)的總體邏輯結(jié)構(gòu)。按照不同的設(shè)計方法，有不同的總體邏輯結(jié)構(gòu)。若采用傳統(tǒng)的面向功能或面向數(shù)據(jù)的結(jié)構(gòu)化設(shè)計方法，則總體邏輯結(jié)構(gòu)為一樹形的功能模塊結(jié)構(gòu)圖。若采用時尚的面向?qū)ο蠡蛎嫦虿考ńM件）的設(shè)計方法，則總體邏輯結(jié)構(gòu)為部件（組件）的組裝圖。2外部接口本軟件系統(tǒng)與其它軟件系統(tǒng)之間的接口，接口設(shè)施可以是中間件。接口描述包括：傳輸方式、帶寬、數(shù)據(jù)結(jié)構(gòu)、傳輸頻率、傳輸量（兆/秒）、傳輸協(xié)議。3數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)結(jié)構(gòu)包括：關(guān)系數(shù)據(jù)庫表的結(jié)構(gòu)、對象數(shù)據(jù)庫表的結(jié)構(gòu)、變量說明。4概念數(shù)據(jù)模型關(guān)系數(shù)據(jù)庫的邏輯設(shè)計模型，叫概念數(shù)據(jù)模型。主要內(nèi)容包括一張邏輯E-R圖及其相應(yīng)的數(shù)據(jù)字典。5

5、物理數(shù)據(jù)模型關(guān)系數(shù)據(jù)庫的物理設(shè)計模型，叫物理數(shù)據(jù)模型。主要內(nèi)容包括一張物理表關(guān)系圖及其相應(yīng)的數(shù)據(jù)字典。6視圖在基表之上建立的一張?zhí)摫恚幸晥D，它具有物理表的許多性質(zhì)，在授權(quán)上很有用。7角色數(shù)據(jù)庫中享有某些特權(quán)操作的用戶，叫角色。8子系統(tǒng)具有相對獨立功能的小系統(tǒng)叫子系統(tǒng)。一個大的軟件系統(tǒng)可以劃分為多個子系統(tǒng)，每個子系統(tǒng)可由多個模塊或多個部件組成。9模塊具有功能獨立、能被調(diào)用的信息單元叫模塊。模塊是結(jié)構(gòu)化設(shè)計中的概念。10部件（組件）具有功能獨立、能被調(diào)用的、且已包裝的信息單元叫部件（組件）部件是面向?qū)ο笤O(shè)計中的概念。11內(nèi)部接口軟件系統(tǒng)內(nèi)部各子系統(tǒng)之間、各部件之間、各模板之間的接口，叫內(nèi)部接口。

6、接口描述包括：調(diào)用方式、入口信息、出口信息等。12相關(guān)文件相關(guān)文件是指：當(dāng)本文件內(nèi)容變更后，可能引起變更的其它文件。如需求分析報告、詳細(xì)設(shè)計說明書、測試計劃、用戶手冊。13參考資料參考資料是指：本文件書寫時用到的其它資料。如各種有關(guān)規(guī)范、模板、標(biāo)準(zhǔn)、準(zhǔn)則。1.5 相關(guān)文檔詳細(xì)設(shè)計說明書源程序清單測試計劃及報告用戶使用手冊1.6 參考資料用戶需求分析報告軟件開發(fā)合同數(shù)據(jù)庫設(shè)計規(guī)范命名規(guī)范第二章 總體結(jié)構(gòu)設(shè)計2.1 總體結(jié)構(gòu)圖設(shè)計軟件系統(tǒng)的總體邏輯結(jié)構(gòu)，按照不同的設(shè)計方法，有不同的總體邏輯結(jié)構(gòu)。本指南以結(jié)構(gòu)化設(shè)計方法為主，畫出系統(tǒng)總體結(jié)構(gòu)圖，列出系統(tǒng)的功能模塊清單編號、名稱、功能，并盡可能描繪出功

7、能模塊之間的關(guān)系。若用面向?qū)ο蟮腞OSE工具進(jìn)行分析和設(shè)計，則遵照ROSE的要求進(jìn)行。關(guān)于總體結(jié)構(gòu)圖的說明如下：2.2 運行環(huán)境設(shè)計該軟件系統(tǒng)的運行環(huán)境：1. 硬件平臺：服務(wù)器的最低配置要求工作站的最低配置要求外設(shè)的要求2. 軟件平臺：服務(wù)器操作系統(tǒng) 數(shù)據(jù)庫管理系統(tǒng)中間件客戶端的操作系統(tǒng)客戶端的平臺軟件3. 網(wǎng)絡(luò)平臺通信協(xié)議通信帶寬2.3 子系統(tǒng)清單子系統(tǒng)編號子系統(tǒng)名稱子系統(tǒng)功能簡述子系統(tǒng)之間的關(guān)系SS1SS2SS3SS4SS52.4 功能模塊清單模塊編號模塊名稱模塊功能簡述模塊的接口說明M 1-1M 1-2M 1-3M 2-1M 2-2第三章 模塊（部件）功能分配具有功能獨立、能被調(diào)用的信息

8、單元叫模塊。模塊是結(jié)構(gòu)化設(shè)計中的概念，部件是面向?qū)ο笤O(shè)計的概念。模塊功能分配的目的，就是為了將具有相同功能的模塊合并，從中提取公用模塊，形成公用部件，作為本系統(tǒng)的公用資源，甚至作為公司級組織的公用資源，從而優(yōu)化系統(tǒng)設(shè)計，加快開發(fā)速度，提高開發(fā)質(zhì)量。3.1 專用模塊功能分配模塊編號模塊名稱模塊詳細(xì)功能分配模塊的接口標(biāo)準(zhǔn)M1-1M1-2M1-3M2-1M2-23.2 公用模塊功能分配公用模塊編號公用模塊名稱公用模塊詳細(xì)功能分配模塊的接口標(biāo)準(zhǔn)G-1G-2G-3G-43.3 模塊的關(guān)系適當(dāng)描述模塊之間的關(guān)系和流程。第四章 全局?jǐn)?shù)據(jù)結(jié)構(gòu)設(shè)計數(shù)據(jù)庫設(shè)計的基本原則是“三少”：一個數(shù)據(jù)庫中表的個數(shù)越少越好，一

9、個數(shù)據(jù)庫中主鍵的個數(shù)越少越好，一個表中的字段個數(shù)越少越好。數(shù)據(jù)庫設(shè)計的實用原則是：在數(shù)據(jù)冗余和處理速度之間找到合適的平衡點。4.1 數(shù)據(jù)庫表名清單序號中文表名英文表名表功能說明1234.2 數(shù)據(jù)庫表之間關(guān)系說明可以用E-R圖表示，也可以用文字說明。4.3 數(shù)據(jù)庫表的詳細(xì)清單每個表的詳細(xì)清單內(nèi)容包括：表名、字段中文各、字段英文名或拼音名、字段的類型、寬度、精度、主鍵/外鍵、空否、取值約束（缺省值、最大值、最小值）、索引否。同時要指出該表的索引文件名、索引字段名、索引特性（主鍵索引、唯一索引unique、聚集索引clustered）。4.4 視圖的設(shè)計視圖設(shè)計與授權(quán)有關(guān)，設(shè)計時參照需求分析說明書的

10、用戶授權(quán)范圍。視圖設(shè)計中要給出視圖的中文名、英文名（或拼音名），視圖中的中文列名、英文列名、類型、寬度、精度，每一列的具體算法，對應(yīng)的基表名。4.5 數(shù)據(jù)結(jié)構(gòu)和程序的關(guān)系列出數(shù)據(jù)結(jié)構(gòu)和訪問這些數(shù)據(jù)結(jié)構(gòu)的各個程序之間的關(guān)系。4.6 主要算法設(shè)計4.7 其它數(shù)據(jù)結(jié)構(gòu)設(shè)計此小節(jié)描述系統(tǒng)的其它數(shù)據(jù)結(jié)構(gòu)設(shè)計內(nèi)容。第五章 外部接口設(shè)計5.1 外部接口1設(shè)計接口名稱：接口內(nèi)容：接口設(shè)施：接口的數(shù)據(jù)結(jié)構(gòu)：接口的傳輸頻率（兆/秒）：接口帶寬：接口協(xié)議：5.2 外部接口2設(shè)計接口名稱：接口內(nèi)容：接口設(shè)施：接口的數(shù)據(jù)結(jié)構(gòu)：接口的傳輸頻率（兆/秒）：接口帶寬：接口協(xié)議：第六章 運行設(shè)計在復(fù)雜的應(yīng)用環(huán)境中，任務(wù)可分為各種類型的子任務(wù)，相應(yīng)的處理也應(yīng)進(jìn)行分類。相對于這樣的應(yīng)用，系統(tǒng)的功能十分龐大。用戶在某次使用時，不一定用到所有的功能，也就是說做什么事，用什么功能。這樣有必要定義系統(tǒng)的不同運行。 系統(tǒng)的每種運行可能涉及不同的模塊，使用不同的界面，不同的支持環(huán)境，并有不同的前置條件，以及以不同的控制操作完成一次運行。它們所占的系統(tǒng)資源也不同。定義不同的運行，給出相應(yīng)的運行模塊集合有利于測試和維護(hù)。如果某種功能在一次運行時發(fā)生故障，就能根據(jù)相應(yīng)的模塊集合大致確定故障的可能范圍。6.1 運行模塊組合模塊集