模板-PP-04+架構(gòu)設(shè)計(jì)說(shuō)明書(shū)

1、模板-PP-04 架構(gòu)設(shè)計(jì)說(shuō)明書(shū)架構(gòu)設(shè)計(jì)說(shuō)明書(shū) 架構(gòu)設(shè)計(jì)說(shuō)明書(shū) 引言o 編寫(xiě)目的o 系統(tǒng)目標(biāo)o 術(shù)語(yǔ)和縮寫(xiě)詞定義o 參考資料 需求規(guī)定o 系統(tǒng)功能o 系統(tǒng)性能o 故障處理要求o 軟硬件要求o 其他需求限制條件 總體結(jié)構(gòu)設(shè)計(jì)o 系統(tǒng)體系結(jié)構(gòu)o 系統(tǒng)開(kāi)發(fā)的基礎(chǔ)平臺(tái)和關(guān)鍵組件 外部基礎(chǔ)平臺(tái)和關(guān)鍵組件 內(nèi)部基礎(chǔ)平臺(tái)和關(guān)鍵組件o 總體結(jié)構(gòu) 子系統(tǒng)設(shè)計(jì)o 功能結(jié)構(gòu)圖/類圖o 功能定義o 功能需求與系統(tǒng)模塊的關(guān)系 接口設(shè)計(jì)o 用戶接口o 外部接口o 內(nèi)部接口 系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)o 邏輯結(jié)構(gòu)設(shè)計(jì)o 物理結(jié)構(gòu)設(shè)計(jì)o 配置文件結(jié)構(gòu)設(shè)計(jì)o 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系 算法設(shè)計(jì) 運(yùn)行設(shè)計(jì)o 運(yùn)行模塊組合o 運(yùn)行控制o 運(yùn)行時(shí)

2、間 系統(tǒng)安全o 系統(tǒng)安全o 數(shù)據(jù)安全o 備份與恢復(fù)o 出錯(cuò)處理 系統(tǒng)維護(hù)設(shè)計(jì) 系統(tǒng)部署o 軟硬件環(huán)境o 系統(tǒng)部署o 系統(tǒng)升級(jí) 遺留問(wèn)題 需要模塊設(shè)計(jì)文檔的模塊清單引言編寫(xiě)目的說(shuō)明編寫(xiě)這份架構(gòu)設(shè)計(jì)說(shuō)明書(shū)的目的，指出預(yù)期的讀者。系統(tǒng)目標(biāo)本系統(tǒng)要達(dá)成的目標(biāo)，應(yīng)描述架構(gòu)設(shè)計(jì)的細(xì)度及為下一步模塊設(shè)計(jì)提供的支持。術(shù)語(yǔ)和縮寫(xiě)詞定義列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。參考資料列出與本文密切相關(guān)的參考資料，可能包含如下內(nèi)容： 本項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同、上級(jí)主管的批文； 屬于本項(xiàng)目的其它已發(fā)表的文件； 本文件中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文

3、件編號(hào)、發(fā)表日期和出版單位，說(shuō)明如何能夠得到這些資料。需求規(guī)定說(shuō)明影響架構(gòu)設(shè)計(jì)的系統(tǒng)主要功能、輸入輸出、性能要求等的需求限制條件。系統(tǒng)功能系統(tǒng)的功能性需求，主要列出對(duì)架構(gòu)設(shè)計(jì)產(chǎn)品影響的典型功能要求、數(shù)據(jù)要求、輸入輸出要求和界面要求等。系統(tǒng)性能主要包括 數(shù)據(jù)精度 執(zhí)行效率 數(shù)據(jù)處理能力等的要求。故障處理要求系統(tǒng)出現(xiàn)故障時(shí)的處理機(jī)制，比如：故障轉(zhuǎn)移等。軟硬件要求軟件需求規(guī)格中規(guī)定必須支持的軟硬件環(huán)境。其他需求限制條件包括： 事先約定必須要使用的商業(yè)上架系統(tǒng)/組件（比如：必須在MS Office上做二次開(kāi)發(fā)）； 必須應(yīng)用的技術(shù)（比如：必須使用B/S結(jié)構(gòu)）； 必須要與某商業(yè)軟件做接口（比如：必須與用友

