XXX軟件架構(gòu)設(shè)計(jì)文檔

1、XXX軟件概要設(shè)計(jì)擬制：審核：標(biāo)準(zhǔn)化：批準(zhǔn)：發(fā)布日期：本文中的所有信息均為武漢正維電子技術(shù)有限公司信息，務(wù)請妥善保管，未經(jīng)公司明確作出的書 面許可，不得為任何目的、以任何形式或手段（包括電子、機(jī)械、復(fù)印、錄音或其它形式）對本文檔 的任何部分進(jìn)行復(fù)制、儲存、引入檢索系統(tǒng)或者傳播。歷史記錄版本號主要更改內(nèi)容（與要點(diǎn)即可）更改理由擬制人/ 修改人擬制/修 改日期注1:每次更改歸檔文件（指歸檔到射頻部研發(fā)辦公室標(biāo)準(zhǔn)化）時，需填寫此表 注2:文件第一次歸檔時，“更改理由”、“主要更改內(nèi)容”欄寫“無”。1. 簡介 51.1. 目的 51.2. 范圍 51.3. 定義、縮略語 51.4. 參考資料 51.5

2、. 概述 62. 軟件架構(gòu) 72.1. 需求規(guī)定 72.2. 開發(fā)、運(yùn)行環(huán)境 72.3. 基本設(shè)計(jì)概念和處理流程 72.4. 總體結(jié)構(gòu) 72.5. 架構(gòu)目標(biāo)和約束 72.6. 功能需求與程序的關(guān)系 83. 用例視圖 93.1. 核心用例 93.2. 用例實(shí)現(xiàn) 94. 邏輯視圖 104.1. 層次結(jié)構(gòu) 104.2. 模塊 1 104.2.1. 子模塊1 104.2.2. 子模塊2 104.2.3. 外部接口 104.3. 模塊 2 115. 進(jìn)程視圖 125.1. 進(jìn)程、線程劃分 125.2. 進(jìn)程、線程優(yōu)先級、親和定義 125.3. 進(jìn)程、線程啟動順序 125.4. 進(jìn)程間通訊 126. 數(shù)據(jù)

3、視圖 137. 軟件性能指標(biāo) 148. 屬性設(shè)計(jì) 158.1. 可調(diào)試性 158.2. 可測試性 158.3. 可擴(kuò)展性 158.4. 可靠性 15未找到圖形項(xiàng)目表。表 2.6-1 功能模塊映射表圖表目錄 81. 簡介【本文檔將從構(gòu)架方面對系統(tǒng)進(jìn)行綜合概述，其中會使用多種不同的構(gòu)架視圖來描述軟件系統(tǒng)的各個方面，記錄并表述已對系統(tǒng)的構(gòu)架方面作出的重要決策?！俊拒浖?gòu)架文檔的簡介應(yīng)提供整個軟件構(gòu)架文檔的概述。它應(yīng)包括此軟件構(gòu)架文檔的目的、范圍、定義、首字母縮寫詞、縮略語、參考資料和概述?！?.1. 目的【本節(jié)確定此軟件構(gòu)架文檔在整個項(xiàng)目文檔中的作用或目的，并對此文檔的結(jié)構(gòu)進(jìn)行簡要 說明。應(yīng)確定此文

4、檔的特定讀者，并指出他們應(yīng)該如何使用此文檔】1.2. 范圍【簡要說明此軟件構(gòu)架文檔適用的范圍和影響的范圍，以及閱讀對象】1.3. 定義、縮略語【本小節(jié)應(yīng)提供正確理解此軟件構(gòu)架文檔所需的全部術(shù)語的定義、首字母縮寫詞和縮略語。這些信息可以通過引用項(xiàng)目詞匯表來提供?！?.4. 參考資料【本小節(jié)應(yīng)完整地列出此軟件構(gòu)架文檔中其他部分所引用的所有文檔。每個文檔應(yīng)標(biāo)有標(biāo)題、報(bào)告號（如果適用）、日期和出版單位。列出可從中獲取這些參考資料的來源。這些信息可以通過引用附錄或其他文檔來提供】1.5. 概述【本小節(jié)應(yīng)說明此軟件構(gòu)架文檔中其他部分所包含的內(nèi)容，式】并解釋此軟件構(gòu)架文檔的組織方2. 軟件架構(gòu)2.1. 需求

5、規(guī)定【描述 xxx 項(xiàng)目對軟件的需求，作為后續(xù)設(shè)計(jì)目標(biāo)和基礎(chǔ)】2.2. 開發(fā)、運(yùn)行環(huán)境【簡要介紹軟件開發(fā)所使用的工具、軟硬件環(huán)境，以及目標(biāo)代碼運(yùn)行的軟硬件環(huán)境。如 Guest、Host 主機(jī)的操作系統(tǒng)，CPU 架構(gòu)；編譯器名稱及版本，開發(fā)語言，及各種開發(fā)、調(diào)試工具的名稱和版本】2.3. 基本設(shè)計(jì)概念和處理流程【說明本系統(tǒng)的基本設(shè)計(jì)概念和處理流程，盡量使用圖表的形式】2.4. 總體結(jié)構(gòu)【在此簡單介紹軟件架構(gòu)的整體情況，包括用例視圖、邏輯視圖、進(jìn)程視圖、實(shí)施視圖和部署視圖的簡單介紹。另外，簡要介紹各種視圖的作用和針對的閱讀對象?！俊緦τ跓o閱讀對象的視圖，或者非重點(diǎn)對象，可以酌情刪減視圖。如，對于嵌

