系統(tǒng)概要設(shè)計(jì)項(xiàng)目說明指導(dǎo)書模板

×××概要設(shè)計(jì)說明書（V.XXX）文檔狀態(tài)：文檔標(biāo)識(shí)：XXX-SD-[√]初稿[]正式公布[]修改編撰：編撰日期：保密等級(jí)：文檔版本：xxxxxxxxxx修訂歷史統(tǒng)計(jì)日期版本說明作者目錄1 引言 11.1 編寫目標(biāo) 11.2 背景 11.3 定義 11.4 參考資料 12 設(shè)計(jì)概要 12.1 設(shè)計(jì)范圍 12.2 設(shè)計(jì)目標(biāo) 12.3 設(shè)計(jì)標(biāo)準(zhǔn) 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步驟描述 34.1.4相關(guān)算法 44.1.5性能 44.1.6限制條件 44.1.7還未處理問題 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ù)處理 68.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ī)范 7引言編寫目標(biāo)[說明編寫這份設(shè)計(jì)說明書目標(biāo)，指出預(yù)期讀者。]背景[列出本項(xiàng)目標(biāo)任務(wù)提出者、開發(fā)者、用戶，提出緣由，現(xiàn)實(shí)狀況分析等]定義[列出本文件中用到專門術(shù)語(yǔ)定義和外文首字母組詞原詞組。]參考資料[列出相關(guān)參考資料。]設(shè)計(jì)概要設(shè)計(jì)范圍[說明本文檔設(shè)計(jì)所包含內(nèi)容，如功效、接口描述]設(shè)計(jì)目標(biāo)[從經(jīng)過此次設(shè)計(jì)能夠處理那些問題，達(dá)成什么樣效果]設(shè)計(jì)標(biāo)準(zhǔn)[針對(duì)本項(xiàng)目說明系統(tǒng)設(shè)計(jì)所要遵照對(duì)應(yīng)標(biāo)準(zhǔn)，如標(biāo)準(zhǔn)化、模塊化等，并做具體說明]架構(gòu)設(shè)計(jì)概述系統(tǒng)邊界[定義系統(tǒng)和其它系統(tǒng)間功效、業(yè)務(wù)和數(shù)據(jù)邊界]系統(tǒng)架構(gòu)[用系統(tǒng)架構(gòu)圖描述本系統(tǒng)基礎(chǔ)結(jié)構(gòu)，關(guān)鍵包含直接組成系統(tǒng)各個(gè)組件。相對(duì)細(xì)致描述各個(gè)組件之間和系統(tǒng)和系統(tǒng)之間連接和通信關(guān)系]功效架構(gòu)[用功效結(jié)構(gòu)圖和文字方法描述系統(tǒng)關(guān)鍵功效和功效之間關(guān)系]技術(shù)架構(gòu)[用技術(shù)架構(gòu)圖和文字方法描述系統(tǒng)所采取技術(shù)路線和系統(tǒng)分層結(jié)構(gòu)關(guān)系]布署架構(gòu)及軟硬件配置布署架構(gòu)[描述系統(tǒng)拓?fù)浣Y(jié)構(gòu)，包含應(yīng)用服務(wù)器、數(shù)據(jù)庫(kù)服務(wù)器、數(shù)據(jù)交換服務(wù)器等在物理上拓?fù)浣Y(jié)構(gòu)。]硬件配置方案[用列表形式說明系統(tǒng)硬件需求，關(guān)鍵包含硬件具體配置，用途、數(shù)量]軟件配置方案[用列表形式說明系統(tǒng)軟件需求，關(guān)鍵包含軟件具體配置，用途、數(shù)量]功效設(shè)計(jì)模塊1設(shè)計(jì)說明[從本章開始，逐一地給出各個(gè)層次中每個(gè)模塊設(shè)計(jì)考慮。以下給出提要是針對(duì)通常情況。對(duì)于一個(gè)具體模塊，尤其是層次比較低模塊或子程序，其很多條目標(biāo)內(nèi)容往往和它所隸屬上一層模塊對(duì)應(yīng)條目標(biāo)內(nèi)容相同，在這種情況下，只要簡(jiǎn)單地說明這幾點(diǎn)即可。]模塊描述[給出對(duì)該模塊基礎(chǔ)描述，關(guān)鍵說明設(shè)計(jì)本模塊對(duì)應(yīng)關(guān)鍵需求，建設(shè)目標(biāo)意義、建設(shè)關(guān)鍵內(nèi)容、模塊特點(diǎn)等]功效說明[說明該基礎(chǔ)模塊應(yīng)含有功效,用列表形式列出該模塊關(guān)鍵功效點(diǎn)，并描述各個(gè)功效點(diǎn)簡(jiǎn)明說明]以下圖所表示：原型界面界面ID功效概述狀態(tài)評(píng)價(jià)計(jì)劃管理PM00001實(shí)現(xiàn)實(shí)狀況態(tài)評(píng)價(jià)計(jì)劃查詢，修改，刪除等功效步驟描述[用圖表輔以必需說明來表示本模塊邏輯步驟，能夠用Visio繪制步驟圖、或用活動(dòng)圖等圖形形式來描述，也能夠使用UML工具構(gòu)建]該部分需要根據(jù)模塊業(yè)務(wù)步驟進(jìn)行具體描述相關(guān)算法[對(duì)于使用到特殊或復(fù)雜算法，應(yīng)具體說明算法計(jì)算公式及計(jì)算步驟，和實(shí)現(xiàn)方法等]性能功效點(diǎn)ID估計(jì)最大數(shù)據(jù)量響應(yīng)時(shí)間要求性能瓶頸點(diǎn)處理該問題關(guān)鍵技術(shù)點(diǎn)[說明對(duì)該模塊性能要求，如定義多大數(shù)據(jù)量下，該模塊響應(yīng)時(shí)間，該性能定義也將作為系統(tǒng)開發(fā)完成后測(cè)試項(xiàng)目]限制條件[說明本模塊在運(yùn)行使用中所受到限制條件。]還未處理問題

