CMMI_工程_概要設計說明書模板_V1.0

1、概要設計說明書模板前 言。第一章導言11目的21. 2范圍213命名規(guī)則214術語定義215相關文檔31. 6參考資料第二章總體結(jié)構(gòu)設計52. 1總體結(jié)構(gòu)圖設計 2. 2運行環(huán)境設計2. 3子系統(tǒng)清單24功能模塊清單6第三章模塊（部件）功能分配 73. 1專用模塊功能分配3. 2公用模塊功能分配 第四章全局數(shù)據(jù)結(jié)構(gòu)設計 74. 1數(shù)據(jù)庫表名清單84. 2數(shù)據(jù)庫表之間關系說明 84. 3數(shù)據(jù)庫表的詳細清單4. 4視圖的設計 4. 5其它數(shù)據(jù)結(jié)構(gòu)設計第五章外部接口設計5. 1外部接口 1設計5. 2外部接口 2設計第八早數(shù)據(jù)結(jié)構(gòu)和算法設計6. 1數(shù)據(jù)結(jié)構(gòu)和程序的關系6. 2主要算法設計第七章運行設

2、計71運行模塊組合72運行控制7. 3運行時間第八章出錯處理設計8. 1出錯輸出信息8. 2出錯處理對策第九章其它設計1110錯誤!未定義書簽。1010101010文檔類別使用對象文檔類別本文檔是軟件系統(tǒng)概要設計說明書的模板，是概要設計說明書的書寫標準及規(guī)范，是 技術文 檔。使用對象該文檔使用人員包括:系統(tǒng)分析人員系統(tǒng)設計人員系統(tǒng)編碼人員系統(tǒng)測試人員系統(tǒng)維護人員第一章導言本章對該文檔的目的、功能范圍、術語、相關文檔、參考資料、版本更新進行說明1.1目的本文檔的目的旨在推動軟件工程的規(guī)范化，使設計人員遵循統(tǒng)一的概要設計書寫規(guī)范，節(jié)省 制作文檔的時間，降低系統(tǒng)實現(xiàn)的風險，做到系統(tǒng)設計資料的規(guī)范性與

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

4、計方法，則總體 邏輯結(jié)構(gòu)為一樹形的功能模塊結(jié)構(gòu)圖。若采用時尚的面向?qū)ο蠡蛎嫦?部件（組件）的設計方法，則總體邏輯結(jié)構(gòu)為部件（組件）的組裝圖。2外部接口本軟件系統(tǒng)與其它軟件系統(tǒng)之間的接口，接口設施可以是中間件。 接口扌田述包括：傳輸方式、帶寬、數(shù)據(jù)結(jié)構(gòu)、傳輸頻率、傳輸量 （兆/秒）、傳輸協(xié)議。3數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)結(jié)構(gòu)包括：關系數(shù)據(jù)庫表的結(jié)構(gòu)、對象數(shù)據(jù)庫表的結(jié)構(gòu)、變量說 明。4概念數(shù)據(jù)模 型關系數(shù)據(jù)庫的邏輯設計模型，叫概念數(shù)據(jù)模型。主要內(nèi)容包括一張邏 輯E-R圖及其相應的數(shù)據(jù)字典。5物理數(shù)據(jù)模 型關系數(shù)據(jù)庫的物理設計模型，叫物理數(shù)據(jù)模型。主要內(nèi)容包括一張物 理表關系圖及其相應的數(shù)據(jù)字典。6視圖在基表之上

5、建立的張?zhí)摫?，叫視圖，匕具有物理表的許多性質(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)化設計中的 概念。10部件（組 件）具有功能獨立、能被調(diào)用的、且已包裝的信息單元叫部件（組件）部 件是面向?qū)ο笤O計中的概念。11內(nèi)部接口軟件系統(tǒng)內(nèi)部各子系統(tǒng)之間、各部件之間、各模板之間的接口，叫內(nèi) 部接口。接口描述包括：調(diào)用方式、入口信息、出口信息 等。12相關文件相關文件是指：當本文件內(nèi)容變更后，可能引起變更的

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

7、 2運行環(huán)境設計該軟件系統(tǒng)的運行環(huán)境:1. 硬件平臺:服務器的最低配置要求工作站的最低配置要求 外設的要求2. 軟件平臺：服務器操作系統(tǒng)數(shù)據(jù)庫管理系統(tǒng)中間件客八端的操作系統(tǒng)客八端的平臺軟件3. 網(wǎng)絡平臺通信協(xié)議通信帶寬2. 3子系統(tǒng)清單子系統(tǒng)編號子系統(tǒng)名稱子系統(tǒng)功能簡述子系統(tǒng)之間的關系SS1SS2SS3SS4SS52. 4功能模塊清單模塊編號模塊名稱模塊功能簡述模塊的接口說明M 1-1M 1-2M 1-3M 2-1M 2-2第三章模塊（部件）功能分配具有功能獨立、能被調(diào)用的信息單元叫模塊。模塊是結(jié)構(gòu)化設計中的概念，部件是面向?qū)ο笤O計 的概念。模塊功能分配的目的，就是為了將具有相同功能的模塊合并

8、，從中提取公用模塊，形成公用部 件，作為本系統(tǒng)的公用資源，甚至作為公司級組織的公用資源，從而優(yōu)化系統(tǒng)設計，加快開發(fā)速度， 提高開發(fā)質(zhì)量。3. 1專用模塊功能分配模塊編號模塊名稱模塊詳細功能分配模塊的接口標準M1-1M1-2M1-3M2-1M2-232公用模塊功能分配公用模塊編號公用模塊名稱公用模塊詳細功能分配模塊的接口標準G-1G-2G-3G-43. 3模塊的關系適當描述模塊之間的關系和流程第四章全局數(shù)據(jù)結(jié)構(gòu)設計數(shù)據(jù)庫設計的基本原則是“三少”:一個數(shù)據(jù)庫中表的個數(shù)越少越好，一個數(shù)據(jù)庫中主鍵的個數(shù) 越少越好，一個表中的字段個數(shù)越少越好。數(shù)據(jù)庫設計的實用原則是：在數(shù)據(jù)冗余和處理速度之間找 到合適的

9、平衡點。41數(shù)據(jù)庫表名清單序號中文表名英文表名表功能說明1234. 2數(shù)據(jù)庫表之間關系說明可以用ER圖表示，也可以用文字說明。43數(shù)據(jù)庫表的詳細清單每個表的詳細清單內(nèi)容包括：表名、字段中文各、字段英文名或拼音名、字段的類型、寬度、精度、 主鍵/外鍵、空否、取值約束（缺省值、最大值、最小值）、索引否。同時要指出該表的索引文件名、索 引字段名、索引特性（主鍵索引、唯一索引unique、聚集索弓 I clustered ）。44視圖的設計視圖設計與授權(quán)有關，設計時參照需求分析說明書的用戶授權(quán)范圍。視圖設計中要給出視圖的中 文名、英文名（或拼音名），視圖中的中文列名、英文列名、類型、寬度、精度，每一列

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