4、軟件做接口）； 與舊版本的兼容升級(jí)關(guān)系等總體結(jié)構(gòu)設(shè)計(jì)系統(tǒng)體系結(jié)構(gòu)確定系統(tǒng)采用何種體系結(jié)構(gòu)，如： 單機(jī)版還是網(wǎng)絡(luò)版？ C/S結(jié)構(gòu)還是B/S結(jié)構(gòu)？ 兩層結(jié)構(gòu)還是多層結(jié)構(gòu)？ 分布式數(shù)據(jù)庫(kù)還是集中式數(shù)據(jù)庫(kù)？ 分布式應(yīng)用程序服務(wù)器還是集中式應(yīng)用程序服務(wù)器？ 是采用.Net應(yīng)用程序框架還是J2EE應(yīng)用程序框架？系統(tǒng)開(kāi)發(fā)的基礎(chǔ)平臺(tái)和關(guān)鍵組件外部基礎(chǔ)平臺(tái)和關(guān)鍵組件確定系統(tǒng)開(kāi)發(fā)的外部基礎(chǔ)平臺(tái)和關(guān)鍵組件，如： 是在Windows平臺(tái)、Unix平臺(tái)或者Linux平臺(tái)上開(kāi)發(fā)？還是平臺(tái)無(wú)關(guān)性？ 是否是在某些軟件上作二次開(kāi)發(fā)？如AutoCAD。 是否采用一些第三方的關(guān)鍵組件。內(nèi)部基礎(chǔ)平臺(tái)和關(guān)鍵組件確定系統(tǒng)開(kāi)發(fā)所使用的公司

5、內(nèi)部開(kāi)發(fā)平臺(tái)、組件/控件、公共函數(shù)/單元等公共資源，如： 是否在GSP平臺(tái)上開(kāi)發(fā)； 是否采用公司的報(bào)表控件； 是否復(fù)用公司其他產(chǎn)品的架構(gòu)或資源等。總體結(jié)構(gòu)給出系統(tǒng)結(jié)構(gòu)總體框圖（包括軟件、硬件結(jié)構(gòu)框圖），說(shuō)明本系統(tǒng)的各模塊的劃分，扼要說(shuō)明每個(gè)系統(tǒng)模塊的標(biāo)識(shí)符和功能，分層次地給出各模塊之間的控制與被控制關(guān)系。如果采用結(jié)構(gòu)化分析方法，通常采用下面兩種模型來(lái)描述總體結(jié)構(gòu)： 結(jié)構(gòu)圖（層次圖）：對(duì)系統(tǒng)自頂向下進(jìn)行分解。 系統(tǒng)流程圖：描述子系統(tǒng)內(nèi)部的控制流和數(shù)據(jù)流如果采用面向?qū)ο蟮姆治龇椒?，通常采用?package)圖來(lái)描述總體結(jié)構(gòu)。包(package)圖描述了子系統(tǒng)之間的包含關(guān)系和依賴關(guān)系。子系統(tǒng)設(shè)計(jì)在

6、總體結(jié)構(gòu)設(shè)計(jì)中已經(jīng)將系統(tǒng)劃分為若干個(gè)子系統(tǒng)，在此需要對(duì)所有的子系統(tǒng)進(jìn)行設(shè)計(jì)。一般應(yīng)包括下列內(nèi)容。功能結(jié)構(gòu)圖/類圖結(jié)構(gòu)化設(shè)計(jì)：對(duì)結(jié)構(gòu)圖進(jìn)行細(xì)化，分解到功能一級(jí)。面向?qū)ο笤O(shè)計(jì)：對(duì)包（package）圖進(jìn)行細(xì)化，確定各包中包含的類。功能定義說(shuō)明上一步分解的所有功能組件（功能模塊或者類）的功能。序號(hào)功能/類名稱功能描述12功能需求與系統(tǒng)模塊的關(guān)系本條用一張矩陣圖說(shuō)明各項(xiàng)功能需求的實(shí)現(xiàn)同各模塊的分配關(guān)系，用來(lái)實(shí)現(xiàn)RTM（需求跟蹤）表，如果已經(jīng)采用了外部工具來(lái)做，此處可以省略。 需求跟蹤表系統(tǒng)模塊1系統(tǒng)模塊2系統(tǒng)模塊m功能需求1功能需求2功能需求n接口設(shè)計(jì)用戶接口說(shuō)明將向用戶提供的命令和它們的語(yǔ)法結(jié)構(gòu)，以

7、及相應(yīng)的回答信息。例如：腳本命令語(yǔ)法等。外部接口說(shuō)明本系統(tǒng)同外界的所有接口的安排包括： 軟件與硬件之間的接口； 本系統(tǒng)與各支持系統(tǒng)之間的接口； 本系統(tǒng)支持?jǐn)U展性預(yù)留的外部接口及擴(kuò)展的方式。 如果需要對(duì)外提供API接口，列出API接口。內(nèi)部接口說(shuō)明本系統(tǒng)之內(nèi)的各個(gè)系統(tǒng)模塊或元素之間的接口的安排，包括： 系統(tǒng)涉及的全局變量與接口函數(shù)； 本系統(tǒng)支持?jǐn)U展性預(yù)留的內(nèi)部擴(kuò)展點(diǎn)及擴(kuò)展的方式等。系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)數(shù)據(jù)庫(kù)結(jié)構(gòu)設(shè)計(jì)遵循數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)范，此規(guī)范文檔單獨(dú)提供。邏輯結(jié)構(gòu)設(shè)計(jì)給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)的名稱、標(biāo)識(shí)符以及它們之中每個(gè)數(shù)據(jù)項(xiàng)、記錄、文卷和系的標(biāo)識(shí)、定義、長(zhǎng)度及它們之間的層次的或表格的相互關(guān)系