6、入式系統(tǒng)，一般都是單板結(jié)構(gòu)，或者說， 從軟件角度是單板結(jié)構(gòu)，那么， 可以將實(shí)施視圖和部署視圖省略?！?.5. 架構(gòu)目標(biāo)和約束【本節(jié)說明對構(gòu)架具有某種重要影響的軟件需求和目標(biāo)，例如：安全性、保密性、市售產(chǎn)品的使用、可移植性、分銷和重復(fù)使用。還應(yīng)記錄可能適用的特殊約束：設(shè)計(jì)與實(shí)施策略、開發(fā)工具、團(tuán)隊(duì)結(jié)構(gòu)、時間表、遺留代碼等】2.6. 功能需求與程序的關(guān)系【說明各項(xiàng)功能需求的實(shí)現(xiàn)同各塊程序的分配關(guān)系】 如，可以采用下表所示例內(nèi)容：模塊1模塊2模塊m功能需求1功能需求2V功能需求nV表2.6-1功能模塊映射表AUEURU南向AP 二V南向APV南向AP南向APVV3. 用例視圖【本節(jié)列出用例模型中的一

7、些用例或場景，這些用例或場景應(yīng)體現(xiàn)最終系統(tǒng)中重要的、核心的功能；或是在構(gòu)架方面涉及范圍很廣（使用了許多構(gòu)架元素）；或強(qiáng)調(diào)或闡明了構(gòu)架的某一具體的細(xì)微之處。】【在此可以直接引用需求中的相關(guān)文檔，比如ROSE莫型；用例描述等】【根據(jù)項(xiàng)目的實(shí)際情況，此節(jié)可以省略不寫】3.1. 核心用例【在此引用ROSE模型中的用例圖即可】3.2. 用例實(shí)現(xiàn)【本節(jié)通過幾個精選的用例（場景）實(shí)現(xiàn)來闡述軟件的實(shí)際工作方式，并解釋不同的設(shè)計(jì)模型元素如何促成其功能的實(shí)現(xiàn)】4. 邏輯視圖【在此用圖形的方式顯示此軟件架構(gòu)的分層、子系統(tǒng)、模塊之間的關(guān)系，并且加入必要的文字說明，特別是架構(gòu)的分層、機(jī)制和模式的說明。】【在此， 還需要

8、將和本系統(tǒng)有接口關(guān)系的其它系統(tǒng)都表示出來，這樣可以清楚的看到本系統(tǒng)和其它系統(tǒng)的接口外部接口邏輯視圖，并且還需要將在本系統(tǒng)中負(fù)責(zé)接口內(nèi)部接口的子系統(tǒng)表示出來?！?.1. 層次結(jié)構(gòu)【在此說明邏輯分層的每一層和每一層中的模塊、子系統(tǒng)。對于每個重要的模塊，都用一個小節(jié)來加以說明，其中應(yīng)包括該模塊的名稱、功能簡要說明、模塊外部接口、模塊的屬性等。】4.2. 模塊 1【當(dāng)前模塊的名稱、功能簡要說明、模塊外部接口、模塊的屬性等?！俊救绻幽K，需要進(jìn)一步給出子模塊的劃分及層次結(jié)構(gòu)；對于每一個子模塊，也應(yīng)該用獨(dú)立小節(jié)，給出其子模塊名稱、功能說明，重要接口及重要屬性等等】4.2.1. 子模塊 14.2.2.

9、 子模塊 24.2.3. 外部接口【給出模塊的外部接口原型，包括形參列表、范圍，返回值，及其他使用說明】4.3. 模塊 25. 進(jìn)程視圖【本節(jié)說明將系統(tǒng)分解為輕量級進(jìn)程（單個控制線程）和重量級進(jìn)程（成組的輕量級進(jìn)程）的情況。 本節(jié)的內(nèi)容按照各個通信或交互的進(jìn)程組來進(jìn)行組織。說明進(jìn)程之間的主要通信模式，例如消息傳遞、中斷親和/優(yōu)先級、任務(wù)親和/優(yōu)先級】5.1. 進(jìn)程、線程劃分業(yè)務(wù)執(zhí)行進(jìn)程、線程劃分，邏輯視圖中各個模塊/子模塊同進(jìn)程、線程的映射】5.2. 進(jìn)程、線程優(yōu)先級、親和定義5.3. 進(jìn)程、線程啟動順序5.4. 進(jìn)程間通訊6. 數(shù)據(jù)視圖【從永久性、全局性數(shù)據(jù)存儲方面來對系統(tǒng)進(jìn)行說明。如系統(tǒng)、模塊的配置文件，EEPROM/FLAS”存儲的戈ij分方案，全局變量等】7. 軟件性能指標(biāo)以及目標(biāo)性能約束。如某個消息/事件的響應(yīng)時間，系統(tǒng)能夠支持的最多同時登錄用戶數(shù)量等】8. 屬性設(shè)計(jì)【說明各個模塊、指標(biāo)的調(diào)試、測試方法。如 debug 開關(guān)的設(shè)置，極限指標(biāo)的測試步驟和要求；以及為測試版本設(shè)置的各種編譯宏】8.1. 可調(diào)試性【給出各個模塊的調(diào)試方法。如 Log， console 打印輸出等信息，以及控制方法；并給出軟件設(shè)計(jì)中添加的統(tǒng)計(jì)量值（如果