說明在本程序設(shè)計(jì)中還未處理而設(shè)計(jì)者認(rèn)為在軟件完成之前應(yīng)處理問題權(quán)限設(shè)計(jì)表述角色定義，功效權(quán)限、數(shù)據(jù)權(quán)限分組。外部接口設(shè)計(jì)XXXX接口接口函數(shù)名：XXXX(stringstrxxx）接口頻度：[多長(zhǎng)時(shí)間同時(shí)一次]接口方法：[采取哪種方法實(shí)現(xiàn)該接口，如webservices等，是手動(dòng)或自動(dòng)同時(shí)]參數(shù)strxxx：[參數(shù)內(nèi)容說明]返回值：[返回值定義]Exception：[返回錯(cuò)誤代碼定義,可參見消息定義]功效描述：功效描述接口字段名英文名長(zhǎng)度類型必傳內(nèi)容說明設(shè)備類型編碼FeatureType字符●PAC該部分內(nèi)容能夠?yàn)樯蒍avaDoc提供依據(jù)數(shù)據(jù)庫(kù)設(shè)計(jì)【數(shù)據(jù)庫(kù)設(shè)計(jì)內(nèi)容關(guān)鍵給出數(shù)據(jù)庫(kù)E-R圖實(shí)例，并能生成數(shù)據(jù)庫(kù)建庫(kù)腳本】非功效設(shè)計(jì)性能設(shè)計(jì)【描述我們可能碰到慢操作和查詢和任何提升她們速度？我們所面臨大數(shù)據(jù)量操作是什么？假如提升性能策略？（比如：建立數(shù)據(jù)庫(kù)索引、數(shù)據(jù)分區(qū)、數(shù)據(jù)緩存）等】事務(wù)處理【系統(tǒng)事務(wù)處理策略和方法】錯(cuò)誤處理【怎樣處理應(yīng)用系統(tǒng)和系統(tǒng)所產(chǎn)生錯(cuò)誤？怎樣校驗(yàn)用戶輸入？假如顯示錯(cuò)誤提醒？假如統(tǒng)計(jì)日志供系統(tǒng)管理員分析？假如預(yù)防系統(tǒng)瓦解？】日志處理和日志分析【用戶操作日志怎樣處理？】安全設(shè)計(jì)[從物理設(shè)備、網(wǎng)絡(luò)層保護(hù)、操作系統(tǒng)安全防護(hù)，數(shù)據(jù)安全防護(hù)、應(yīng)用層安全防護(hù)五個(gè)方面分別敘述怎樣保障系統(tǒng)安全運(yùn)行]信息定義消息ID消息類型消息內(nèi)容參數(shù)說明I00001Info更新完成W00001WarningE0000