系統(tǒng)概要設(shè)計說明文書~模板

1、XXX概要設(shè)計說明書（v.xxx）文檔狀態(tài)：文檔標識：XXX-SD-V 草稿正式發(fā)布修改編撰：編撰日期：級別：文檔版本：XXXXX修訂歷史記錄日期版本說明作者目錄 TOC o 1-5 h z 引言 1編寫目的 1背景 1定義 1參考資料 1設(shè)計概要 1設(shè)計圍 1設(shè)計目標 1設(shè)計原則 1 HYPERLINK l bookmark4 o Current Document 架構(gòu)設(shè)計 2概述 2系統(tǒng)邊界 2系統(tǒng)架構(gòu) 2功能架構(gòu) 2技術(shù)架構(gòu) 2部署架構(gòu)及軟硬件配置 2部署架構(gòu) 2硬件配置方案 2軟件配置方案 2 HYPERLINK l bookmark6 o Current Document 功能設(shè)計

2、3模塊 1設(shè)計說明 3 HYPERLINK l bookmark8 o Current Document 模塊描述 3 HYPERLINK l bookmark10 o Current Document 功能說明 3 HYPERLINK l bookmark12 o Current Document 流程描述 3相關(guān)算法 4性能 4限制條件 4尚未解決的問題 4權(quán)限設(shè)計 5外部接口設(shè)計 5XXXX 接口 5數(shù)據(jù)庫設(shè)計 5非功能設(shè)計 6性能設(shè)計 6事務(wù)處理 6錯誤處理 6日志處理和日志分析 6安全設(shè)計 6信息定義 6風(fēng)險管理 7技術(shù)風(fēng)險 7遵循標準與規(guī) 7引言編寫目的 TOC o 1-5 h z

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

4、統(tǒng)之間的連接以及通信關(guān)系 功能架構(gòu) 用功能結(jié)構(gòu)圖和文字的方式描述系統(tǒng)的主要功能以及功能之間的關(guān)系技術(shù)架構(gòu) 用技術(shù)架構(gòu)圖和文字的方式描述系統(tǒng)所采用的技術(shù)路線以及系統(tǒng)的分層結(jié)構(gòu)關(guān)系部署架構(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 模塊1設(shè)計說明從本章開始，逐個地給出各個層次中的每個模塊的設(shè)計考慮。以下給出的提綱是針對 一般情況的。對于一個具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的容 往往與它所隸屬的上一層模塊的對應(yīng)條目的容相同，在這種情況下，只要簡單地說明這幾 點即可。4.1.1模塊描述給出對該模塊的基本描述，主要說明設(shè)計本模塊對應(yīng)的主要需求，建設(shè)目的意義、建 設(shè)的主要容、模塊的特點等 4.1.2功能說明說明該基本模塊應(yīng)具有的功能 ，用列表的形式列出該模塊的主要的功能點，并描述各 個功能點的簡要說明如下圖所示：原型界面界面ID功能概述狀態(tài)評價計劃管理PM00001實現(xiàn)狀態(tài)評價計劃的查詢，修改，刪除等功能4.1.3流程描述用圖表輔以必