架構(gòu)設(shè)計說明書

架構(gòu)設(shè)計闡明書項目名稱：[項目名稱]項目代號：[項目代號]編制人：[編制人]編制日期：[編制日期]

修訂統(tǒng)計版本日期撰寫/修訂人備注/修訂內(nèi)容

目錄TOC\o架構(gòu)設(shè)計闡明書 11. 引言 5. 編寫目的 5. 系統(tǒng)目的 5. 術(shù)語和縮寫詞定義 5. 參考資料 52. 需求規(guī)定 5. 系統(tǒng)功效 5. 系統(tǒng)性能 5. 故障解決規(guī)定 6. 軟硬件規(guī)定 6. 其它需求限制條件 63. 總體構(gòu)造設(shè)計 6. 系統(tǒng)體系構(gòu)造 6. 系統(tǒng)開發(fā)的基礎(chǔ)平臺和核心組件 6 外部基礎(chǔ)平臺和核心組件 6 內(nèi)部基礎(chǔ)平臺和核心組件 7. 總體構(gòu)造 74. 子系統(tǒng)設(shè)計 7. 功效構(gòu)造圖/類圖 7. 功效定義 7. 功效需求與系統(tǒng)模塊的關(guān)系 85. 接口設(shè)計 8. 顧客接口 8. 外部接口 8. 內(nèi)部接口 86. 系統(tǒng)數(shù)據(jù)構(gòu)造設(shè)計 8. 邏輯構(gòu)造設(shè)計 9. 物理構(gòu)造設(shè)計 9. 配備文獻構(gòu)造設(shè)計 9. 數(shù)據(jù)構(gòu)造與程序的關(guān)系 97. 算法設(shè)計 98. 運行設(shè)計 9. 運行模塊組合 10. 運行控制 10. 運行時間 109. 系統(tǒng)安全 10. 系統(tǒng)安全 10. 數(shù)據(jù)安全 10. 備份與恢復(fù) 10. 出錯解決 1110. 系統(tǒng)維護設(shè)計 1111. 系統(tǒng)布署 11. 軟硬件環(huán)境 11. 系統(tǒng)布署 11. 系統(tǒng)升級 1112. 遺留問題 11

