架構設計說明書

2021-03-26 14:33:16 字數 3805 閱讀 1825

專案名稱:[專案名稱]

專案代號:[專案代號]

編制人:[編制人]

編制日期:[編制日期]

目錄架構設計說明書 1

1. 引言 5

1.1. 編寫目的 5

1.2. 系統目標 5

1.3. 術語和縮寫詞定義 5

1.4. 參考資料 5

2. 需求規定 5

2.1. 系統功能 5

2.2. 系統效能 5

2.3. 故障處理要求 6

2.4. 軟硬體要求 6

2.5. 其他需求限制條件 6

3. 總體結構設計 6

3.1. 系統體系結構 6

3.2. 系統開發的基礎平台和關鍵元件 6

3.2.1. 外部基礎平台和關鍵元件 6

3.2.2. 內部基礎平台和關鍵元件 7

3.3. 總體結構 7

4. 子系統設計 7

4.1. 功能結構圖/類圖 7

4.2. 功能定義 7

4.3. 功能需求與系統模組的關係 8

5. 介面設計 8

5.1. 使用者介面 8

5.2. 外部介面 8

5.3. 內部介面 8

6. 系統資料結構設計 8

6.1. 邏輯結構設計 9

6.2. 物理結構設計 9

6.3. 配置檔案結構設計 9

6.4. 資料結構與程式的關係 9

7. 演算法設計 9

8. 執行設計 9

8.1. 執行模組組合 10

8.2. 執行控制 10

8.3. 執行時間 10

9. 系統安全 10

9.1. 8.1 系統安全 10

9.2. 8.2 資料安全 10

9.3. 8.3 備份與恢復 10

9.4. 8.4 出錯處理 11

10. 系統維護設計 11

11. 系統部署 11

11.1. 軟硬體環境 11

11.2. 系統部署 11

11.3. 系統公升級 11

12. 遺留問題 11

說明編寫這份架構設計說明書的目的,指出預期的讀者。

本系統要達成的目標,應描述架構設計的細度及為下一步模組設計提供的支援。

列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。

列出與本文密切相關的參考資料,可能包含如下內容:

● 本專案經核准的計畫任務書或合同、上級主管的批文;

● 屬於本專案的其它已發表的檔案;

● 本檔案中各處引用的檔案、資料,包括所要用到的軟體開發標準。

列出這些檔案資料的標題、檔案編號、發表日期和出版單位,說明如何能夠得到這些資料。

說明影響架構設計的系統主要功能、輸入輸出、效能要求等的需求限制條件。

系統的功能性需求,主要列出對架構設計產品影響的典型功能要求、資料要求、輸入輸出要求和介面要求等。

主要包括

● 資料精度

● 執行效率

● 資料處理能力等的要求。

系統出現故障時的處理機制,比如:故障轉移等。

軟體需求規格中規定必須支援的軟硬體環境。

包括:● 事先約定必須要使用的商業上架系統/元件(比如:必須在ms office上做二次開發);

● 必須應用的技術(比如:必須使用b/s結構);

● 必須要與某商業軟體做介面(比如:必須與用友軟體做介面);

● 與舊版本的相容公升級關係等

確定系統採用何種體系結構,如:

● 單機版還是網路版?

● c/s結構還是b/s結構?

● 兩層結構還是多層結構?

● 分布式資料庫還是集中式資料庫?

● 分布式應用程式伺服器還是集中式應用程式伺服器?

● 是採用.***應用程式框架還是j2ee應用程式框架?

確定系統開發的外部基礎平台和關鍵元件,如:

● 是在windows平台、unix平台或者linux平台上開發?還是平台無關性?

● 是否是在某些軟體上作二次開發?如autocad。

● 是否採用一些第三方的關鍵元件。

確定系統開發所使用的公司內部開發平台、元件/控制項、公共函式/單元等公共資源,如:

● 是否在gsp平台上開發;

● 是否採用公司的報表控制項;

● 是否復用公司其他產品的架構或資源等。

給出系統結構總體框圖(包括軟體、硬體結構框圖),說明本系統的各模組的劃分,扼要說明每個系統模組的識別符號和功能,分層次地給出各模組之間的控制與被控制關係。

