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

1、-. z.概要設(shè)計(jì)說(shuō)明書V.*文檔狀態(tài)：文檔標(biāo)識(shí)：*-SD- 草稿 正式發(fā)布 修改編撰：編撰日期：級(jí)別：文檔版本：*-. z.修訂歷史記錄日期版本說(shuō)明作者-. z.目錄 TOC o 1-3 h z u HYPERLINK l _Toc2926406861引言 PAGEREF _Toc292640686 h 1HYPERLINK l _Toc2926406871.1編寫目的 PAGEREF _Toc292640687 h 1HYPERLINK l _Toc2926406881.2背景 PAGEREF _Toc292640688 h 1HYPERLINK l _Toc2926406891.3定義

2、PAGEREF _Toc292640689 h 1HYPERLINK l _Toc2926406901.4參考資料 PAGEREF _Toc292640690 h 1HYPERLINK l _Toc2926406912設(shè)計(jì)概要 PAGEREF _Toc292640691 h 1HYPERLINK l _Toc2926406922.1設(shè)計(jì)圍 PAGEREF _Toc292640692 h 1HYPERLINK l _Toc2926406932.2設(shè)計(jì)目標(biāo) PAGEREF _Toc292640693 h 1HYPERLINK l _Toc2926406942.3設(shè)計(jì)原則 PAGEREF _Toc2

3、92640694 h 1HYPERLINK l _Toc2926406953架構(gòu)設(shè)計(jì) PAGEREF _Toc292640695 h 2HYPERLINK l _Toc2926406963.1概述 PAGEREF _Toc292640696 h 2HYPERLINK l _Toc2926406973.2系統(tǒng)邊界 PAGEREF _Toc292640697 h 2HYPERLINK l _Toc2926406983.3系統(tǒng)架構(gòu) PAGEREF _Toc292640698 h 2HYPERLINK l _Toc2926406993.4功能架構(gòu) PAGEREF _Toc292640699 h 2HY

4、PERLINK l _Toc2926407003.5技術(shù)架構(gòu) PAGEREF _Toc292640700 h 2HYPERLINK l _Toc2926407013.6部署架構(gòu)及軟硬件配置 PAGEREF _Toc292640701 h 2HYPERLINK l _Toc292640702 部署架構(gòu) PAGEREF _Toc292640702 h 2HYPERLINK l _Toc292640703 硬件配置方案 PAGEREF _Toc292640703 h 2HYPERLINK l _Toc292640704 軟件配置方案 PAGEREF _Toc292640704 h 2HYPERLIN

5、K l _Toc2926407054功能設(shè)計(jì) PAGEREF _Toc292640705 h 3HYPERLINK l _Toc2926407064.1模塊1設(shè)計(jì)說(shuō)明 PAGEREF _Toc292640706 h 3HYPERLINK l _Toc292640707 模塊描述 PAGEREF _Toc292640707 h 3HYPERLINK l _Toc292640708 功能說(shuō)明 PAGEREF _Toc292640708 h 3HYPERLINK l _Toc292640709 流程描述 PAGEREF _Toc292640709 h 3HYPERLINK l _Toc2926407

6、10 相關(guān)算法 PAGEREF _Toc292640710 h 4HYPERLINK l _Toc292640711 性能 PAGEREF _Toc292640711 h 4HYPERLINK l _Toc292640712 限制條件 PAGEREF _Toc292640712 h 4HYPERLINK l _Toc292640713 尚未解決的問(wèn)題 PAGEREF _Toc292640713 h 4HYPERLINK l _Toc2926407145權(quán)限設(shè)計(jì) PAGEREF _Toc292640714 h 4HYPERLINK l _Toc2926407156外部接口設(shè)計(jì) PAGEREF _

7、Toc292640715 h 5HYPERLINK l _Toc2926407166.1*接口 PAGEREF _Toc292640716 h 5HYPERLINK l _Toc2926407177數(shù)據(jù)庫(kù)設(shè)計(jì) PAGEREF _Toc292640717 h 5HYPERLINK l _Toc2926407188非功能設(shè)計(jì) PAGEREF _Toc292640718 h 5HYPERLINK l _Toc2926407198.1性能設(shè)計(jì) PAGEREF _Toc292640719 h 5HYPERLINK l _Toc2926407208.2事務(wù)處理PAGEREF _Toc292640720 h

8、 6HYPERLINK l _Toc2926407218.3錯(cuò)誤處理 PAGEREF _Toc292640721 h 6HYPERLINK l _Toc2926407228.4日志處理和日志分析 PAGEREF _Toc292640722 h 6HYPERLINK l _Toc2926407238.5平安設(shè)計(jì) PAGEREF _Toc292640723 h 6HYPERLINK l _Toc2926407249信息定義 PAGEREF _Toc292640724 h 6HYPERLINK l _Toc29264072510風(fēng)險(xiǎn)管理 PAGEREF _Toc292640725 h 6HYPERL

9、INK l _Toc29264072610.1技術(shù)風(fēng)險(xiǎn) PAGEREF _Toc292640726 h 6HYPERLINK l _Toc29264072711遵循標(biāo)準(zhǔn)與規(guī) PAGEREF _Toc292640727 h 7-. z.引言編寫目的說(shuō)明編寫這份設(shè)計(jì)說(shuō)明書的目的，指出預(yù)期的讀者。背景列出本工程的任務(wù)提出者、開(kāi)發(fā)者、用戶，提出的緣由，現(xiàn)狀分析等定義列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。參考資料列出有關(guān)的參考資料。設(shè)計(jì)概要設(shè)計(jì)圍說(shuō)明本文檔設(shè)計(jì)所包括的容，如功能、接口描述設(shè)計(jì)目標(biāo)從通過(guò)本次設(shè)計(jì)能夠解決那些問(wèn)題，到達(dá)什么樣的效果設(shè)計(jì)原則針對(duì)本工程說(shuō)明系統(tǒng)設(shè)計(jì)所要遵循的相

