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

精品文檔 1歡迎下載 架構(gòu)設(shè)計(jì)說明書架構(gòu)設(shè)計(jì)說明書 項(xiàng)目名稱 項(xiàng)目名稱 項(xiàng)目代號 項(xiàng)目代號 編制人 編制人 編制日期 編制日期 精品文檔 2歡迎下載 修訂記錄修訂記錄 版本版本日期日期撰寫撰寫 修訂人修訂人備注備注 修訂內(nèi)容修訂內(nèi)容 精品文檔 3歡迎下載 目目 錄錄 架構(gòu)設(shè)計(jì)說明書 1 1 引言 5 1 1 編寫目的 5 1 2 系統(tǒng)目標(biāo) 5 1 3 術(shù)語和縮寫詞定義 5 1 4 參考資料 5 2 需求規(guī)定 5 2 1 系統(tǒng)功能 5 2 2 系統(tǒng)性能 5 2 3 故障處理要求 6 2 4 軟硬件要求 6 2 5 其他需求限制條件 6 3 總體結(jié)構(gòu)設(shè)計(jì) 6 3 1 系統(tǒng)體系結(jié)構(gòu) 6 3 2 系統(tǒng)開發(fā)的基礎(chǔ)平臺和關(guān)鍵組件 6 3 2 1 外部基礎(chǔ)平臺和關(guān)鍵組件 6 3 2 2 內(nèi)部基礎(chǔ)平臺和關(guān)鍵組件 7 3 3 總體結(jié)構(gòu) 7 4 子系統(tǒng)設(shè)計(jì) 7 4 1 功能結(jié)構(gòu)圖 類圖 7 4 2 功能定義 7 4 3 功能需求與系統(tǒng)模塊的關(guān)系 8 5 接口設(shè)計(jì) 8 5 1 用戶接口 8 5 2 外部接口 8 5 3 內(nèi)部接口 8 6 系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 8 6 1 邏輯結(jié)構(gòu)設(shè)計(jì) 9 6 2 物理結(jié)構(gòu)設(shè)計(jì) 9 6 3 配置文件結(jié)構(gòu)設(shè)計(jì) 9 6 4 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系 9 7 算法設(shè)計(jì) 9 8 運(yùn)行設(shè)計(jì) 9 8 1 運(yùn)行模塊組合 10 8 2 運(yùn)行控制 10 8 3 運(yùn)行時(shí)間 10 9 系統(tǒng)安全 10 9 1 8 1 系統(tǒng)安全 10 9 2 8 2 數(shù)據(jù)安全 10 9 3 8 3 備份與恢復(fù) 10 精品文檔 4歡迎下載 9 4 8 4 出錯(cuò)處理 11 10 系統(tǒng)維護(hù)設(shè)計(jì) 11 11 系統(tǒng)部署 11 11 1 軟硬件環(huán)境 11 11 2 系統(tǒng)部署 11 11 3 系統(tǒng)升級 11 12 遺留問題 11 精品文檔 5歡迎下載 1 1 引言引言 1 1 1 1 編寫目的編寫目的 說明編寫這份架構(gòu)設(shè)計(jì)說明書的目的 指出預(yù)期的讀者 1 2 1 2 系統(tǒng)目標(biāo)系統(tǒng)目標(biāo) 本系統(tǒng)要達(dá)成的目標(biāo) 應(yīng)描述架構(gòu)設(shè)計(jì)的細(xì)度及為下一步模塊設(shè)計(jì)提供的支持 1 3 1 3 術(shù)語和縮寫詞定義術(shù)語和縮寫詞定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組 1 4 1 4 參考資料參考資料 列出與本文密切相關(guān)的參考資料 可能包含如下內(nèi)容 本項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同 上級主管的批文 屬于本項(xiàng)目的其它已發(fā)表的文件 本文件中各處引用的文件 資料 包括所要用到的軟件開發(fā)標(biāo)準(zhǔn) 列出這些文件資料的標(biāo)題 文件編號 發(fā)表日期和出版單位 說明如何能夠得到這些資料 2 2 需求規(guī)定需求規(guī)定 說明影響架構(gòu)設(shè)計(jì)的系統(tǒng)主要功能 輸入輸出 性能要求等的需求限制條件 2 1 2 1 系統(tǒng)功能系統(tǒng)功能 系統(tǒng)的功能性需求 主要列出對架構(gòu)設(shè)計(jì)產(chǎn)品影響的典型功能要求 數(shù)據(jù)要求 輸入輸出要 求和界面要求等 2 2 2 2 系統(tǒng)性能系統(tǒng)性能 主要包括 數(shù)據(jù)精度 執(zhí)行效率 數(shù)據(jù)處理能力等的要求 精品文檔 6歡迎下載 2 3 2 3 故障處理要求故障處理要求 系統(tǒng)出現(xiàn)故障時(shí)的處理機(jī)制 比如 故障轉(zhuǎn)移等 2 4 2 4 軟硬件要求軟硬件要求 軟件需求規(guī)格中規(guī)定必須支持的軟硬件環(huán)境 2 5 2 5 其他需求限制條件其他需求限制條件 包括 事先約定必須要使用的商業(yè)上架系統(tǒng) 組件 比如 必須在 MS Office 上做二次開發(fā) 必須應(yīng)用的技術(shù) 比如 必須使用 B S 結(jié)構(gòu) 必須要與某商業(yè)軟件做接口 比如 必須與用友軟件做接口 與舊版本的兼容升級關(guān)系等 3 3 總體結(jié)構(gòu)設(shè)計(jì)總體結(jié)構(gòu)設(shè)計(jì) 3 1 3 1 系統(tǒng)體系結(jié)構(gòu)系統(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ù)庫還是集中式數(shù)據(jù)庫 分布式應(yīng)用程序服務(wù)器還是集中式應(yīng)用程序服務(wù)器 是采用 Net 應(yīng)用程序框架還是 J2EE 應(yīng)用程序框架 3 2 3 2 系統(tǒng)開發(fā)的基礎(chǔ)平臺和關(guān)鍵組件系統(tǒng)開發(fā)的基礎(chǔ)平臺和關(guān)鍵組件 3 2 1 3 2 1 外部基礎(chǔ)平臺和關(guān)鍵組件外部基礎(chǔ)平臺和關(guān)鍵組件 確定系統(tǒng)開發(fā)的外部基礎(chǔ)平臺和關(guān)鍵組件 如 是在 Windows 平臺 Unix 平臺或者 Linux 平臺上開發(fā) 還是平臺無關(guān)性 是否是在某些軟件上作二次開發(fā) 如 AutoCAD 是否采用一些第三方的關(guān)鍵組件 精品文檔 7歡迎下載 3 2 2 3 2 2 內(nèi)部基礎(chǔ)平臺和關(guān)鍵組件內(nèi)部基礎(chǔ)平臺和關(guān)鍵組件 確定系統(tǒng)開發(fā)所使用的公司內(nèi)部開發(fā)平臺 組件 控件 公共函數(shù) 單元等公共資源 如 是否在 GSP 平臺上開發(fā) 是否采用公司的報(bào)表控件 是否復(fù)用公司其他產(chǎn)品的架構(gòu)或資源等 3 3 3 3 總體結(jié)構(gòu)總體結(jié)構(gòu) 給出系統(tǒng)結(jié)構(gòu)總體框圖 包括軟件 硬件結(jié)構(gòu)框圖 說明本系統(tǒng)的各模塊的劃分 扼要說明 每個(gè)系統(tǒng)模塊的標(biāo)識符和功能 分層次地給出各模塊之間的控制與被控制關(guān)系 如果采用結(jié)構(gòu)化分析方法 通常采用下面兩種模型來描述總體結(jié)構(gòu) 結(jié)構(gòu)圖 層次圖 對系統(tǒng)自頂向下進(jìn)行分解 系統(tǒng)流程圖 描述子系統(tǒng)內(nèi)部的控制流和數(shù)據(jù)流 如果采用面向?qū)ο蟮姆治龇椒?通常采用包 package 圖來描述總體結(jié)構(gòu) 包 package 圖描 述了子系統(tǒng)之間的包含關(guān)系和依賴關(guān)系 4 4 子系統(tǒng)設(shè)計(jì)子系統(tǒng)設(shè)計(jì) 在總體結(jié)構(gòu)設(shè)計(jì)中已經(jīng)將系統(tǒng)劃分為若干個(gè)子系統(tǒng) 在此需要對所有的子系統(tǒng)進(jìn)行設(shè)計(jì) 一 般應(yīng)包括下列內(nèi)容 4 1 4 1 功能結(jié)構(gòu)圖功能結(jié)構(gòu)圖 類圖類圖 結(jié)構(gòu)化設(shè)計(jì) 對結(jié)構(gòu)圖進(jìn)行細(xì)化 分解到功能一級 面向?qū)ο笤O(shè)計(jì) 對包 package 圖進(jìn)行細(xì)化 確定各包中包含的類 4 2 4 2 功能定義功能定義 說明上一步分解的所有功能組件 功能模塊或者類 的功能 序號序號功能功能 類名稱類名稱功能描述功能描述 1 2 4 3 4 3 功能需求與系統(tǒng)模塊的關(guān)系功能需求與系統(tǒng)模塊的關(guān)系 精品文檔 8歡迎下載 本條用一張矩陣圖說明各項(xiàng)功能需求的實(shí)現(xiàn)同各模塊的分配關(guān)系 用來實(shí)現(xiàn) RTM 需求跟蹤 表 如果已經(jīng)采用了外部工具來做 此處可以省略 需求跟蹤表需求跟蹤表 系統(tǒng)模塊系統(tǒng)模塊 1 1 系統(tǒng)模塊系統(tǒng)模塊 2 2 系統(tǒng)模塊系統(tǒng)模塊 m m 功能需求功能需求 1 1 功能需求功能需求 2 2 功能需求功能需求 n n 5 5 接口設(shè)計(jì)接口設(shè)計(jì) 5 1 5 1 用戶接口用戶接口 說明將向用戶提供的命令和它們的語法結(jié)構(gòu) 以及相應(yīng)的回答信息 例如 腳本命令語法等 5 2 5 2 外部接口外部接口 說明本系統(tǒng)同外界的所有接口的安排包括 軟件與硬件之間的接口 本系統(tǒng)與各支持系統(tǒng)之間的接口 本系統(tǒng)支持?jǐn)U展性預(yù)留的外部接口及擴(kuò)展的方式 如果需要對外提供 API 接口 列出 API 接口 5 3 5 3 內(nèi)部接口內(nèi)部接口 說明本系統(tǒng)之內(nèi)的各個(gè)系統(tǒng)模塊或元素之間的接口的安排 包括 系統(tǒng)涉及的全局變量與接口函數(shù) 本系統(tǒng)支持?jǐn)U展性預(yù)留的內(nèi)部擴(kuò)展點(diǎn)及擴(kuò)展的方式等 6 6 系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 數(shù)據(jù)庫結(jié)構(gòu)設(shè)計(jì)遵循數(shù)據(jù)庫設(shè)計(jì)規(guī)范 此規(guī)范文檔單獨(dú)提供 精品文檔 9歡迎下載 6 1 6 1 邏輯結(jié)構(gòu)設(shè)計(jì)邏輯結(jié)構(gòu)設(shè)計(jì) 給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)的名稱 標(biāo)識符以及它們之中每個(gè)數(shù)據(jù)項(xiàng) 記錄 文卷 和系的標(biāo)識 定義 長度及它們之間的層次的或表格的相互關(guān)系 6 2 6 2 物理結(jié)構(gòu)設(shè)計(jì)物理結(jié)構(gòu)設(shè)計(jì) 給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)中的每個(gè)數(shù)據(jù)項(xiàng)的存儲要求 訪問方法 存取單位 存 取的物理關(guān)系 設(shè)計(jì)考慮和保密條件 6 3 6 3 配置文件結(jié)構(gòu)設(shè)計(jì)配置文件結(jié)構(gòu)設(shè)計(jì) 給出本系統(tǒng)內(nèi)所使用的每個(gè)配置文件中數(shù)據(jù)結(jié)構(gòu)中的每個(gè)數(shù)據(jù)項(xiàng)的存儲要求 訪問方法 具 體的含義和設(shè)計(jì)考慮等 6 4 6 4 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系 說明各個(gè)數(shù)據(jù)結(jié)構(gòu)與訪問這些數(shù)據(jù)結(jié)構(gòu)的各個(gè)程序之間的對應(yīng)關(guān)系 模塊模塊 1 1 模塊模塊 2 2 模塊模塊 m m 數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)結(jié)構(gòu) 1 1 數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)結(jié)構(gòu) 2 2 數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)結(jié)構(gòu) n n 7 7 算法設(shè)計(jì)算法設(shè)計(jì) 算法設(shè)計(jì)也可以在詳細(xì)設(shè)計(jì)或?qū)崿F(xiàn)階段進(jìn)行 對涉及到大量數(shù)據(jù)運(yùn)算和實(shí)時(shí)性要求高的組件 需對將采用的算法進(jìn)行闡述 論證 以確保 合理使用系統(tǒng)資源 滿足需求規(guī)格說明書中的系統(tǒng)性能要求 8 8 運(yùn)行設(shè)計(jì)運(yùn)行設(shè)計(jì) 運(yùn)行設(shè)計(jì)主要考慮軟件在對外發(fā)布時(shí)所提供的根據(jù)用戶特點(diǎn)的定制能力 比如 通過修改配 置文件來顯示或隱藏某些模塊 通過修改配置文件來組合某些模塊等 8 1 8 1 運(yùn)行模塊組合運(yùn)行模塊組合 精品文檔 10歡迎下載 說明對系統(tǒng)施加不同的外界運(yùn)行控制時(shí)所引起的各種不同的運(yùn)行模塊組合 說明每種運(yùn)行所 歷經(jīng)的內(nèi)部模塊的支持軟件 模塊集合模塊集合運(yùn)行條件運(yùn)行條件支持軟件支持軟件 8 2 8 2 運(yùn)行控制運(yùn)行控制 說明每一種外界的運(yùn)行控制的方式方法和操作步驟 運(yùn)行名稱運(yùn)行名稱控制方法控制方法操作步驟操作步驟 8 3 8 3 運(yùn)行時(shí)間運(yùn)行時(shí)間 說明每種運(yùn)行模塊組合將占用各種資源的時(shí)間 此項(xiàng)一般可以省略 運(yùn)行名稱運(yùn)行名稱所占資源所占資源時(shí)間時(shí)間 9 9 系統(tǒng)安全系統(tǒng)安全 9 1 9 1 系統(tǒng)安全系統(tǒng)安全 1 系統(tǒng)安全控制和物理保護(hù)措施 比如 程序加密 軟件鎖 2 用戶身份鑒別機(jī)制 3 用戶對系統(tǒng)的訪問權(quán)限和范圍 9 2 9 2 數(shù)據(jù)安全數(shù)據(jù)安全 根據(jù) 需求規(guī)格說明書 中的系統(tǒng)保密要求 對系統(tǒng)進(jìn)入及數(shù)據(jù)保密功能進(jìn)行設(shè)計(jì) 通常指 數(shù)據(jù)加密 數(shù)據(jù)用戶身份鑒別 數(shù)據(jù)庫本身的安全 比如異常情況的數(shù)據(jù)保護(hù) 并發(fā)控制 等 9 3 9 3 備份與恢復(fù)備份與恢復(fù) 1 數(shù)據(jù)備份 2 數(shù)據(jù)恢復(fù) 3 恢復(fù)及再啟動(dòng)技術(shù) 說明將使用的恢復(fù)再啟動(dòng)技術(shù) 使軟件從故障點(diǎn)恢復(fù)執(zhí)行或使軟件從 頭開始重新運(yùn)行的方法 9 4 9 4 出錯(cuò)處理出錯(cuò)處理 精品文檔 11歡迎下載 1 出錯(cuò)的情況 2 出錯(cuò)時(shí)信息輸出的形式 信息的含義和反饋處理方法 3 出錯(cuò)失效后的后備處理措施 10 10 系統(tǒng)維護(hù)設(shè)計(jì)系統(tǒng)維護(hù)設(shè)計(jì) 維護(hù)功能是系統(tǒng)的重要組成部分 應(yīng)提供系統(tǒng)維護(hù)和管理的方法和工具 此處說明為了系統(tǒng) 維護(hù)的方便而在程序內(nèi)部設(shè)計(jì)中作出的安排 包括在程序中專門安排用于系統(tǒng)檢查與維護(hù)的檢測 點(diǎn)和專用模塊及工具 11 11 系統(tǒng)部署系統(tǒng)部署 11 1 11 1 軟硬件環(huán)境軟硬件環(huán)境 列出運(yùn)行該軟件所需要的軟硬設(shè)備及其專門功能 如果是多層結(jié)構(gòu)需要分別列出各層所需的 軟硬件環(huán)境 11 2 11 2 系統(tǒng)部署系統(tǒng)部署 列出系統(tǒng)的部署方式 繪出系統(tǒng)的部署圖 11 3 11 3 系統(tǒng)升級系統(tǒng)升級 舊版本的升級方式 當(dāng)前版本的未來版本的