系統概要設計說明書編寫标準「通用版」

1 前言

1.1 文檔目的

文檔編寫目的是為了闡述XXX系統的概要設計。概要設計說明書是為了說明整個XXX系統的體系架構，以及需求用例的各個功能點在架構中的展現，為系統的詳細設計人員進行詳細設計時的輸入參考文檔。本說明書的預期讀者為系統設計人員、系統開發人員和項目評審人員。

1.2 背景

XXX系統是

[項目背景]

1.3 文檔範圍

1、産品範圍：根據《需求規格說明書》，該文檔闡述軟體産品的功能

2、涉及到的幹系人有：公司高層、客戶、項目經理、品質小組、開發小組。

1.4 讀者對象

項目經理、品質保證人員：據此來進入項目策劃過程

測試人員：據此進入測試過程。

需求管理者、配置管理者：可以識别配置項制定相關的活動計劃

使用者IT主管：清楚與确認項目需求。

開發人員，包括設計人員、編碼人員：明确任務與需求，清楚項目開發流程。

1.5 參考文檔

《需求規格說明書》

1.6 術語與縮寫解釋

術語或縮略語	解釋

2 總體設計

2.1 系統描述

2.1.1 系統概述

XXX系統 ，采用XXX架構開發出的XXX平台。

2.1.2 運作環境

對本平台所賴于運作的硬體、軟體環境的描述。

1. 服務端作業系統：Windows Server 2003 SP2 及以上；

2. 服務端運作環境：JDK1.7及以上；

3. 資料庫支援：Oracle10g企業版；

4. 協定支援：TCP/IP、HTTP、HTTPS、SMTP、POP3等；

5. 硬體支援：伺服器CPU 2.0GHz以上、記憶體2G以上、需要300G 以上的空閑磁盤空間；

6. 網絡環境：有固定公網IP，網絡暢通，可以遠端通路(遠端桌面連接配接或者借助輔助工具)；

7. 用戶端要求：IE10以上；

2.1.3 資料管理要求

2.1.4 故障處理要求

（1）産品支撐環境運作錯誤，包括以下幾個方面：

資料庫運作錯誤：系統無法使用，将提供錯誤提示頁面，并記錄日志。

系統配置參數錯誤：系統提供錯誤提示頁面，要求管理者修改相關配置參數。配置參數的修改方法應參考相關為管理者提供的手冊。

系統參數初始化錯誤：提供系統初始化功能，用于成批完成系統初始化。在初始化過程中，對于嚴重影響平台運作的錯誤，提供錯誤提示頁面。對于普通錯誤，記錄日志。

應用程式錯誤：由應用程式提供錯誤提示頁面，相關錯誤應記錄日志。

2.1.5 其他要求

² 先進性：采用先進成熟的技術，確定系統的先進性、經濟性和實用性。

² 安全可靠：提供的應用架構及平台本身提供應用安全保證，并可以和第三方安全手段，如認證、加密、電子簽名等進行內建。必須保證資料的安全性和保密性。對于基于平台開發的應用系統，隻允許有權限的人員進行操作和浏覽資訊。必須有安全的手段來進行權限控制。

² 開放互連：系統應對各類業務系統、資料庫系統、WEB資訊等具有通用的或可定制的接口政策和連接配接方法。

² 規範性：開發過程控制、開發技術、系統編碼、文檔應規範化，并遵循相應的國内外标準。開發結束，需要提供必要的文檔資料。

² 可靠性：保證系統的可靠運作和在更新過程中的友善快捷。

² 可擴充性：系統應當可以根據需求的變化，友善地進行功能的調整、增減，子產品的更新和系統架構的逐漸完善。

² 界面友好、操作友善：操作界面要直覺、簡單、貼近實際，操作過程應當盡量簡化，符合實際過程。身份認證過程即要保證安全，也要盡量簡化認證過程。

² 可維護性：系統維護應當簡單。

2.2 總體設計說明

2.2.1 基本設計概述

從《需求規格說明書》出發，根據需求分析階段确定的功能設計軟體系統的整體結構、劃分功能子產品、确定每個子產品的實作算法以及編寫具體的代碼，形成軟體的具體設計方案。

2.2.2 設計思想

本概要設計主要由結構設計、接口設計、全局資料結構設計及其他方面設計組成。需遵循軟抽象、子產品化、資訊隐蔽及子產品獨立性等特征。子產品獨立性從兩個方面度量：

(1)内聚性：偶然内聚、邏輯内聚、時間内聚、過程内聚、通信内聚、順序内聚、功能内聚。

(2)耦合性：内容耦合、公共耦合、外部耦合、控制耦合、标記耦合、資料耦合、非直接耦合

2.2.3 系統總體結構

系統總體結構

2.2.4 處理流程

【描述系統主要功能子產品的處理流程】