8、。物理結(jié)構(gòu)設(shè)計(jì)給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)中的每個(gè)數(shù)據(jù)項(xiàng)的存儲(chǔ)要求，訪問(wèn)方法、存取單位、存取的物理關(guān)系、設(shè)計(jì)考慮和保密條件。配置文件結(jié)構(gòu)設(shè)計(jì)給出本系統(tǒng)內(nèi)所使用的每個(gè)配置文件中數(shù)據(jù)結(jié)構(gòu)中的每個(gè)數(shù)據(jù)項(xiàng)的存儲(chǔ)要求，訪問(wèn)方法、具體的含義和設(shè)計(jì)考慮等。數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系說(shuō)明各個(gè)數(shù)據(jù)結(jié)構(gòu)與訪問(wèn)這些數(shù)據(jù)結(jié)構(gòu)的各個(gè)程序之間的對(duì)應(yīng)關(guān)系。模塊1模塊2模塊m數(shù)據(jù)結(jié)構(gòu)1數(shù)據(jù)結(jié)構(gòu)2數(shù)據(jù)結(jié)構(gòu)n算法設(shè)計(jì)算法設(shè)計(jì)也可以在詳細(xì)設(shè)計(jì)或?qū)崿F(xiàn)階段進(jìn)行；對(duì)涉及到大量數(shù)據(jù)運(yùn)算和實(shí)時(shí)性要求高的組件，需對(duì)將采用的算法進(jìn)行闡述、論證，以確保合理使用系統(tǒng)資源、滿足需求規(guī)格說(shuō)明書(shū)中的系統(tǒng)性能要求。運(yùn)行設(shè)計(jì)運(yùn)行設(shè)計(jì)主要考慮軟件在對(duì)外發(fā)布時(shí)所提

9、供的根據(jù)用戶特點(diǎn)的定制能力。比如：通過(guò)修改配置文件來(lái)顯示或隱藏某些模塊，通過(guò)修改配置文件來(lái)組合某些模塊等運(yùn)行模塊組合說(shuō)明對(duì)系統(tǒng)施加不同的外界運(yùn)行控制時(shí)所引起的各種不同的運(yùn)行模塊組合，說(shuō)明每種運(yùn)行所歷經(jīng)的內(nèi)部模塊的支持軟件。模塊集合運(yùn)行條件支持軟件運(yùn)行控制說(shuō)明每一種外界的運(yùn)行控制的方式方法和操作步驟。運(yùn)行名稱控制方法操作步驟運(yùn)行時(shí)間說(shuō)明每種運(yùn)行模塊組合將占用各種資源的時(shí)間，此項(xiàng)一般可以省略。運(yùn)行名稱所占資源時(shí)間系統(tǒng)安全系統(tǒng)安全1系統(tǒng)安全控制和物理保護(hù)措施，比如：程序加密（軟件鎖）。；2用戶身份鑒別機(jī)制；3用戶對(duì)系統(tǒng)的訪問(wèn)權(quán)限和范圍。數(shù)據(jù)安全根據(jù)需求規(guī)格說(shuō)明書(shū)中的系統(tǒng)保密要求，對(duì)系統(tǒng)進(jìn)入及數(shù)據(jù)保密

10、功能進(jìn)行設(shè)計(jì)。通常指：數(shù)據(jù)加密、數(shù)據(jù)用戶身份鑒別、數(shù)據(jù)庫(kù)本身的安全（比如異常情況的數(shù)據(jù)保護(hù)、并發(fā)控制）等。備份與恢復(fù)1數(shù)據(jù)備份；2數(shù)據(jù)恢復(fù)；3恢復(fù)及再啟動(dòng)技術(shù)。說(shuō)明將使用的恢復(fù)再啟動(dòng)技術(shù)，使軟件從故障點(diǎn)恢復(fù)執(zhí)行或使軟件從頭開(kāi)始重新運(yùn)行的方法。出錯(cuò)處理1. 出錯(cuò)的情況；2. 出錯(cuò)時(shí)信息輸出的形式、信息的含義和反饋處理方法；3. 出錯(cuò)失效后的后備處理措施。系統(tǒng)維護(hù)設(shè)計(jì)維護(hù)功能是系統(tǒng)的重要組成部分，應(yīng)提供系統(tǒng)維護(hù)和管理的方法和工具。此處說(shuō)明為了系統(tǒng)維護(hù)的方便而在程序內(nèi)部設(shè)計(jì)中作出的安排，包括在程序中專門安排用于系統(tǒng)檢查與維護(hù)的檢測(cè)點(diǎn)和專用模塊及工具。系統(tǒng)部署軟硬件環(huán)境列出運(yùn)行該軟件所需要的軟硬設(shè)備及其專門功能，如果是多層結(jié)構(gòu)需要分別列出各層所需的軟硬件環(huán)境。系統(tǒng)部署列出系統(tǒng)