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

1、XXX概要設(shè)計(jì)說明書v.xxx文檔狀態(tài)：文檔標(biāo)識：XXX-SD-V草稿正式發(fā)布修改編撰：編撰日期：保密級別：文檔版本：xxxxx修訂歷史記錄日期版本說明作者目錄1 引言11.1 編寫目的11.2 背景11.3 定義11.4 參考資料12 設(shè)計(jì)概要12.1 設(shè)計(jì)范圍12.2 設(shè)計(jì)目標(biāo)12.3 設(shè)計(jì)原那么13 架構(gòu)設(shè)計(jì)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)23.6.2 硬件配置方案23.6.3 軟件配置方案24 功能設(shè)計(jì)34.1 模塊1設(shè)計(jì)說明34.1.1 模塊描述34.1.2 功能說明34.1.3

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

3、料.2設(shè)計(jì)概要2.1 設(shè)計(jì)范圍說明本文檔設(shè)計(jì)所包括的內(nèi)容,如功能、接口描述2.2 設(shè)計(jì)目標(biāo)從通過本次設(shè)計(jì)能夠解決那些問題,到達(dá)什么樣的效果2.3 設(shè)計(jì)原那么針對本工程說明系統(tǒng)設(shè)計(jì)所要遵循的相應(yīng)的原那么,如標(biāo)準(zhǔn)化、模塊化等,并做詳細(xì)說明3架構(gòu)設(shè)計(jì)3.1 概述3.2 系統(tǒng)邊界定義系統(tǒng)與其他系統(tǒng)間的功能、業(yè)務(wù)和數(shù)據(jù)邊界3.3 系統(tǒng)架構(gòu)用系統(tǒng)架構(gòu)圖描述本系統(tǒng)根本的結(jié)構(gòu),主要包括直接構(gòu)成系統(tǒng)的各個組件.相對細(xì)致的描述各個組件之間和系統(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ù)路線以及

4、系統(tǒng)的分層結(jié)構(gòu)關(guān)系3.6 部署架構(gòu)及軟硬件配置3.6.1 部署架構(gòu)描述系統(tǒng)的拓?fù)浣Y(jié)構(gòu),包括應(yīng)用效勞器、數(shù)據(jù)庫效勞器、數(shù)據(jù)交換效勞器等在物理上的拓?fù)浣Y(jié)構(gòu).3.6.2 硬件配置方案用列表的形式說明系統(tǒng)的硬件需求,主要包括硬件的詳細(xì)配置,用途、數(shù)量3.6.3 軟件配置方案用列表的形式說明系統(tǒng)的軟件需求,主要包括軟件的詳細(xì)配置,用途、數(shù)量4功能設(shè)計(jì)4.1 模塊1設(shè)計(jì)說明從本章開始,逐個地給出各個層次中的每個模塊的設(shè)計(jì)考慮.以下給出的提綱是針對一般情況的.對于一個具體的模塊,尤其是層次比擬低的模塊或子程序,其很多條目的內(nèi)容往往與它所隸屬的上一層模塊的對應(yīng)條目的內(nèi)容相同,在這種情況下,只要簡單地說明這幾點(diǎn)

5、即可.4.1.1 模塊描述給出對該模塊的根本描述,主要說明設(shè)計(jì)本模塊對應(yīng)的主要需求,建設(shè)目的意義、建設(shè)的主要內(nèi)容、模塊的特點(diǎn)等4.1.2 功能說明說明該根本模塊應(yīng)具有的功能,用列表的形式列出該模塊的主要的功能點(diǎn),并描述各個功能點(diǎn)的簡要說明如下列圖所示：原型界囿界囿ID功能概述狀態(tài)評價方案治理PM00001實(shí)現(xiàn)狀態(tài)評價方案的查詢,修改,刪除等功能4.1.3 流程描述用圖表輔以必要的說明來表示本模塊的邏輯流程,可以用Visio繪制流程圖、或者用活動圖等圖形形式來描述,也可以使用UMLX具卞建該局部需要根據(jù)模塊業(yè)務(wù)流程進(jìn)行詳細(xì)描述4.1.4 相關(guān)算法對于使用到特殊或者復(fù)雜算法,應(yīng)具體的說明算法的計(jì)算

6、公式及計(jì)算步驟,以及實(shí)現(xiàn)的方式等4.1.5 性能功能點(diǎn)ID預(yù)計(jì)最大數(shù)據(jù)量響應(yīng)時間要求性能瓶頸點(diǎn)解決該問題的關(guān)鍵技術(shù)點(diǎn)說明對該模塊的性能要求,如定義多大的數(shù)據(jù)量下,該模塊的響應(yīng)時間,該性能的定義也將作為系統(tǒng)開發(fā)完成后的測試工程4.1.6 限制條件說明本模塊在運(yùn)行使用中所受到的限制條件.4.1.7 尚未解決的問題說明在本程序的設(shè)計(jì)中尚未解決而設(shè)計(jì)者認(rèn)為在軟件完成之前應(yīng)解決的問題5權(quán)限設(shè)計(jì)表述角色定義,功能權(quán)限、數(shù)據(jù)權(quán)限分組.6外部接口設(shè)計(jì)6.1XXXXH接口函數(shù)名：XXXX(stringstrxxx)接口頻度：多長時間同步一次接口方式：采用哪種方式實(shí)現(xiàn)該接口,如webservices等,是手動或者

7、自動同步參數(shù)strxxx:參數(shù)內(nèi)容說明返回值：返回值定義Exception:返回的錯誤代碼定義,可參見消息定義功能描述：功能描述接口字段名英文名長度必傳內(nèi)容說明設(shè)備類型編碼FeatureType字符PAC該局部內(nèi)容可以為生成JavaDoc提供依據(jù)7數(shù)據(jù)庫設(shè)計(jì)【數(shù)據(jù)庫設(shè)計(jì)內(nèi)容主要給出數(shù)據(jù)庫的E-R圖實(shí)例,并能生成數(shù)據(jù)庫的建庫腳本】8非功能設(shè)計(jì)8.1 性能設(shè)計(jì)【描述我們可能遇到的慢的操作和查詢以及任何提升他們的速度我們所面臨的大數(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)生的錯誤如何校驗(yàn)用戶的輸入如果顯示錯誤提示如果記錄日志供系統(tǒng)治理員分析如果預(yù)防系統(tǒng)的崩潰】8.4 日志處理和日志分析【用戶操作的日志如何處理】8.5 平安設(shè)計(jì)從物理設(shè)備、網(wǎng)絡(luò)層的保護(hù)、操作系統(tǒng)的平安防護(hù),數(shù)據(jù)的平安防護(hù)、應(yīng)用層的平安防護(hù)五個方面分別闡述如何保證系統(tǒng)的平安運(yùn)行9信息定義消息ID消息類型消息內(nèi)容參數(shù)說明'|I00001Info更新完成W00001WarningE00001Error在此處