3 接口設計

3.1 外部接口

【描述系統與外部第三方系統之間的接口】

3.2 内部接口

【描述系統内部各子系統之間的接口】

4 系統結構設計

4.1 子產品1

4.1.1 功能A

1. 界面原型

2. 實作功能

4.1.2 功能B

1. 界面原型

2. 實作功能

4.2 子產品2

4.2.1 功能C

1. 界面原型

2. 功能說明

4.2.2 功能D

1. 界面原型

2. 功能說明

5 系統資料結構

5.1 邏輯結構設計要點

XXX系統采用ORACLE資料庫。該資料庫基都是關系資料庫首先需要将E-R圖轉換為關系模型，然後根據具體DBMS的特點和限制轉換為特定的DBMS支援下的資料模型，最後進行優化。

1、E-R圖向關系模型的轉換

規則：一個實體型轉換為一個關系模式；一個1:1聯系可以轉換為一個獨立的關系模式，也可以與任意一端對應的關系模式合并；一個1:n聯系可以轉換為一個獨立的關系模式，也可以與n端對應的關系模式合并；一個m:n聯系可以轉換為一個獨立的關系模式；一個多元聯系可以轉換為一個獨立的關系模式；具有相同碼的關系模式可以合并；有些1：n的聯系，将屬性合并到n端後，該屬性也作為主碼的一部分

2、資料抽象分類

3、資料模型優化：确定資料依賴，對資料依賴進行極小化處理，消除備援聯系。确定範式級别，根據應用環境，對某些模式進行合并或分解

4、設計使用者子模式：考慮使用友善性和效率問題，主要借助視圖手段實作，包括：建立視圖，使用更符合使用者習慣的别名；對不同級别的使用者定義不同的視圖，以保證系統的安全性；對複雜的查詢操作，可以定義視圖，簡化使用者對系統的使用。

5.2 資料結構與子產品的關系

實體資料結構設計主要是設計資料在子產品中的表示形式。資料在子產品中都是以結構的方式表示。系統操作對資料庫資料結構，也就是資料表進行查詢和修改，在操作過程中都需要對資料庫中的所有表，進行聯合查詢、修改。主要用于各子產品之間函數的資訊傳遞。接口傳遞的資訊将是以資料結構封裝了的資料，以參數傳遞或傳回值的形式在各子產品間傳輸。出錯資訊将送入顯示子產品中。

6 運作設計

6.1 運作子產品的組合

程式在有輸入時啟動接收資料子產品，通過各子產品之間的調用，讀入并對輸入進行格式化。在接收資料子產品得到充分的資料時，将調用網絡傳輸子產品，将資料通過網絡送到伺服器，并等待接收伺服器傳回的資訊。接收到傳回資訊後随即調用資料輸出子產品，對資訊進行處理，産生相應的輸出。

伺服器程式的接收網絡資料子產品必須始終處于活動狀态。接收到資料後，調用資料處理/查詢子產品對資料庫進行通路，完成後調用程式子產品，将資訊傳回用戶端

6.2 運作控制

運作控制将嚴格按照各子產品間函數調用關系來實作。在各事務中心子產品中，需對運作控制進行正确的判斷，選擇正确的運作控制路徑。

6.3 運作時間

在産品的需求分析中，對運作時間的要求為必須對作出的操作有較快的反應。網絡硬體對運作時間有最大的影響，當網絡負載量大時，對操作反應将受到很大的影響。是以将采用高速ATM 網絡，實作客戶機與伺服器之間的連接配接，以減少網絡傳輸上的開銷。其次是伺服器的性能，這将影響對資料庫通路時間即操作時間的長短，影響加大客戶機操作的等待時間，是以必須使用高性能的伺服器，建議使用 Pentium III 處理器。硬體對本系統的速度影響将會大于軟體的影響。

7 系統錯誤處理機制

出錯類型	處理方法
輸入資訊，或無法滿足要求時産生的錯誤	須在操作成功判斷及輸入資料驗證子產品由資料進行資料分析，判斷錯誤類型，再生成相應的錯誤提示語句，送到輸出子產品中
由于其它問題，如網絡傳輸逾時等，産生的問題	可在出錯的相應子產品中輸出簡單的出錯語句，并将程式重置；傳回輸入階段。
伺服器安裝不間斷電源以防止停電或電壓不穩造成的資料丢失的損失	資料庫定時、及時備份
在硬體方面要選擇較可靠、穩定的伺服器機種，保證系統運作時的可靠性
如系統對可能出現的某些錯誤和故障作了專門的設計考慮, 給出這些錯誤或故障的定義。	說明将使用的恢複或再啟動技術, 使軟體從故障點恢複執行或軟體從頭開始重新運作的方法
出錯資訊必須給出相應的出錯原因