CMMI_工程_概要設(shè)計(jì)說明書模板_V1.0

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

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

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

4、結(jié)構(gòu)。若采用傳統(tǒng)的面向功能或面向數(shù)據(jù)的結(jié)構(gòu)化設(shè)計(jì)方法，則總體邏輯結(jié)構(gòu)為一樹形的功能模塊結(jié)構(gòu)圖。若采用時(shí)尚的面向?qū)ο蠡蛎嫦虿考ńM件）的設(shè)計(jì)方法，則總體邏輯結(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è)計(jì)模型，叫概念數(shù)據(jù)模型。主要容包括一模型邏輯 E-R 圖及其相應(yīng)的數(shù)據(jù)字典。5物理數(shù)據(jù)關(guān)系數(shù)據(jù)庫的物理設(shè)計(jì)模型，叫物理數(shù)據(jù)模型。主要容包括一模型物理表關(guān)系圖及其相

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

6、，可能引起變更的其它文件。如需求分析報(bào)告、詳細(xì)設(shè)計(jì)說明書、測試計(jì)劃、用戶手冊。13 參考資料參考資料是指：本文件書寫時(shí)用到的其它資料。 如各種有關(guān)規(guī)、模板、標(biāo)準(zhǔn)、準(zhǔn)則。1.5 相關(guān)文檔詳細(xì)設(shè)計(jì)說明書源程序清單測試計(jì)劃及報(bào)告用戶使用手冊1.6 參考資料用戶需求分析報(bào)告軟件開發(fā)合同.數(shù)據(jù)庫設(shè)計(jì)規(guī)命名規(guī).第二章總體結(jié)構(gòu)設(shè)計(jì)2.1 總體結(jié)構(gòu)圖設(shè)計(jì)軟件系統(tǒng)的總體邏輯結(jié)構(gòu)，按照不同的設(shè)計(jì)方法，有不同的總體邏輯結(jié)構(gòu)。本指南以結(jié)構(gòu)化設(shè)計(jì)方法為主， 畫出系統(tǒng)總體結(jié)構(gòu)圖， 列出系統(tǒng)的功能模塊清單編號、名稱、功能，并盡可能描繪出功能模塊之間的關(guān)系。若用面向?qū)ο蟮腞OSE工具進(jìn)行分析和設(shè)計(jì)，則遵照 ROSE的要求進(jìn)行

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

8、用的信息單元叫模塊。模塊是結(jié)構(gòu)化設(shè)計(jì)中的概念，部件是面向?qū)ο笤O(shè)計(jì)的概念。模塊功能分配的目的，就是為了將具有相同功能的模塊合并，從中提取公用模塊，形成公用部件，作為本系統(tǒng)的公用資源，甚至作為公司級組織的公用資源，從而優(yōu)化系統(tǒng)設(shè)計(jì)，加快開發(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è)計(jì).數(shù)據(jù)庫設(shè)計(jì)的基本原則是“三少”：一個(gè)數(shù)據(jù)庫中表的個(gè)數(shù)越少

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

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