系統(tǒng)概要設(shè)計(jì)分析說(shuō)明書(shū)模板

1、完美WORD格式XXX概要設(shè)計(jì)說(shuō)明書(shū)（v.xxx）文檔狀態(tài)：文檔標(biāo)識(shí)：XXX-SD-V 草稿正式發(fā)布修改編撰：編撰日期：保密級(jí)別：文檔版本：XXXXX修訂歷史記錄日期版本說(shuō)明作者整理分享目錄1 引言 11.1 編寫(xiě)目的 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 模

2、塊1設(shè)計(jì)說(shuō)明 34.1.1 模塊描述 34.1.2 功能說(shuō)明 34.1.3 流程描述 34.1.4 相關(guān)算法 44.1.5 性能 44.1.6 限制條件 44.1.7 尚未解決的問(wèn)題 45 權(quán)限設(shè)計(jì) 46 外部接口設(shè)計(jì) 56.1 XXXX接口 57 數(shù)據(jù)庫(kù)設(shè)計(jì) 58 非功能設(shè)計(jì) 58.1 性能設(shè)計(jì) 58.2 事務(wù)處理 58.3 錯(cuò)誤處理 68.4 日志處理和日志分析 68.5 安全設(shè)計(jì) 69 信息定義 610 風(fēng)險(xiǎn)管理 610.1 技術(shù)風(fēng)險(xiǎn) 611 遵循標(biāo)準(zhǔn)與規(guī)范 61引言1.1 編寫(xiě)目的說(shuō)明編寫(xiě)這份設(shè)計(jì)說(shuō)明書(shū)的目的，指出預(yù)期的讀者。1.2背景列出本項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶(hù)，提出的緣由，

3、現(xiàn)狀分析等1.3定義列出本文件中用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。1.4參考資料列出有關(guān)的參考資料。2設(shè)計(jì)概要2.1設(shè)計(jì)范圍說(shuō)明本文檔設(shè)計(jì)所包括的內(nèi)容，如功能、接口描述2.2設(shè)計(jì)目標(biāo)從通過(guò)本次設(shè)計(jì)能夠解決那些問(wèn)題，達(dá)到什么樣的效果2.3設(shè)計(jì)原則針對(duì)本項(xiàng)目說(shuō)明系統(tǒng)設(shè)計(jì)所要遵循的相應(yīng)的原則，如標(biāo)準(zhǔn)化、模塊化等，并做詳細(xì)說(shuō)明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)的各個(gè)組件。相對(duì)細(xì)致的描 述各個(gè)組件之間和系統(tǒng)與系統(tǒng)之間的連接以及通信關(guān)系3.4 功能架構(gòu)用功能結(jié)構(gòu)圖和文字的方式描述系統(tǒng)的

4、主要功能以及功能之間的關(guān)系3.5 技術(shù)架構(gòu)用技術(shù)架構(gòu)圖和文字的方式描述系統(tǒng)所采用的技術(shù)路線以及系統(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)用服務(wù)器、數(shù)據(jù)庫(kù)服務(wù)器、數(shù)據(jù)交換服務(wù)器等在物理上的拓 撲結(jié)構(gòu)。3.6.2硬件配置方案用列表的形式說(shuō)明系統(tǒng)的硬件需求，主要包括硬件的詳細(xì)配置，用途、數(shù)量3.6.3軟件配置方案用列表的形式說(shuō)明系統(tǒng)的軟件需求，主要包括軟件的詳細(xì)配置，用途、數(shù)量4功能設(shè)計(jì)4.1 模塊1設(shè)計(jì)說(shuō)明從本章開(kāi)始，逐個(gè)地給出各個(gè)層次中的每個(gè)模塊的設(shè)計(jì)考慮。以下給出的提綱是針對(duì) 一般情況的。對(duì)于一個(gè)具體的模塊，尤其是層次比較低的模塊或子程序，其很多條

