e r 檔目的 簡要說明編寫這份概要設計說明書的目的，指出預期的讀者。 本概要設計說明書的編寫目的是為了說明系統總體設計的技術方案，從程序系統的設計考慮，包括系統的基本處理流程、模塊劃分、功能分配、接口設計、運行設計、數據結構設計和出錯處理設計等內容，以向整個設計期提供關于程序系統的邏輯和數據功能實現方式的總體描述，從而作為程序詳細設計或編碼的基礎。設計階段將以本文檔為核心文檔。 本概要設計說明書的適用讀者為：軟件開發者、測試人員。 目概述 發單位、協作單位、用戶單位 述該項軟件開發的意圖、應用目標、作用范圍以及其他應向讀者說明的有關該軟件開發的背景材料。如果本次開發的軟件系統是一個更大的系統的一個組成部分，則要說明該更大系統的組成和介紹本系統與其它相關系統的關系和接口部分 本項為可選項，一般的軟件公司都會要求對軟件開發的概要設計文檔進行保密，不允許被復制、使用和擴散到公司之外的范圍，如果需要強調則允許做相關的保密說明 本項為可選項， 若有必要，才要作有關的描述。 考資料 列出編寫本報告時參考的文件 (如經核準的計劃任務書或合同、上級機關的批文等 )、資料、技術標準，以及他們的作者、標題、編號、發布日期和出版單位。這些文件主要包括： 本軟件開發所經核準的合同或標書或可行性報告等文檔 軟件開發計劃書 需求分析報告 統 要設計說明書 共 19 頁 第 2頁 測試方案（若存在初稿的話） 與本項目有關的已發表的文件或資料 本文件中各處引用的文件、資料，所采用的軟件開發標準和規范 編號 資料名稱 簡介 作者 日期 出版單位 列出編寫本報告時查閱的 雜志、專業著作、技術標準以及他們的網址。 網 站 簡 介 語定義 列出本文檔中所引用到的專門術語的定義和首字母縮寫詞、縮略語的原文，以便對概要設計說明書進行適當的解釋 改記錄 編號 修改內容描述 修改人 審核人 批準人 修改日期 備注 統 要設計說明書 共 19 頁 第 3頁 2. 系統概述 概要地介紹本軟件系統，只要求提供影響設計的一般因素，不必太詳細地描述大量細節，本章主要目的僅僅是使本設計說明書更加易于理解，建議根據系統設計的實際需要可以有選擇地從以下方面進行概要描述：系統實現目標、條件與限制、運行環境、需求概述 統實現目標 說明完成本項目要達到的目標，可從以下幾方面考慮設計： 人力與設備費用的節省； 處理速度的提高； 控制精度或生產能力的提高； 管理信息服務的改進； 決策系統的改進； 人員工作效率的提高； 安全可靠性的保證； 件與限制 為可選項，只要當軟件系統的設計或開發受到某種特定 的限制，或者可直接能影響系統設計的某種因素，這些因素可能成為系統的設計約束，他們的改變可能會影響某些需求的實現時，才需要做概要介紹。 若存在以下方面的系統約束或條件限制時，可以進行相關的闡明：（但不限于這些） 1. 為完成本軟件系統應具備的特定條件、開發單位已具備的條件以及尚需創造的條件 ,如：現階段還未到位的設備、資源等需要做出相應的約束說明 2. 必要時，還應說明用戶及分合同承包者承擔的工作、完成期限及其他條件與限制，如果用戶及分合同承包者對系統的實現起到的某些作用會直接影響系統設計的成敗則要特別說明 3. 本系統的設計規范需要受到某些特定的行業規范的限制 4. 本系統的開發需要受到用戶對系統的工程化管理的某些特別的要求，包括用戶規定對系統實現的全過程的變更規定 5. 本系統設計工作所需的一些假定條件和必須滿足的約束，如本功能的開發假定用戶會熟練使用 言，本功能的實現應該在某功能實現前開發完成等 6. 本系統的設計可能需要使用的所有購入構件、所有適用的許可或使用限制，統 要設計說明書 共 19 頁 第 4頁 以及所有相關的兼容性及互操作性或接口標準的有關限制和規定 行環境 概要地說明本軟件系統的運行環境的拓樸結構和布局，分別說明前、后臺及網關或中間件的運行環境 , 應包括通訊條件、網絡環境、硬件配置、軟件系統等 其中硬件環境：要求列出為運行本軟件所要求的硬件最小配置： 處理器的型號、內存容量 所要求的硬盤空間、分區格式、相關的記錄格式、設備的型號和數量、聯機 /脫機等 I/O 設備（聯機 /脫機） 網絡相關設備（型號、數量） 支持軟件：說明為運行本軟件所需要的支持軟件，如： 操作系統名稱、對應的版本號、相關的 編譯器和對應的版本號 數據庫管理系統和對應版本號 其他支持軟件 這里只要求概要的說明一下，以便幫助理解本概 要設計說明書，可參考以下格式： 【前臺】 計算機： C 兼容機。 操作系統： 7/98/2000/作系統 數據庫系統： 據庫系統（客戶端） 應用軟件： 戶端） 網絡： P 【后臺】 計算機： S/6000 操作系統： 作系統 數據庫系統： 據庫系統（服務端） 應用軟件： 務端） 網絡： P 3. 需求概述 根據系統設計的實際需要，簡要介紹系統的需求情況，不必詳細描述需求的具體細節，只僅僅要求能夠更好幫助理解本設計說明書的內容，建議有選擇地從功能需求、性能需求和運行需求進行分別描述，對于直接影響系統設計的關鍵或統 要設計說明書 共 19 頁 第 5頁 主要功能、性能以及運行要求等方面進行概要介紹，如果性能和運行需求方面對設計影響不大，則允許不必說明 總體描述 對系統的整體需求進行概述 系統角色 描述系統的用戶，權限等 寫 名稱 描述 英語簡稱 系統功能 功能劃分 對系統進行功能劃分 用例清單 根據劃分，列出各個功能模塊 功能 能名稱 系統角色使用權限 描 述 列出所有系統角色，并用 表示具有相應權限 性能和運行需求 4. 總體設計 計原則 介紹本系統的結構設計原則和總體設計指導思想，主要從系統設計實現的目統 要設計說明書 共 19 頁 第 6頁 標來考慮，比如：處理速度、安全保密性、可擴展性等方面進行闡述，可以使用一些套話稍做修改即可。建議參考以下范例進行描述： 數據實時性強 監控的實時性是不言而喻的。無論實時檢測還是動態顯示交易匯總數據和盤中異常結果，都要求實時監控的算法盡量優化，處理簡潔，這樣才能真正達到實時監控的目的，為總部進行盤中稽核和及時處理異常情況提供有效的手段。 可擴充性強 由于交易業務是不斷擴展的，監控的指標及功能都是不斷擴大或變化的，故系統必須具有良好的可擴充性。系統設計應盡可能結構化、模塊化，并與其他子系統預留相應的接口。 可維護性好 由于證券市場、政策及其管理是隨著整個國民經濟的發展而變化的，要求對交易業務的實時監控具有相當的靈活性，以便于維護。 先進性 系 統采用國際流行的 放式框架，主要軟硬件設備符合國際標準，集成了國際水平的主流生產廠的先進產品，應用軟件采用 B/S 結構。 數據完整性、安全性高 財務系統數據的完整性和安全性是非常重要的。一個安全的客戶 /服務器系統應該是客戶端機器的任何操作都通過服務器來實現其一致性和完整性控制。數據庫及財務稽核系統本身都應提供分級授權、日志記錄等手段來確保系統的安全。 計規范 說明可以引用公司現有的各種設計規范或各種軟件開發的國家標準或規范，主要包括：（不限于以下幾種，也不指定） 命名約定 規定系統和子系統名 , 程序名 , 數據庫表 (文件 )名 , 數據名 , 變量名等的編制規范。 界面約定 規定屏幕界面的總體布局，如菜單行、顯示主體、圖標按鈕、提示信息、出錯信息等規范化，統一風格。 程序編寫規范 根據采用的編程工具特點，制定規范化要求，使程序易讀易懂，可維護，可移植。 具體選用的規范，只要對設計有所幫助就可以羅列，編號及相關規范標題可以自行決定。 對于引用公司事先制訂的有關規范或現存的各種國家標準等規范，則可以簡單地描述，并參見 范或標準，文件可以作為本概要設計說明書的附件進行保存 統 要設計說明書 共 19 頁 第 7頁 如果一個系統比 較大需要拆分成若干個子系統，而每個子系統需要各自編制概要設計文檔，則只需要在一個總的概要設計說明書進行描述，其他子系統允許不專門進行描述，或注明參見 要設計說明書。 件體系結構 簡要介紹系統的總體結構和概要功能，可以通過畫系統設計總體框架結構圖的方式，再附上簡單的文字說明 ,對本軟件系統的總體功能進行概要描述。對于采用 臺的系統，參考如下： 系統的體系架構是一個系統的骨架，其重要性對一個系統的建設能否成功至關重要。建立一個合適的體系架構關系到系統的業務需求；關系到系統的運行模式；關系到系統的性能需求，如安全性、可擴展性等。 在本系統中，我們將遵循 范進行設計和開發。 系結構由 定義了如何開發、配置及實現一個企業應用，提供了對 及 術的全面支持。 供了一個企業級的計算模型和運行環境，用于開發和部署多層體系結構的應用。它通過提供企業計算環境所必須的各種服務，使得部署在 臺上的多層應用可以實現高可用性、安全性、可擴展性和可靠性。 上圖中是一個典型的分布式多層應用的模型，它將整個應用按照功能劃分為表示層、商業邏輯層和數據層三個部分。各個層次在邏輯上相互獨立。 表示層是應用的用戶接口部分，它擔負著用戶與應用間的對話功能。它可用于檢查用戶從鍵盤等輸入的數據，顯示系統處理后輸出的數據。 在變更用戶接口時，只需要改寫顯示控制和數據檢查程序，而并不會因此影響其他層的功能。而數據檢查的功能也只是限于數據的形式和實際取值范圍，不包括有關業務本身的處理邏輯。另外圖形界面的結構也是不固定的，這便于以后統 要設計說明書 共 19 頁 第 8頁 可靈活變更。例如：可以在一個窗口中不是放入幾個功能，而是按照功能分割窗口，以便每個窗口的功能簡潔。 在原有 C/業邏輯層實際是整個應用的本體，它負責整個系統的業務處理邏輯。表示層和商業邏輯層間的數據交換盡量簡潔，避免“一次業務處理，表示層和商業邏輯層間有多次數據交換。” 數據層實際是 負責管理對數據庫 的訪問和控制數據庫數據的讀寫。數據層應能夠迅速執行大量數據的更新和檢索操作。 本系統采用了先進的 B/S 架構，提供分布式應用解決方案。系統是以完全基于 準的電子商務平臺技術為基礎創建的純 大型電子商務交易系統，其充分發揮了 證了系統良好的可擴展性，為實現向綜合交易平臺的過渡打下基礎。在確保查詢正確的前提下，系統還采用了數字證書技術提供可靠的加密 /解密、數字簽名等手段，以保證系統中數據傳輸的安全性。系統體系結構如下： 5. 模塊結構設計 件模塊總體設計 主要對整個系統中公共組件模塊進行描述。 組件模塊的劃分和功能描述 說明本系統的系組件模塊的劃分，扼要說明每個組件模塊的標識符和功能說B E IE SP 統 要設計說明書 共 19 頁 第 9頁 明 模塊 塊 描 述 1. 組件模塊關系 主要描述組件模塊和組件模塊之間的調用關系。如下圖中 組件模塊的物理分布 通過物理分布圖描述組件模塊在物理環境中的分布。示例如下： E n cr y p t / D e cr y p t n cr y p t / D e cr y p t A e r t M a n a g e m e n A A r r o r H a n d l i n gg l o b a lI n f o P a r si n gO n l i n e U se r M a n a g e m e n tC o m m o n C o n n e I n t e r f a p p li ca t i o n sD e sk t o p n c r y p t / D e c r y p t N TC e r t M a n a g e m e n b S e r v e rA p p l i c a t i o n sC o m m o n C o n n e c t I n t e r f a c A c c e s sE n c r y p t / D e c r y p t A I A c c e s sE r r o r H a n d l i n gO n l i n e U s e r M a n a g e m e n tI n f o P a r s i n F r o n t M a ch i n ND e sk t o p n c r y p t / D e c r y p t N TC e r t M a n a g e m e n 統 要設計說明書 共 19 頁 第 10頁 組件模塊與用例映射 列出實現用例時需要用到哪些組件模塊，用 表示在實現某個用例時需要調用某個組件模塊 D 件 模塊 1 組件 模塊 2 組件 模塊 3 組件 模塊 4 組件 模塊 5 。 用例名 件模塊描述 描述系統中各個組件模塊相應功能的全部細節，要求對每一個模塊的設計都可以被實現，并能夠被驗證的，主要就是描述每一個組件模塊的輸入、輸出和處理流程，必要時，可以借助數據流圖來描述。 組件模塊 1 1. 組件模塊概述 功能說明 對模塊功能進行總體描述，著重描述該模塊的調用者，以及調用者通過該模塊完成什么樣的功能，及描述“做什么” . 前置條件 描述運行該模塊之前必須滿足的前提條件 后置影響 描述運行該模塊之后將會產生的影響。 子模塊劃分 對該模塊劃分成更小的模塊，并對每個子模塊的功能簡要說明。若該模塊較小，則不必細分。 2. 組件模塊接口設計 對每個組件模塊對外提供的方法進行描述。 方法 1 方法名 方法功能描述 輸入參數 輸出返回值 主要處理邏輯 備注 對于復雜的輸入參數需要詳細描述，描述示例如下： 統 要設計說明書 共 19 頁 第 11頁 使用 式描述完成該子模塊所需要的輸入數據格式，同時要注明哪些數據是由用戶輸入的，哪些是數據是由系統生成的。同時還要描述數據的具體格式要求，如最大長度，日期型還是整型，小數精確到幾位等。例如登錄模塊的輸入數據格式如下： 234 20020:20:9 據域 產生方式 數據類型 最大長度 最小長度 精確度 戶輸入 5 5 戶輸入 5 6 統產生 對于復雜的輸出返回需要詳細描述，描述示例如下： 描述該模塊執行后的輸出數據，包括成功失敗兩種情況。對失敗要枚舉出各種可能的結果。如果該輸出格式比較復雜，建議也用 式。 返回值 條 件 登錄成功 返回 礎數據等 登錄失敗 用戶名和密碼不對； 服務器忙； 無效 址； 你已經在線； 對于復雜的處理邏輯建議適用流程圖或者活動圖來描述 6. 用例實現 例 1 1. 用例概述 用例功能說明 對用例功能進行總體描述，著重描述該模塊的調用者，以及調用者通過該模塊完成什么樣的功能，及描述“做什么” . 用例前置條件 統 要設計說明書 共 19 頁 第 12頁 描述運行該模塊之前必須滿足的前提條件 用例后置影響 描述運行該模塊之后將會產生的影響。 2. 用戶界面 對于用戶界面的設計可以為可選項，如果缺少有關界面的設計描述，將給開發人員帶來對概要設計的二義性時則要求設計界面。界面的設計，要求根據本軟件所事先制訂的有關界面約定或設計規范，初步畫出各個用戶的操作界面。 界面要素 顯示名稱 描述 約束條件 備注 1） 操作 操作名稱 描述 約束條件 備注 3. 流程圖（或活動圖） 4. 前后臺交互的數據內容 5. 涉及主要組件模塊和功能模塊 列出實現該用例時所需要的組件模塊名稱，功能類，文件等等 6. 用例實現 1） 類圖 2） 時序圖 用戶界面的貼圖 或輸出報表樣式 統 要設計說明書 共 19 頁 第 13頁 7. 數據結構設計 表名或視圖名 段名 字段代碼 類型和長度 字段說明 可空 缺省值 取值范圍 鍵值 索引 8. 接口設計 為可選項，若存在有關的接口并且需要特別說明，否則容易產生開發者對系統設計的二義性時需要詳細描述。 接口分為外部接口和內部接口，其中外部接口如：用戶界面、軟件接口與硬件接口等，內部接口如：子系統之間的接口關系，模塊之間的接口，主要是有關傳遞信息 , 參數等等。 本章若存在 N 個接口，則可分為 N 節來描述，每個接口單獨為一節，標題可自行決定。 9. 系統安全設計 為可選項，如果系統設計對安全保密性有特別的要求，則需要詳細描述，主要可以從以下幾方面進行考慮：系統故障預防與恢復、用戶管理和權限控制、數據備份和恢復等 統故障預防和恢復 為可選項，如果存在可能出現的系統故障需要恢復的情況，則要進行設計描述，主要說明將使用的恢 復再啟動技術，使軟件從故障點恢復執行或使軟件從頭開始重新運行的方法，建議可按照以下格式進行說明： 為恢復系統（包括軟硬件）故障和人為因素引起的數據錯，特設計以下措施： 出錯現象 可能原因 措施 盤后清算出現異常 本地柜臺的交易數據出錯 恢復昨日盤后數據，重新接受交易所當日委托數據，重新進行清算 統 要設計說明書 共 19 頁 第 14頁 戶管理和權限控制 說明在數據庫的設計中，將如何通過區分不同的訪問者、不同的訪問類型和不同的數據對象，進行分配權限并分別對待而獲得的數據庫安全保密的設計考慮。 據備份與恢復 為可選項，如果存在數據備份與恢復的需求要求，則要做相應的設計描述。 對數據備份與恢復的設計，主要說明在適當的時間點上，如何設計系統的數據備份和數據恢復功能，以便在系統失效、出現意外及數據出錯、或有充分的需要的時候，可以在可接受的時間內得以恢復到最近或以前某個時間點的數據備份上，要求描述清楚實現數據備份和恢復的整個設計思想以及實現方法。 數據備份 系統是一套 24 小時實時運行的加以系統，數據庫中存儲的數據大部分是非常重要的商業交易數據，它要求高度的安全性和強健的完整性，所以，必須制定功能完善的數據備份策略，充分 保證數據庫系統的安全和完整。為此制定以下安全備份措施： 所有交易數據庫，全部對應建立歷史備份數據庫，定期將當前數據庫中的數據追加到歷史數據庫中。 對歷史數據庫中的數據，定期備份。一般當前數據，每月一次自動復制到歷史數據庫中；歷史數據保留半年后，使用光盤刻錄設備，進行 2 份以上備份存檔，然后可清除歷史數據庫和當前數據庫中的這部份數據，以提高系統運行效率，釋放部分硬件資源。 主數據庫服務器使用磁帶備份系統，對數據庫中的實時數據作更新備份和增量備份（不包括歷史庫）。 1. 數據庫日備份：系統每日自動將更新操作后的數據備份 到磁帶機上。 2. 數據庫周備份：每周一次，系統自動將所有數據庫備份到磁帶機上。 3. 數據庫月備份：每月一次，系統自動備份所有數據庫到磁帶機上。 主數據庫服務器使用跟蹤帶，對系統操作進行跟蹤記錄。 數據恢復 數據的恢復措施主要與數據備份相對應： 如果當前數據庫因故遭到破壞，不能保證其完整性時，應進行恢復。步驟如下： 1. 先將歷史庫中的數據追加到當前庫中。 2. 將磁帶上的數據按月備份、周備份、日備份的順序，依次恢復到當前數據統 要設計說明書 共 19 頁 第 15頁 庫中。 3. 按照跟蹤帶上的操作順序，將當天的數據進行恢復。 可根據具體情況選擇其中的若干步執行。 如需查詢歷 史數據，可將光盤中部分或全部歷史數據，重新導入數據庫中。 10. 系統運行設計 為可選項，當系統足夠大被拆分成若干子系統，如果不專門介紹系統運行時各子系統之間的運行機制和控制關系，則開發人員無法理解本概要設計說明書而導致無法實現系統功能時，才有必要進行相關運行設計的描述。 運行設計，主要用來說明運行模塊的組合，進行軟件系統的構造設計，確定系統的運行控制方法及資源分配情況 行模塊組合 說明對系統施加不同的外界運行控制時所引起的各種不同的運行模塊組合，說明每種運行所歷經的內部模塊和支持軟件，建議畫出系統運行機制結構圖 來表示，再附上簡要的文字說明，以描述清楚各個運行模塊（包括各種運行的進程），分別如何運行在各自指定的硬件上（必要時要說明相關的硬件配置及其在運行環境下所起的作用） 行控制 描述清楚各個運行模塊進行運行控制的方式、方法和操作步驟，以及每種運行模塊組合將各自占用的各種資源情況，以及對時間響應的要求，可以分別從以下幾方面進行描述： 多機管理，一臺服務器應允許多臺客戶端機器加入應用系統，則要描述清楚服務器是如何進行管理多臺機器的。 合法性檢查，當客戶端需要訪問后臺數據庫的業務數據時，有關應用系統的網關服務或其他相關服務程序是如何進行用戶身份的合法性校驗，一般系統都會要求每一個用戶發出某個服務請求后，必須首先輸入自己的用戶名和密碼 請求響應，有關服務器對用戶的各種請求的響應，采用多線程的并發處理還是單線程的串行順序處理等方式的實現情況，以及對事務處理的時間響應要求等 控制界面，關于用戶監控系統（如：國泰君安實時監控系統）的監控屏幕上應該顯示各種業務處理信息，出現異常時要求要實時報警或做相應妥善的處理。 通訊控制，描述清楚系統所采納的通訊 平臺的有關說明，包括前臺和后臺之統 要設計說明書 共 19 頁 第 16頁 間的通訊、網關之間的數據轉換處理，以及通訊時所采用的通訊協議等內容 核心業務處理，說明對客戶的許多關鍵或主要業務的系統實現，在整個運行機制中是如何進行控制的 11. 系統出錯處理設計 為可選項，如果不專門對系統出錯信息進行設計描述，將導致開發人員無法理解本概要設計的有關出錯信息的處理說明，無法實現有關出錯處理功能時，才需要描述本章節的內容 錯處理信息 羅列本軟件系統可能的出錯或故障情況出現的各種出錯處理信息，包括系統出錯信息提示的形式（包括出錯對話框的設計）、含義及處理方法等。 在 操作出錯或數據出錯等情況下，系統顯示或記錄的有關出錯代碼信息，要求要符合相關的系統出錯處理設計規范（如果規范存在的話） 出錯的分類可以參考以下： 通訊線路錯誤 系統環境錯誤 應用設計錯誤 錯處理對策 說明故障出現或系統出錯后可能采取的變通補救辦法，主要包括：設置后備技術、性能降級（即降效技術）、恢復及再啟動等等。 設置后備技術，體現在：當原始系統數據萬一丟失時則啟用的副本的建立或啟動的技術，采用磁帶備份等 降效技術，也是一種后備技術，體現在：使用另一種效率稍低的系統或方法求得所需結果的某些部分， 如手工操作。 下述為對于系統環境出錯處理對策參考： 統 要設計說明書 共 19 頁 第 17頁 系統故障根據系統類型可分為四類：系統軟件故障、應用軟件故障、硬件系統故障、網絡系統故障。系統維護工作的進行，應建立在對系統正常按章操作的基礎上，把人為損壞的因素降到最低。因此，良好和規范的操作習慣是保證系統穩定運行的重要保障。 系統類型 故障類型 維護措施 系統軟件 統故障 設置專職系統管理員 統故障類型較多，具體故障對應具體的處理辦法，不能一一列舉。但在系統安裝設置完成后，應及時備份主要系統文件，編制一些系統維護管理的 序，盡可能方便地提供管理信息，幫助系統管理員進行系統維護工作 T 系統故障 設置專職系統管理員，其他用戶嚴格授權。系統安裝病毒實時監測掃描軟件，定期更新病毒特征代碼文件 統故障類型也較多，要求系統管理員具備專業的系統管理知識和經驗，針對具體情況采用不同的維護策略 統故障 一般情況下，硬盤分成二個分區，系統放在 C 盤，數據存放在D 盤安裝病毒實時監測掃描軟件，定期更新病毒特征代碼文件其它故障由系統管理員根據具體情況處理 應用軟件 不能實現設計功能 檢查操作流程及先后順序是否正確檢查輸入數據的合法性和有效性仍有問題，與開發商聯系 執行出現錯誤及提示 根據提示重新操作如屬系統錯誤，與開發商聯系 硬件系統 主服務器硬盤發生故障，讀寫出錯 磁盤陣列或冗余方式下直接更