10、應(yīng)的原則，如標(biāo)準(zhǔn)化、模塊化等，并做詳細(xì)說(shuō)明架構(gòu)設(shè)計(jì)概述系統(tǒng)邊界定義系統(tǒng)與其他系統(tǒng)間的功能、業(yè)務(wù)和數(shù)據(jù)邊界系統(tǒng)架構(gòu)用系統(tǒng)架構(gòu)圖描述本系統(tǒng)根本的構(gòu)造，主要包括直接構(gòu)成系統(tǒng)的各個(gè)組件。相對(duì)細(xì)致的描述各個(gè)組件之間和系統(tǒng)與系統(tǒng)之間的連接以及通信關(guān)系功能架構(gòu)用功能構(gòu)造圖和文字的方式描述系統(tǒng)的主要功能以及功能之間的關(guān)系技術(shù)架構(gòu)用技術(shù)架構(gòu)圖和文字的方式描述系統(tǒng)所采用的技術(shù)路線以及系統(tǒng)的分層構(gòu)造關(guān)系部署架構(gòu)及軟硬件配置部署架構(gòu)描述系統(tǒng)的拓?fù)錁?gòu)造，包括應(yīng)用效勞器、數(shù)據(jù)庫(kù)效勞器、數(shù)據(jù)交換效勞器等在物理上的拓?fù)錁?gòu)造。硬件配置方案用列表的形式說(shuō)明系統(tǒng)的硬件需求，主要包括硬件的詳細(xì)配置，用途、數(shù)量軟件配置方案用列表的形式

11、說(shuō)明系統(tǒng)的軟件需求，主要包括軟件的詳細(xì)配置，用途、數(shù)量功能設(shè)計(jì)模塊1設(shè)計(jì)說(shuō)明從本章開(kāi)場(chǎng)，逐個(gè)地給出各個(gè)層次中的每個(gè)模塊的設(shè)計(jì)考慮。以下給出的提綱是針對(duì)一般情況的。對(duì)于一個(gè)具體的模塊，尤其是層次比擬低的模塊或子程序，其很多條目的容往往與它所隸屬的上一層模塊的對(duì)應(yīng)條目的容一樣，在這種情況下，只要簡(jiǎn)單地說(shuō)明這幾點(diǎn)即可。模塊描述給出對(duì)該模塊的根本描述，主要說(shuō)明設(shè)計(jì)本模塊對(duì)應(yīng)的主要需求，建立目的意義、建立的主要容、模塊的特點(diǎn)等功能說(shuō)明說(shuō)明該根本模塊應(yīng)具有的功能,用列表的形式列出該模塊的主要的功能點(diǎn)，并描述各個(gè)功能點(diǎn)的簡(jiǎn)要說(shuō)明如下列圖所示：狀態(tài)評(píng)價(jià)方案管理PM00001實(shí)現(xiàn)狀態(tài)評(píng)價(jià)方案的查詢，修改，刪除等

12、功能流程描述用圖表輔以必要的說(shuō)明來(lái)表示本模塊的邏輯流程，可以用Visio繪制流程圖、或者用活動(dòng)圖等圖形形式來(lái)描述，也可以使用UML工具構(gòu)建該局部需要按照模塊業(yè)務(wù)流程進(jìn)展詳細(xì)描述相關(guān)算法對(duì)于使用到特殊或者復(fù)雜算法，應(yīng)具體的說(shuō)明算法的計(jì)算公式及計(jì)算步驟，以及實(shí)現(xiàn)的方式等性能功能點(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è)試工程限制條件說(shuō)明本模塊在運(yùn)行使用中所受到的限制條件。尚未解決的問(wèn)題 說(shuō)明在本程序的設(shè)計(jì)未解決而設(shè)計(jì)者認(rèn)為在軟件完成之前應(yīng)解決的問(wèn)題 權(quán)限設(shè)計(jì)表述角色定義，功能

13、權(quán)限、數(shù)據(jù)權(quán)限分組。外部接口設(shè)計(jì)*接口接口函數(shù)名：*(string str*接口頻度：多長(zhǎng)時(shí)間同步一次接口方式：采用哪種方式實(shí)現(xiàn)該接口，如webservices等，是手動(dòng)或者自動(dòng)同步參數(shù)str*：參數(shù)容說(shuō)明返回值：返回值定義E*ception：返回的錯(cuò)誤代碼定義,可參見(jiàn)消息定義功能描述：功能描述接口字段名英文名長(zhǎng)度類型必傳容說(shuō)明設(shè)備類型編碼FeatureType 字符PAC該局部容可以為生成JavaDoc提供依據(jù)數(shù)據(jù)庫(kù)設(shè)計(jì)【數(shù)據(jù)庫(kù)設(shè)計(jì)容主要給出數(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)管理員分析？如果防止系統(tǒng)的崩潰？】日志處理和日志分析【用戶操作的日志如何處理？】平安設(shè)計(jì) 從物理設(shè)備、網(wǎng)絡(luò)層的保護(hù)、操