5、目的內(nèi) 容往往與它所隸屬的上一層模塊的對(duì)應(yīng)條目的內(nèi)容相同，在這種情況下，只要簡(jiǎn)單地說(shuō)明 這幾點(diǎn)即可。4.1.1模塊描述給出對(duì)該模塊的基本描述，主要說(shuō)明設(shè)計(jì)本模塊對(duì)應(yīng)的主要需求，建設(shè)目的意義、建 設(shè)的主要內(nèi)容、模塊的特點(diǎn)等4.1.2功能說(shuō)明說(shuō)明該基本模塊應(yīng)具有的功能 ，用列表的形式列出該模塊的主要的功能點(diǎn)，并描述各個(gè)功能點(diǎn)的簡(jiǎn)要說(shuō)明如下圖所示:原型界面界面ID功能概述狀態(tài)評(píng)價(jià)計(jì)劃管理PM00001實(shí)現(xiàn)狀態(tài)評(píng)價(jià)計(jì)劃的查詢(xún)，修改，刪除等功能4.1.3流程描述Visio繪制流程圖、或者用用圖表輔以必要的說(shuō)明來(lái)表示本模塊的邏輯流程，可以用 活動(dòng)圖等圖形形式來(lái)描述，也可以使用UML工具構(gòu)建該部分需要按照模

6、塊業(yè)務(wù)流程進(jìn)行詳細(xì)描述4.1.4相關(guān)算法對(duì)于使用到特殊或者復(fù)雜算法，應(yīng)具體的說(shuō)明算法的計(jì)算公式及計(jì)算步驟，以及實(shí)現(xiàn) 的方式等4.1.5性能功能點(diǎn)ID預(yù)計(jì)最大數(shù)據(jù)量響應(yīng)時(shí)間要求性能瓶頸點(diǎn)解決該問(wèn)題的關(guān)鍵技術(shù)點(diǎn)說(shuō)明對(duì)該模塊的性能要求，如定義多大的數(shù)據(jù)量下，該模塊的響應(yīng)時(shí)間，該性能的定義也將作為系統(tǒng)開(kāi)發(fā)完成后的測(cè)試項(xiàng)目4.1.6限制條件說(shuō)明本模塊在運(yùn)行使用中所受到的限制條件。4.1.7尚未解決的問(wèn)題說(shuō)明在本程序的設(shè)計(jì)中尚未解決而設(shè)計(jì)者認(rèn)為在軟件完成之前應(yīng)解決的問(wèn)題5權(quán)限設(shè)計(jì)表述角色定義，功能權(quán)限、數(shù)據(jù)權(quán)限分組。6外部接口設(shè)計(jì)6.1 XXXX接 口接口函數(shù)名： XXXX(stri ng strxxx

7、)接口頻度：多長(zhǎng)時(shí)間同步一次接口方式：采用哪種方式實(shí)現(xiàn)該接口，如 webservices等，是手動(dòng)或者自動(dòng)同步 參數(shù)strxxx :參數(shù)內(nèi)容說(shuō)明返回值：返回值定義Exception ：返回的錯(cuò)誤代碼定義，可參見(jiàn)消息定義功能描述：功能描述接口字段名英文名長(zhǎng)度類(lèi)型必傳內(nèi)容說(shuō)明設(shè)備類(lèi)型編碼FeatureType字符PAC該部分內(nèi)容可以為生成JavaDoc提供依據(jù)7數(shù)據(jù)庫(kù)設(shè)計(jì)【數(shù)據(jù)庫(kù)設(shè)計(jì)內(nèi)容主要給出數(shù)據(jù)庫(kù)的E-R圖實(shí)例，并能生成數(shù)據(jù)庫(kù)的建庫(kù)腳本】8非功能設(shè)計(jì)8.1性能設(shè)計(jì)【描述我們可能遇到的慢的操作和查詢(xún)以及任何提高他們的速度？我們所面臨的大數(shù)據(jù)量 的操作是什么？如果提高性能的策略？(比如：建立數(shù)據(jù)庫(kù)索引、數(shù)據(jù)分區(qū)、數(shù)據(jù)緩存) 等】8.2事務(wù)處理【系統(tǒng)事務(wù)處理策略和方法】8.3錯(cuò)誤處理【如何處理應(yīng)用系統(tǒng)和系統(tǒng)所產(chǎn)生的錯(cuò)誤？如何校驗(yàn)用戶(hù)的輸入？如果顯示錯(cuò)誤提示？如 果記錄日志供系統(tǒng)管理員分析？如果防止系統(tǒng)的崩潰？】8.4日志處理和日志分析【用戶(hù)操作的日志如何處理？】8.5安全設(shè)計(jì)從物理設(shè)備、網(wǎng)絡(luò)層的保護(hù)、操作系統(tǒng)的安全防護(hù)，數(shù)據(jù)的安全防護(hù)、應(yīng)用層的安全防護(hù)五個(gè)方面分別闡述如何保障系統(tǒng)的安全運(yùn)行9信息定義消息ID消息類(lèi)型消息內(nèi)容參數(shù)說(shuō)明I00001Info更新完成W00001Warni ng1 E00001Error在此處統(tǒng)一