系統概要設計說明書系統概要設計說明書項目名稱：項目名稱：第16屆亞運會組委會信息技術部第16屆亞運會組委會信息技術部****年**月文檔控制頁版本記錄版本號版本描述責任人修訂日期V0.1草稿2008-12-0……V0.42008-12-6……V1.02008-12-10本文件由第16屆亞運會組委會編寫，并享有版權。任何人或組織不得違反「版權法」，在未經同意的情況下，以任何形式（包括但不限于電子版、印刷版、微縮版、復印、錄制等）復制本文件、將其儲存于可讀取的系統或發送出去。本文件中出現的產品或公司名稱是其各自擁有者的商標或注冊商標。非第16屆亞運會組委會讀者請注意：本文件的內容不得有任何更改。要保證本文件內容的準確性。否則第16屆亞運會組委會對后果不負責任。目錄第一章 引言 11.1 目的 11.2 背景 11.3 術語定義 21.4 參考資料 2第二章 系統環境 32.1 運行環境 32.1.1 系統支撐環境 32.1.2 部署圖 42.1.3 系統接口 42.1.4 系統安全控制 42.2 運行模塊組合 42.3 運行環境的配置 42.4 條件與限制 5第三章 系統總體結構設計 63.1 系統結構設計描述 63.2 總體結構圖 73.3 功能需求與程序的關系 73.4 子系統清單 8第四章 模塊功能分配 94.1 系統劃分及功能描述 94.2 專用模塊功能概述 94.3 公用模塊功能概述 104.3.1 版本控制管理 104.3.2 幫助模塊 10第五章 數據庫設計 115.1 邏輯視圖 125.2 數據庫表關系圖 125.3 數據表清單 125.4 主要算法設計 135.5 其它數據結構設計 13第六章 接口設計 146.1 用戶接口 146.2 內部接口 146.3 外部系統接口 14第七章 安全保密設計 167.1 用戶管理和權限控制 16第七章 維護及出錯處理設計 177.1 系統維護設計 177.2 出錯信息 177.3 出錯處理 177.4 系統故障預防與恢復 177.5 數據備份與恢復 18第八章 設計約束 198.1 字節集編碼約束 198.2 操作系統約束 198.3 其他約束 19第九章 附件 20評審意見 21引言目的提示：簡要說明編寫這份概要設計說明書的目的，指出預期的讀者。概要設計說明書的編寫目的是為了說明系統總體設計的技術方案，從程序系統的設計考慮，包括系統的基本處理流程、模塊劃分、功能分配、接口設計、運行設計、數據結構設計和出錯處理設計等內容，以向整個設計期提供關于程序系統的邏輯和數據功能實現方式的總體描述，從而作為程序詳細設計或編碼的基礎。設計階段將以本文檔為核心文檔。應包括一下幾個方面：將系統需求轉換為未來系統的設計逐步功能需求逐步分解為模塊和庫，開發強壯的系統構架使設計適合于實施環境，為提高性能而進行設計概要設計說明書的適用讀者為：系統開發者、測試人員、工程監理等背景1.說明待開發的軟件系統的名稱2.列出本項目的任務委托單位、開發單位、協作單位、用戶單位3.說明項目背景，敘述該項軟件開發的意圖、應用目標、作用范圍以及其他應向讀者說明的有關該軟件開發的背景材料。如果本次開發的軟件系統是一個更大的系統的一個組成部分，則要說明該更大系統的組成和介紹本系統與其它相關系統的關系和接口部分4.保密說明：本項為可選項，一般的軟件公司都會要求對軟件開發的概要設計文檔進行保密，不允許被復制、使用和擴散到公司之外的范圍，如果需要強調則允許做相關的保密說明5.版權說明：本項為可選項，若有必要，才要作有關的描述。術語定義提示：對文檔中的專業術語進行解釋說明序號術語名稱術語定義123系統環境運行環境系統支撐環境部署圖提示：應清晰明確的給出用戶和系統各功能以及系統物理結構和連接關系圖。應當符合UML建模規則。系統接口提示：系統、模塊內部和系統、模塊之間的接口規范。圖、表方式描述個功能模塊間的接口定義、物理特性、軟硬件特性等。系統安全控制提示：應設定系統安全保密體系和控制關系。運行模塊組合提示：為可選項，說明對系統施加不同的外界運行控制時所引起的各種不同的運行模塊組合，說明每種運行所歷經的內部模塊和支持軟件?？梢杂脠D、表方式表現描述。運行環境的配置提示：說明本系統應當在什么樣的環境下運行，有什么強制要求和建議？類別標準配置最低配置備注計算機硬件計算機軟件網絡通信其它條件與限制提示：為可選項，只要當軟件系統的設計或開發受到某種特定的限制，或者可能直接能影響系統設計的某種因素，這些因素可能成為系統的設計約束，他們的改變可能會影響某些需求的實現時，才需要做概要介紹。若存在以下方面的系統約束或條件限制時，可以進行相關的闡明：（但不限于這些）為完成本軟件系統應具備的特定條件、開發單位已具備的條件以及尚需創造的條件,如：現階段還未到位的設備、資源等需要做出相應的約束說明。必要時，還應說明用戶及分合同承包者承擔的工作、完成期限及其他條件與限制，如果用戶及分合同承包者對系統的實現起到的某些作用會直接影響系統設計的成敗則要特別說明。本系統的設計規范需要受到某些特定的行業規范的限制。本系統的開發需要受到用戶對系統的工程化管理的某些特別的要求，包括用戶規定對系統實現的全過程的變更規定。本系統設計工作所需的一些假定條件和必須滿足的約束，如本功能的開發假定用戶會熟練使用SQL語言，本功能的實現應該在某功能實現前開發完成等。本系統的設計可能需要使用的所有購入構件、所有適用的許可或使用限制，以及所有相關的兼容性及互操作性或接口標準的有關限制和規定。參考資料列出所本文檔所使用的參考資料，包括：1本軟件開發所經核準的合同或標書或可行性報告等文檔2軟件開發計劃書3需求分析報告4測試方案（若存在初稿的話）5與本項目有關的已發表的文件或資料6本文件中各處引用的文件、資料，所采用的軟件開發標準和規范注意：必須列出文件、資料的作者、標題、編號、發表日期和出版單位，以說明這些文件資料的來源。若某些文檔有保密要求的，則要說明其保密級別。序號文檔名稱作者版本/日期123系統總體結構設計系統結構設計描述結構設計是指定義軟件系統各主要部件之間的關系。總體結構設計就是將系統按照功能邏輯劃分成多個子系統，各子系統再細劃分第二層次結構——模塊?？傮w設計要遵循“開閉原則（Open-ClosedPrinciple）”——一個軟件實體應當對擴展開放，對修改關閉。具體來說，“開”就是擴展性要好，后面增加功能應該不需要修改到原來的結構或代碼；“閉”就是與其它模塊的調用通過封裝成接口進行?？傮w設計的基本步驟如下：用選定的設計工具、計劃中設定的交付方式（如小版本漸進交付）及團隊已經掌握的設計方法，結合一些適當的設計原則（如功能模塊化等），將系統分解為若干子系統，明確子系統中包含的功能模塊。確定子系統、功能模塊間的約束、假設和依賴（如系統運行環境和開發、測試環境等，并考慮系統并發性和分布性要求）。子系統之間的依賴關系在設計時盡量以接口的方式進行交互。結合以上內容，對系統的模塊邏輯實現和集成方法進行設計，降低使軟件難于實現、測試（必要時測試人員參與討論）、維護的因素，形成高內聚、低耦合的系統體系結構；通過以上對系統的模塊或子系統的設計、劃分之后，形成系統總體結構圖?！揪帉憣嵗齾⒁娙缦拢骸肯到y設計主要是基于MVC設計模式，M代表模型Model，V代表視圖View，C代表控制器Controller。MVC模式將系統分為三層，層與層之間通過又一定的模式聯系，使數據實體與業務邏輯、業務邏輯與頁面展現分離。MVC設計模式主要由三部分組成。模型M是應用對象，沒有用戶界面。視圖V表示它在屏幕上的顯示，代表流向用戶的數據?？刂破鰿定義用戶界面對用戶輸入的響應方式，負責把用戶的動作轉成針對Model的操作。Model通過更新View的數據來反映數據的變化。采用MVC模式的目的是增加代碼的重用率，減少數據表達，數據描述和應用操作的耦合度。同時也使得軟件可維護性，可修復性，可擴展性，靈活性以及封裝性大大提高，以滿足系統設計原則。關系如圖：

