系統(tǒng)概要設計說明書-模板

1、xxx概要設計說明書文檔狀態(tài)：文檔標識：xxx-sd-v草稿正式發(fā)布修改編撰：編撰日期：保密級別：文檔版本：xxxxx修訂歷史記錄日期版本說明作者.目錄1 引言11.1 編寫目的11.2 背景11.3 定義11.4 參考資料12 設計概要12.1 設計范圍12.2 設計目標12.3 設計原則13 架構設計23.1 概述23.2 系統(tǒng)邊界23.3 系統(tǒng)架構23.4 功能架構23.5 技術架構23.6 部署架構及軟硬件配置 23.6.1 部署架構23.6.2 硬件配置方案23.6.3 軟件配置方案24 功能設計34.1 模塊1設計說明34.1.1 模塊描述34.1.2 功能說明 34.1.3 流程

2、描述34.1.4 相關算法44.1.5 性能44.1.6 限制條件44.1.7 尚未解決的問題 45 權限設計46 外部接口設計56.1 xxxx 接口57 數(shù)據(jù)庫設計58 非功能設計58.1 性能設計58.2 事務處理68.3 錯誤處理68.4 日志處理和日志分析 68.5 安全設計69 信息定義610 風險管理610.1 技術風險611 遵循標準與規(guī)范71引言1.1 編寫目的說明編寫這份設計說明書的目的，指出預期的讀者。1.2 背景列出本項目的任務提出者、開發(fā)者、用戶，提出的緣由，現(xiàn)狀分析等1.3 定義列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。1.4 參考資料列出有關的參考

3、資料。2設計概要2.1 設計范圍說明本文檔設計所包括的內容，如功能、接口描述 2.2 設計目標從通過本次設計能夠解決那些問題，達到什么樣的效果2.3 設計原則針對本項目說明系統(tǒng)設計所要遵循的相應的原則，如標準化、模塊化等，并做詳細說明3架構設計3.1 概述3.2 系統(tǒng)邊界定義系統(tǒng)與其他系統(tǒng)間的功能、業(yè)務和數(shù)據(jù)邊界3.3 系統(tǒng)架構用系統(tǒng)架構圖描述本系統(tǒng)基本的結構，主要包括直接構成系統(tǒng)的各個組件。相對細致的描 述各個組件之間和系統(tǒng)與系統(tǒng)之間的連接以及通信關系3.4 功能架構用功能結構圖和文字的方式描述系統(tǒng)的主要功能以及功能之間的關系3.5 技術架構用技術架構圖和文字的方式描述系統(tǒng)所采用的技術路線以

4、及系統(tǒng)的分層結構關系3.6 部署架構及軟硬件配置3.6.1 部署架構描述系統(tǒng)的拓撲結構，包括應用服務器、數(shù)據(jù)庫服務器、數(shù)據(jù)交換服務器等在物理上的拓 撲結構。3.6.2 硬件配置方案用列表的形式說明系統(tǒng)的硬件需求，主要包括硬件的詳細配置，用途、數(shù)量 3.6.3 軟件配置方案用列表的形式說明系統(tǒng)的軟件需求，主要包括軟件的詳細配置，用途、數(shù)量 4功能設計4.1 模塊1設計說明從本章開始，逐個地給出各個層次中的每個模塊的設計考慮。以下給出的提綱是針對 一般情況的。對于一個具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的內 容往往與它所隸屬的上一層模塊的對應條目的內容相同，在這種情況下，只要簡單

5、地說明 這幾點即可。4.1.1 模塊描述給出對該模塊的基本描述，主要說明設計本模塊對應的主要需求，建設目的意義、建 設的主要內容、模塊的特點等 4.1.2 功能說明說明該基本模塊應具有的功能 ，用列表的形式列出該模塊的主要的功能點，并描述各 個功能點的簡要說明如下圖所示：原型界面狀態(tài)評價計劃管理界面idpm00001功能概述實現(xiàn)狀態(tài)評價計劃的查詢，修改，刪除等功能visio繪制流程圖、或者用4.1.3 流程描述用圖表輔以必要的說明來表示本模塊的邏輯流程，可以用活動圖等圖形形式來描述，也可以使用umlx具卞建該部分需要按照模塊業(yè)務流程進行詳細描述4.1.4 相關算法對于使用到特殊或者復雜算法，應

6、具體的說明算法的計算公式及計算步驟，以及實現(xiàn) 的方式等4.1.5 性能功能點id預計最大數(shù)據(jù)量響應時間要求性能瓶頸點解決該問題的關鍵技術點1說明對該模塊的性能要求，如定義多大的數(shù)據(jù)量下，該模塊的響應時間，該性能的定義也將作為系統(tǒng)開發(fā)完成后的測試項目4.1.6 限制條件說明本模塊在運行使用中所受到的限制條件。4.1.7 尚未解決的問題說明在本程序的設計中尚未解決而設計者認為在軟件完成之前應解決的問題5權限設計表述角色定義，功能權限、數(shù)據(jù)權限分組。6外部接口設計6.1 xxxx 接口接口函數(shù)名：xxxx(string strxxx )接口頻度：多長時間同步一次接口方式：采用哪種方式實現(xiàn)該接口，如

7、webservices等，是手動或者自動同步參數(shù)strxxx :參數(shù)內容說明返回值：返回值定義exception :返回的錯誤代碼定義，可參見消息定義功能描述：功能描述接口字段名英文名長度必傳內容說明設備類型編碼featuretype字符pac該部分內容可以為生成javadoc提供依據(jù)7數(shù)據(jù)庫設計【數(shù)據(jù)庫設計內容主要給出數(shù)據(jù)庫的e-r圖實例，并能生成數(shù)據(jù)庫的建庫腳本】8非功能設計8.1 性能設計【描述我們可能遇到的慢的操作和查詢以及任何提高他們的速度？我們所面臨的大數(shù)據(jù)量 的操作是什么？如果提高性能的策略？(比如：建立數(shù)據(jù)庫索引、數(shù)據(jù)分區(qū)、數(shù)據(jù)緩存) 等】8.2 事務處理【系統(tǒng)事務處理策略和方法】8.3 錯誤處理【如何處理應用系統(tǒng)和系統(tǒng)所產生的錯誤？如何校驗用戶的輸入？如果顯示錯誤提示？如 果記錄日志供系統(tǒng)管理員分析？如果防止系統(tǒng)的崩潰？】8.4 日志處理和日志分析【用戶操作的日志如何處理？】8.5 安全設計從物理設備、網絡層的保護、操作系統(tǒng)的安全防護，數(shù)據(jù)的安全防護、應用層的安全 防護五個方面分別闡述如何保障系統(tǒng)的安全運行9信息定義消息id消息類型消息內容參數(shù)說明i00001info更新完成w00001warninge00001error在此處統(tǒng)一定