系統(tǒng)概要設(shè)計說明書_實用模板

1、.×××概要設(shè)計說明書（V.XXX）文檔狀態(tài)：草稿 正式發(fā)布修改文檔標識：XXX-SD-編撰：編撰日期：保密級別：文檔版本：xxxxx. . .修訂歷史記錄日期版本說明作者. . . . .目錄1引言.11.1編寫目的 . .11.2背景 . .11.3定義 . .11.4參考資料 . .12設(shè)計概要 .12.1設(shè)計范圍 . .12.2設(shè)計目標 . .12.3設(shè)計原則 . .13架構(gòu)設(shè)計 .23.1概述 . .23.2系統(tǒng)邊界 . .23.3系統(tǒng)架構(gòu) . .23.4功能架構(gòu) . .23.5技術(shù)架構(gòu) . .23.6部署架構(gòu)及軟硬件配置 . .23.6.1部署架構(gòu) .

2、23.6.2硬件配置方案 .23.6.3軟件配置方案 .24功能設(shè)計 .34.1模塊 1 設(shè)計說明 . .34.1.1模塊描述 .34.1.2功能說明 .34.1.3流程描述 .34.1.4相關(guān)算法 .44.1.5性能 .44.1.6限制條件 .44.1.7尚未解決的問題 .45權(quán)限設(shè)計 .56外部接口設(shè)計 .5. . .6.1XXXX接口 .57數(shù)據(jù)庫設(shè)計 .58非功能設(shè)計 .58.1性能設(shè)計 . .58.2事務(wù)處理 . .68.3錯誤處理 . .68.4日志處理和日志分析 . .68.5安全設(shè)計 . .69信息定義 .610風險管理 .610.1技術(shù)風險 . .611遵循標準與規(guī)范 . .

3、7. . .1 引言1.1編寫目的 說明編寫這份設(shè)計說明書的目的，指出預(yù)期的讀者。1.2背景 列出本項目的任務(wù)提出者、開發(fā)者、用戶，提出的緣由，現(xiàn)狀分析等1.3定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料 列出有關(guān)的參考資料。2 設(shè)計概要2.1設(shè)計范圍 說明本文檔設(shè)計所包括的內(nèi)容，如功能、接口描述2.2設(shè)計目標 從通過本次設(shè)計能夠解決那些問題，達到什么樣的效果2.3設(shè)計原則 針對本項目說明系統(tǒng)設(shè)計所要遵循的相應(yīng)的原則，如標準化、模塊化等，并做詳細說明. . .3 架構(gòu)設(shè)計3.1概述3.2系統(tǒng)邊界 定義系統(tǒng)與其他系統(tǒng)間的功能、業(yè)務(wù)和數(shù)據(jù)邊界3.3系統(tǒng)架構(gòu) 用系統(tǒng)

4、架構(gòu)圖描述本系統(tǒng)基本的結(jié)構(gòu)，主要包括直接構(gòu)成系統(tǒng)的各個組件。相對細致的描述各個組件之間和系統(tǒng)與系統(tǒng)之間的連接以及通信關(guān)系3.4功能架構(gòu) 用功能結(jié)構(gòu)圖和文字的方式描述系統(tǒng)的主要功能以及功能之間的關(guān)系3.5技術(shù)架構(gòu) 用技術(shù)架構(gòu)圖和文字的方式描述系統(tǒng)所采用的技術(shù)路線以及系統(tǒng)的分層結(jié)構(gòu)關(guān)系3.6部署架構(gòu)及軟硬件配置部署架構(gòu) 描述系統(tǒng)的拓撲結(jié)構(gòu)，包括應(yīng)用服務(wù)器、數(shù)據(jù)庫服務(wù)器、數(shù)據(jù)交換服務(wù)器等在物理上的拓撲結(jié)構(gòu)。 硬件配置方案 用列表的形式說明系統(tǒng)的硬件需求，主要包括硬件的詳細配置，用途、數(shù)量軟件配置方案 用列表的形式說明系統(tǒng)的軟件需求，主要包括軟件的詳細配置，用途、數(shù)量. . .4 功能設(shè)計4.1模塊