圖STYLEREF1\s三-SEQ圖\*ARABIC\s11模型關系圖總體結構圖提示：用模塊圖表達出系統的總結組成，結構，力求能夠表達出從最高點看出系統的組成模塊或子系統的分布與關系，力求簡單、準確。該圖的模塊或子系統的劃分應該能夠映射到最終實現的代碼的工程項目或組件上。需求與系統模塊的關系提示：對應需求說明書中描述各功能模塊和系統模塊對應功能描述。功能需求系統模塊功能簡述模塊間的關系*包括功能性需求與非功能性需求子系統清單如果本系統劃分了子系統，應該列出所有子系統來，按以下內容列出，子系統之間的劃分應該有一定的原則，如按業務功能、按部署環境等，要統一一種原則。編號子系統名稱功能簡述子系統之間的關系SS1SS2SS3模塊功能分配具有功能獨立、能被調用的信息單元叫模塊。模塊功能分配，分為公用模塊和專用模塊。公用模塊：將具有相同功能的模塊合并，從中提取公用模塊，形成公用部件，作為本系統的公用資源，甚至作為總體的公用資源，從而優化系統設計，加快開發速度，提高開發質量。專用模塊：專門用于實現用戶特定需要或要求的模塊，專用模塊之間共性很低。應該在系統概要設計階段就充分考慮模塊的重構與劃分設計。系統劃分及功能描述提示：說明本系統的系統元素（即各層模塊、子程序、公用程序等）的劃分，扼要說明每個系統元素的標識符和功能說明，分層次地給出各元素之間的控制與被控制的關系。系統劃分允許采用各種形式（如：系統功能模塊列表等）進行描述，建議用系統模塊結構圖表示，再附上簡單的文字說明，以說明模塊的層次結構以及相應的接口控制關系，有必要時需要介紹模塊之間的調用關系，要求相應的功能模塊最好要有一定的模塊編號進行標識。專用模塊功能概述提示：從本節開始描述各個功能模塊的處理流程，建議每一個功能模塊為單獨一節，標題可以根據模塊結構圖中的模塊劃分情況自行決定。描述系統中各個功能模塊相應功能的全部細節，要求對每一個模塊的設計都可以被實現，并能夠被驗證的，主要就是描述每一個模塊的輸入、輸出和處理流程，必要時，可以借助業務流程圖來描述。建議采用活動圖形式來描述模塊內部和模塊間的業務流程。公用模塊功能概述提示：公共模塊的部分與專用模塊的描述形式相同，但這部分功能一般是多個模塊都可以調用的，因此將其單獨提出來進行描述，可以對系統進行更好的功能模塊劃分。建議也是采用業務流程圖描述。版本控制管理提示：可選項，大中型系統設計模塊眾多，系統派生出來的個性化的半定制軟件的升級需求，此時需要事先考慮有關軟件產品升級班本的控制辦法以及版本號的升級原則。幫助模塊功能：填寫該模塊實現的功能。界面：可用Visio畫界面。如果有原型可以統一在前面說明，不必每個模塊填寫。輸入：填寫模塊輸入信息。（無輸入可以省略）輸出：填寫模塊輸出信息。（無輸出可以省略）處理邏輯：填寫模塊業務處理流程，必要時使用流程圖數據結構：該模塊所涉及的數據結構，一般會列出業務處理所涉及到的庫表清單備注：數據庫設計要點數據庫設計(DatabaseDesign)是指對于一個給定的應用環境，構造最優的數據庫模式，建立數據庫及其應用系統，使之能夠有效地存儲數據，滿足各種用戶的應用需求（信息要求和處理要求）。數據庫是信息系統的核心和基礎，把信息系統中大量的數據按一定的模型組織起來，提供存儲、維護、檢索數據的功能，使信息系統可以方便、及時、準確地從數據庫中獲得所需的信息。數據庫設計包括總體的數據庫規劃，各數據表的定義，字段（屬性）定義，數據約束，表與表之前關系，主要數據算法的設計等內容。確定項目數據庫設計規則以便于系統統一，其中包括：庫命名，邏輯設計，物理設計，安全性設計及優化，管理規則等。本節要說明了數據庫設計的E-R圖；數據庫邏輯視圖；數據庫主要業務對象的表、屬性（字段）以及關鍵外鍵。數據庫設計一般要經過“邏輯設計→物理設計→安全性設計→優化”等步驟，通常要迭代進行，包括：1. 邏輯設計分析軟件系統模塊及其之間的數據操作，使用抽象數據類型設計，轉換數據對象的屬性及其關聯、接口等內容，設計并完善數據字典及其約束條件，實現數據的變量封裝結構設計。面向結構設計方法中為創建與數據庫相關的數據流圖或實體關系圖；若采用面向對象方法，則分析類信息傳遞內容，并創建類圖；2. 物理設計設計表結構，與實體關系圖或類圖相結合；對表結構進行規范化處理；3. 安全性設計考慮數據庫的登陸訪問限制，用戶密碼加密，操作訪問權限等系統安全設計；4. 優化 分析并優化數據庫的“時—空”（即性能，容量等）效率，盡可能“提高處理速度”并且“降低數據占用空間”； 分析“時—空”效率的瓶頸，找出優化對象（目標），并確定優先級； 消除對象（目標）間的對抗性，必要時給出折中方案； 給出優化的具體措施，如逐步評估、優化數據庫環境參數，對表格進行反規范化處理等，堅持信息隱蔽等原則，加強數據設計可維護性。如果利用了某些工具（如PowerDesigner）能夠自動生成一些物理文件，這里可以寫明引用關系，而不需按照以下章節的表格來說明。可以在對應章節中說明引用的物理文件。如果設計的系統比較龐大（篇幅內容可能超過20頁以上），可以將本章內容單獨設立一個《數據庫設計》文檔，方便參考建議使用PowerDesigner編寫數據設計。邏輯視圖提示：用UML語言表達出數據庫各對象的邏輯關系圖，可以通過RationalRose生成各個模塊的類圖來進行描述。數據庫表關系圖提示：將業務對象的邏輯視圖轉換成可以通過數據庫進行實施的物理視圖，一般用E--R圖表示，也可以用其它能夠表達的方式表達，例如表格。數據表清單對（全局）數據結構進行具體設計，以確定具體的數據項及其數據屬性，如：數據類型、長度及各種數據的約束條件等等，包括各種常量所用到的代碼或常數信息，并詳細描述各種代碼的編碼規則，以及有效值中只有有限的幾個，則需要一一羅列，如果存在數據庫，則要詳細說明數據庫的表劃分以及各個字段的數據結構說明，必要時允許借助有關數據庫設計CASE工具描述ER圖模型的方式進行說明，也允許通過CASE工具自身的模板格式轉成DOC文檔后加入本章節內容，還可以用CASE工具產生的文檔做為附件進行保存。本章內容可以按照接口用數據結構和系統內部數據結構進行分節，也可以根據具體的數據庫庫表結構進行分節，標題根據設計需要自行確定。關于數據結構的設計建議參照以下編寫格式：當前庫：XXXXXXXXX備份庫：XXXXXXXXX歷史庫:XXXXXXXXX下面是庫表的總體列表，用來簡述各個庫表的具體功能序號中文表名英文表名表功能說明123最后是對庫表字段的描述表名：（這里直接用英文表名描述即可）字段名稱類型長度字段說明索引主鍵外鍵默認值取值范圍主要算法設計提示：列出一些主要或關鍵的算圖的思路，可以用文字表達，也可以使用偽碼表達。其它數據結構設計提示：可以補充有關數據庫設計本節以上所列之外的內容。接口設計提示：接口設計是指系統內部，系統和操作系統間、多個系統間以及系統和人之間如何通信。與在需求階段與客戶交流有關現存系統的運行情況以及獲取數據的需求，得到系統外部接口；在概要設計階段，通過子系統劃分、模塊劃分中抽象、歸納出各子系統的接口、模塊之間通訊的重要接口，加以定義形成設計文檔的中接口設計。接口設計時要考慮擴展子系統或功能模塊及其之間的關系和限制條件，實施系統所需的接口設計。結合系統錯誤處理和數據驗證方法，驗證接口設計結果，并逆向需求求證接口正確性。接口設計為可選項，若存在有關的接口則是必選項，否則容易產生開發者對系統設計的二義性時需要詳細描述。本章若存在N個接口，則可分為N節來描述。用戶接口提示：確認用戶界面、人機操作之間的接口。設備上的按鈕、系統中的界面元器件圖的功用等等。內部接口提示：模塊內部的接口協議，數據交換以及其能力支持。外部系統接口提示：描述內容包括如下：接口名稱：方法：內容簡介：輸入參數：返回結果：接口調用要求：安全保密設計提示：包括了系統故障預防與恢復，系統使用安全，例如用戶權限等方面的考慮。如果項目系統對于系統安全保密性要求較高的情況下，必須在設計時，充分考慮這一部分內容，包括故障發生如何預防或處理。如何管理用戶的合法登錄或權限等。本節為可選項，如果系統設計對安全保密性有特別的要求，則需要詳細描述，主要可以從以下幾方面進行考慮：系統故障預防與恢復、用戶管理和權限控制、數據備份和恢復等用戶管理和權限控制提示：說明在數據庫的設計中，將如何通過區分不同的訪問者、不同的訪問類型和不同的數據對象，進行分配權限并分別對待而獲得的數據庫安全保密的設計考慮。維護及出錯處理設計提示：應羅列系統維護的方便而在程序內部設計中作出的安排。系統可能的出錯或故障情況出現的各種出錯處理信息，包括系統出錯信息提示的形式（包括出錯對話框的設計）、含義及處理方法等。在操作出錯或數據出錯等情況下，系統顯示或記錄的有關出錯代碼／信息系統運行出錯時，提示語言要友好，并以用戶習慣為基礎，使用戶能夠理解發生的問題，并能夠根據提示采取正確的操作方式。系統維護設計提示：圖、表方式描述在設計過程中考慮到的系統交付運行后可能的維護特性和方式方法等。包括在程序中專門安排用于系統的檢查與維護的檢測點和專