如果採用結構化分析方法,通常採用下面兩種模型來描述總體結構:

● 結構圖(層次圖):對系統自頂向下進行分解。

● 系統流程圖:描述子系統內部的控制流和資料流

如果採用物件導向的分析方法,通常採用包(package)圖來描述總體結構。包(package)圖描述了子系統之間的包含關係和依賴關係。

在總體結構設計中已經將系統劃分為若干個子系統,在此需要對所有的子系統進行設計。一般應包括下列內容。

結構化設計:對結構圖進行細化,分解到功能一級。

物件導向設計:對包(package)圖進行細化,確定各包中包含的類。

說明上一步分解的所有功能元件(功能模組或者類)的功能。

本條用一張矩陣圖說明各項功能需求的實現同各模組的分配關係,用來實現rtm(需求跟蹤)表,如果已經採用了外部工具來做,此處可以省略。

需求跟蹤表

說明將向使用者提供的命令和它們的語法結構,以及相應的回答資訊。例如:指令碼命令語法等。

說明本系統同外界的所有介面的安排包括:

● 軟體與硬體之間的介面;

● 本系統與各支援系統之間的介面;

● 本系統支援擴充套件性預留的外部介面及擴充套件的方式。

● 如果需要對外提供api介面,列出api介面。

說明本系統之內的各個系統模組或元素之間的介面的安排,包括:

● 系統涉及的全域性變數與介面函式;

● 本系統支援擴充套件性預留的內部擴充套件點及擴充套件的方式等。

資料庫結構設計遵循資料庫設計規範,此規範文件單獨提供。

給出本系統內所使用的每個資料結構的名稱、識別符號以及它們之中每個資料項、記錄、文捲和系的標識、定義、長度及它們之間的層次的或**的相互關係。

給出本系統內所使用的每個資料結構中的每個資料項的儲存要求,訪問方法、訪問單位、訪問的物理關係、設計考慮和保密條件。

給出本系統內所使用的每個配置檔案中資料結構中的每個資料項的儲存要求,訪問方法、具體的含義和設計考慮等。

說明各個資料結構與訪問這些資料結構的各個程式之間的對應關係。

演算法設計也可以在詳細設計或實現階段進行;

對涉及到大量資料運算和實時性要求高的元件,需對將採用的演算法進行闡述、論證,以確保合理使用系統資源、滿足需求規格說明書中的系統效能要求。

執行設計主要考慮軟體在對外發布時所提供的根據使用者特點的定製能力。比如:通過修改配置檔案來顯示或隱藏某些模組,通過修改配置檔案來組合某些模組等

說明對系統施加不同的外界執行控制時所引起的各種不同的執行模組組合,說明每種執行所歷經的內部模組的支援軟體。

說明每一種外界的執行控制的方式方法和操作步驟。

說明每種執行模組組合將占用各種資源的時間,此項一般可以省略。

系統架構設計說明書

版本記錄 目錄第 1 章概述 2 1.1 文件目的 2 1.2 閱讀物件 2 1.3 術語表 2 1.4 參考資料 2 第 2 章系統概況 3 2.1 系統功能結構圖 3 2.2 系統層次結構圖 3 2.3 系統通訊規範 3 第 3 章用例檢視 4 3.1 用例項1描述 4 3.2 用例項2描述 4...

3軟體架構設計說明書個人任務管理系統

專案文件個人任務管理系統架構設計說明書 姓名張三 學院大連東軟資訊學院 專業電腦科學與技術 指導教師李四講師 備註2010 年 10 月11日 個人任務管理系統按照系統架構的分層思想共分為四層,參見圖1。圖1 系統架構層次示意圖 表示層 ui層 以使用者圖形介面組成。主要職責是提供表單以輸入資訊 提...

包裝結構設計說明書

市場調查 對於兒童類護膚品在包裝上兒童化妝品與 化妝品包裝材質完全相同,但由於印刷和形狀上的區別很大,讓人一眼就能夠分辨。兒童化妝品包裝在設計方面必須充分考慮兒童的心理需求,根據他們的心理特點和喜好設計出迎合兒童視覺 手感的產品包裝。通常是以鮮明反差的色彩配以形狀可愛的外觀包裝。使用最多的是 圖案,...