引言編寫目的闡明編寫這份架構(gòu)設(shè)計闡明書的目的，指出預(yù)期的讀者。系統(tǒng)目的本系統(tǒng)要達成的目的，應(yīng)描述架構(gòu)設(shè)計的細度及為下一步模塊設(shè)計提供的支持。術(shù)語和縮寫詞定義列出本文獻中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。參考資料列出與本文親密有關(guān)的參考資料，可能包含以下內(nèi)容：本項目經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級主管的批文；屬于本項目的其它已發(fā)表的文獻；本文獻中各處引用的文獻、資料，涉及所要用到的軟件開發(fā)原則。列出這些文獻資料的標(biāo)題、文獻編號、發(fā)表日期和出版單位，闡明如何能夠得到這些資料。需求規(guī)定闡明影響架構(gòu)設(shè)計的系統(tǒng)重要功效、輸入輸出、性能規(guī)定等的需求限制條件。系統(tǒng)功效系統(tǒng)的功效性需求，重要列出對架構(gòu)設(shè)計產(chǎn)品影響的典型功效規(guī)定、數(shù)據(jù)規(guī)定、輸入輸出規(guī)定和界面規(guī)定等。系統(tǒng)性能重要涉及數(shù)據(jù)精度執(zhí)行效率數(shù)據(jù)解決能力等的規(guī)定。故障解決規(guī)定系統(tǒng)出現(xiàn)故障時的解決機制，例如：故障轉(zhuǎn)移等。軟硬件規(guī)定軟件需求規(guī)格中規(guī)定必須支持的軟硬件環(huán)境。其它需求限制條件涉及：事先商定必須要使用的商業(yè)上架系統(tǒng)/組件（例如：必須在MSOffice上做二次開發(fā)）；必須應(yīng)用的技術(shù)（例如：必須使用B/S構(gòu)造）；必須要與某商業(yè)軟件做接口（例如：必須與用友軟件做接口）；與舊版本的兼容升級關(guān)系等總體構(gòu)造設(shè)計系統(tǒng)體系構(gòu)造擬定系統(tǒng)采用何種體系構(gòu)造，如：單機版還是網(wǎng)絡(luò)版？C/S構(gòu)造還是B/S構(gòu)造？兩層構(gòu)造還是多層構(gòu)造？分布式數(shù)據(jù)庫還是集中式數(shù)據(jù)庫？分布式應(yīng)用程序服務(wù)器還是集中式應(yīng)用程序服務(wù)器？是采用.Net應(yīng)用程序框架還是J2EE應(yīng)用程序框架？系統(tǒng)開發(fā)的基礎(chǔ)平臺和核心組件外部基礎(chǔ)平臺和核心組件擬定系統(tǒng)開發(fā)的外部基礎(chǔ)平臺和核心組件，如：是在Windows平臺、Unix平臺或者Linux平臺上開發(fā)？還是平臺無關(guān)性？與否是在某些軟件上作二次開發(fā)？如AutoCAD。與否采用某些第三方的核心組件。內(nèi)部基礎(chǔ)平臺和核心組件擬定系統(tǒng)開發(fā)所使用的公司內(nèi)部開發(fā)平臺、組件/控件、公共函數(shù)/單元等公共資源，如：與否在GSP平臺上開發(fā)；與否采用公司的報表控件；與否復(fù)用公司其它產(chǎn)品的架構(gòu)或資源等?？傮w構(gòu)造給出系統(tǒng)構(gòu)造總體框圖（涉及軟件、硬件構(gòu)造框圖），闡明本系統(tǒng)的各模塊的劃分，扼要闡明每個系統(tǒng)模塊的標(biāo)記符和功效，分層次地給出各模塊之間的控制與被控制關(guān)系。如果采用構(gòu)造化分析辦法，普通采用下面兩種模型來描述總體構(gòu)造：構(gòu)造圖（層次圖）：對系統(tǒng)自頂向下進行分解。系統(tǒng)流程圖：描述子系統(tǒng)內(nèi)部的控制流和數(shù)據(jù)流如果采用面對對象的分析辦法，普通采用包(package)圖來描述總體構(gòu)造。包(package)圖描述了子系統(tǒng)之間的包含關(guān)系和依賴關(guān)系。子系統(tǒng)設(shè)計在總體構(gòu)造設(shè)計中已經(jīng)將系統(tǒng)劃分為若干個子系統(tǒng)，在此需要對全部的子系統(tǒng)進行設(shè)計。普通應(yīng)涉及下列內(nèi)容。功效構(gòu)造圖/類圖構(gòu)造化設(shè)計：對構(gòu)造圖進行細化，分解到功效一級。面對對象設(shè)計：對包（package）圖進行細化，擬定各包中包含的類。功效定義闡明上一步分解的全部功效組件（功效模塊或者類）的功效。序號功效/類名稱功效描述12功效需求與系統(tǒng)模塊的關(guān)系本條用一張矩陣圖闡明各項功效需求的實現(xiàn)同各模塊的分派關(guān)系，用來實現(xiàn)RTM（需求跟蹤）表，如果已經(jīng)采用了外部工具來做，此處能夠省略。需求跟蹤表[系統(tǒng)模塊1][系統(tǒng)模塊2][……][系統(tǒng)模塊m][功效需求1]√[功效需求2]√[……][功效需求n]√√接口設(shè)計顧客接口闡明將向顧客提供的命令和它們的語法構(gòu)造，以及對應(yīng)的回答信息。例如：腳本命令語法等。外部接口闡明本系統(tǒng)同外界的全部接口的安排涉及：軟件與硬件之間的接口；本系統(tǒng)與各支持系統(tǒng)之間的接口；本系統(tǒng)支持擴展性預(yù)留的外部接口及擴展的方式。如果需要對外提供API接口，列出API接口。內(nèi)部接口闡明本系統(tǒng)之內(nèi)的各個系統(tǒng)模塊或元素之間的接口的安排，涉及：系統(tǒng)涉及的全局變量與接口函數(shù)；本系統(tǒng)支持擴展性預(yù)留的內(nèi)部擴展點及擴展的方式等。系統(tǒng)數(shù)據(jù)構(gòu)造設(shè)計數(shù)據(jù)庫構(gòu)造設(shè)計遵照數(shù)據(jù)庫設(shè)計規(guī)范，此規(guī)范文檔單獨提供。邏輯構(gòu)造設(shè)計給出本系統(tǒng)內(nèi)所使用的每個數(shù)據(jù)構(gòu)造的名稱、標(biāo)記符以及它們之中每個數(shù)據(jù)項、統(tǒng)計、文卷和系的標(biāo)記、定義、長度及它們之間的層次的或表格的互有關(guān)系。物理構(gòu)造設(shè)計給出本系統(tǒng)內(nèi)所使用的每個數(shù)據(jù)構(gòu)造中的每個數(shù)據(jù)項的存儲規(guī)定，訪問辦法、存取單位、存取的物理關(guān)系、設(shè)計考慮和保密條件。配備文獻構(gòu)造設(shè)計給出本系統(tǒng)內(nèi)所使用的每個配備文獻中數(shù)據(jù)構(gòu)造中的每個數(shù)據(jù)項的存儲規(guī)定，訪問辦法、具體的含義和設(shè)計考慮等。數(shù)據(jù)構(gòu)造與程序的關(guān)系闡明各個數(shù)據(jù)構(gòu)造與訪問這些數(shù)據(jù)構(gòu)造的各個程序之間的對應(yīng)關(guān)系。[模塊1][模塊2][……][模塊m][數(shù)據(jù)構(gòu)造1]√[數(shù)據(jù)構(gòu)造2]√√……[數(shù)據(jù)構(gòu)造n]√√算法設(shè)計算法設(shè)計也能夠在具體設(shè)計或?qū)崿F(xiàn)階段進行；對涉及到大量數(shù)據(jù)運算和實時性規(guī)定高的組件，需對將采用的算法進行敘述、論證，以確保合理使用系統(tǒng)資源、滿足需求規(guī)格闡明書中的系統(tǒng)性能規(guī)定。運行設(shè)計運行設(shè)計重要考慮軟件在對外公布時所提供的根據(jù)顧客特點的定制能力。例如：通過修改配備文獻來顯示或隱藏某些模塊，通過修改配備文獻來組合某些模塊等運行模塊組合闡明對系統(tǒng)施加不同的外界運行控制時所引發(fā)的多個不同的運行模塊組合，闡明每種運行所歷經(jīng)的內(nèi)部模塊的支持軟件。模塊集合運行條件支持軟件運行控制闡明每一種外界的運行控制的方式辦法和操作環(huán)節(jié)。運行名稱控制辦法操作環(huán)節(jié)運行時間闡明每種運行模塊組合將占用多個資源的時間，此項普通能夠省略。運行名稱所占資源時間系統(tǒng)安全系統(tǒng)安全1．系統(tǒng)安全控制和物理保護方法，例如：程序加密（軟件鎖）。；2．顧客身份鑒別機制；3．顧客對系統(tǒng)的訪問權(quán)限和范疇。數(shù)據(jù)安全根據(jù)《需求規(guī)格闡明書》中的系統(tǒng)保密規(guī)定，對系統(tǒng)進入及數(shù)據(jù)保密功效進行設(shè)計。普通指：數(shù)據(jù)加密、數(shù)據(jù)顧客身份鑒別、數(shù)據(jù)庫本身的安全（例如異常狀況的數(shù)據(jù)保護、并發(fā)控制）等。備份與恢復(fù)1．?dāng)?shù)據(jù)備份；2．?dāng)?shù)據(jù)恢復(fù)；3．恢復(fù)及再啟動技術(shù)。闡明將使用的恢復(fù)再啟動技術(shù)，使軟件從故障點恢復(fù)執(zhí)行或使軟件從頭開始重新運行的辦法。出錯解決出錯的狀況；出錯時信息輸出的形式、信息的含義和反饋解決辦法；出錯失效后的后備解決方法。系統(tǒng)維護設(shè)計維護功效是系統(tǒng)的重要構(gòu)成部分，應(yīng)提供系統(tǒng)維護和管理的辦法和工具。此處闡明為了系統(tǒng)維護的方便而在程序內(nèi)部設(shè)計中作出的安排，涉及在程序中專門安排用于系統(tǒng)檢查與維護的檢測點和專用模塊及工具。系統(tǒng)布署軟硬件環(huán)境列出運行該軟件所需要的軟硬設(shè)備及其專門功效，如果是多層構(gòu)造需要分別列出各