5、1 設(shè)計說明 從本章開始，逐個地給出各個層次中的每個模塊的設(shè)計考慮。以下給出的提綱是針對一般情況的。對于一個具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的內(nèi)容往往與它所隸屬的上一層模塊的對應(yīng)條目的內(nèi)容相同，在這種情況下，只要簡單地說明這幾點即可。 模塊描述 給出對該模塊的基本描述，主要說明設(shè)計本模塊對應(yīng)的主要需求，建設(shè)目的意義、建設(shè)的主要內(nèi)容、模塊的特點等功能說明 說明該基本模塊應(yīng)具有的功能, 用列表的形式列出該模塊的主要的功能點，并描述各個功能點的簡要說明 如下圖所示：原型界面界面 ID功能概述狀態(tài)評價計劃管理PM00001實現(xiàn)狀態(tài)評價計劃的查詢，修改，刪除等功能流程描述 用圖表輔

6、以必要的說明來表示本模塊的邏輯流程，可以用Visio繪制流程圖、或者用活動圖等圖形形式來描述，也可以使用UML工具構(gòu)建 該部分需要按照模塊業(yè)務(wù)流程進行詳細描述. . .相關(guān)算法 對于使用到特殊或者復(fù)雜算法，應(yīng)具體的說明算法的計算公式及計算步驟，以及實現(xiàn)的方式等 性能功能點 ID預(yù)計最大數(shù)據(jù)量響應(yīng)時間要求性能瓶頸點解決該問題的關(guān)鍵技術(shù)點 說明對該模塊的性能要求，如定義多大的數(shù)據(jù)量下，該模塊的響應(yīng)時間，該性能的定義也將作為系統(tǒng)開發(fā)完成后的測試項目限制條件 說明本模塊在運行使用中所受到的限制條件。尚未解決的問題說明在本程序的設(shè)計中尚未解決而設(shè)計者認為在軟件完成之前應(yīng)解決的問題. . .5 權(quán)限設(shè)計表

7、述角色定義，功能權(quán)限、數(shù)據(jù)權(quán)限分組。6 外部接口設(shè)計6.1XXXX接口接口函數(shù)名： XXXX(string strxxx）接口頻度： 多長時間同步一次 接口方式： 采用哪種方式實現(xiàn)該接口，如webservices 等，是手動或者自動同步 參數(shù) strxxx： 參數(shù)內(nèi)容說明 返回值： 返回值定義 Exception ： 返回的錯誤代碼定義, 可參見消息定義 功能描述： 功能描述接口字段名英文名長度類型必傳內(nèi)容說明設(shè)備類型編碼FeatureType字符PAC該部分內(nèi)容可以為生成JavaDoc 提供依據(jù)7 數(shù)據(jù)庫設(shè)計【數(shù)據(jù)庫設(shè)計內(nèi)容主要給出數(shù)據(jù)庫的E-R 圖實例，并能生成數(shù)據(jù)庫的建庫腳本】8 非功能

8、設(shè)計8.1性能設(shè)計【描述我們可能遇到的慢的操作和查詢以及任何提高他們的速度？我們所面臨的大數(shù)據(jù)量的操作是什么？如果提高性能的策略？（比如：建立數(shù)據(jù)庫索引、數(shù)據(jù)分區(qū)、數(shù)據(jù)緩存）等】. . .8.2事務(wù)處理【系統(tǒng)事務(wù)處理策略和方法】8.3錯誤處理【如何處理應(yīng)用系統(tǒng)和系統(tǒng)所產(chǎn)生的錯誤？如何校驗用戶的輸入？如果顯示錯誤提示？如果記錄日志供系統(tǒng)管理員分析？如果防止系統(tǒng)的崩潰？】8.4日志處理和日志分析【用戶操作的日志如何處理？】8.5安全設(shè)計從物理設(shè)備、網(wǎng)絡(luò)層的保護、操作系統(tǒng)的安全防護，數(shù)據(jù)的安全防護、應(yīng)用層的安全防護五個方面分別闡述如何保障系統(tǒng)的安全運行9 信息定義消息 ID消息類型消息內(nèi)容參數(shù)說明I00001Info更新完成W00001WarningE00001Error 在此處統(tǒng)一定義系統(tǒng)的消息提