完整版軟件架構(gòu)設(shè)計文檔模板

1、<ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd>documentidentifier>1. 文檔簡介31.1 文檔目的31.2 文檔范圍31.3 定義、縮寫詞和縮略語31.4 參考資料32. 架構(gòu)描述方式32.1 架構(gòu)視圖閱讀指南32.2 圖表與模型閱讀指南43. 架構(gòu)設(shè)計目標43.1 關(guān)鍵功能43.2 關(guān)鍵質(zhì)量屬性43.3 業(yè)務(wù)需求和約束因素54. 架構(gòu)設(shè)計原則54.1 架構(gòu)設(shè)計原則54.2 備選架構(gòu)設(shè)計方案及被否原因54.3 架構(gòu)設(shè)計對后續(xù)工作的限制（詳設(shè)

2、，部署等）55. 邏輯架構(gòu)視圖65.1 職責(zé)劃分與職責(zé)確定65.2 接口設(shè)計與協(xié)作機制75.3 重要設(shè)計包96. 開發(fā)架構(gòu)視圖106.1 Project劃分106.2 Project1106.2.1 Project目錄結(jié)構(gòu)指導(dǎo)116.2.2 程序單元組織116.2.3 框架與應(yīng)用之間的關(guān)系（可選）116.3 Project2126.4 Projectn127. 運行架構(gòu)視圖127.1 控制流組織127.2 控制流的創(chuàng)建、銷毀、通信137.3 加鎖設(shè)計138. 物理架構(gòu)視圖138.1 物理拓撲138.2 軟件到硬件的映射148.3 優(yōu)化部署15<ProjectName>Version

3、:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>9. 數(shù)據(jù)架構(gòu)視圖159.1 持久化機制的選擇169.2 持久化存儲方案169.3 數(shù)據(jù)同步與復(fù)制策略1610. 關(guān)鍵質(zhì)量屬性的設(shè)計原理16<ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd>documentidentifier>1. 文檔簡介幫助讀者對本文檔建立基本印象，并為閱讀后續(xù)內(nèi)容

4、掃清障礙。1.1 文檔目的文檔目的，非項目目的。否則造成同一項目多個文檔之間的內(nèi)容重復(fù)，不利于文檔維護。本小節(jié)應(yīng)指明文檔針對的讀者對象，最好列出各種讀者角色，并說明每種讀者角色應(yīng)該重點閱讀的章節(jié)。1.2 文檔范圍文檔的Scope,非項目的Scope。否則造成同一項目多個文檔之間的內(nèi)容重復(fù)，不利于文檔維護。1.3 定義、縮寫詞和縮略語集中列舉文檔中的定義、縮寫詞和縮略語。1.4 參考資料本項目經(jīng)審核的計劃書、合同、上級批文；本項目的其他已發(fā)表文件；本文檔引用的文件資料，如軟件開發(fā)標準。具體而言，應(yīng)包括參考資料的題目（必須）、編號、版本號（必須）、發(fā)表日期、發(fā)布方，必要時還可以說明如何使用這些資料

5、。2. 架構(gòu)描述方式為了讓讀者更好地理解架構(gòu)文檔，在本節(jié)應(yīng)當(dāng)說明文檔涉及的架構(gòu)視圖，并指明為了描述設(shè)計決策用到了哪些圖表和模型。2.1 架構(gòu)視圖閱讀指南以多視圖的方式來組織架構(gòu)文檔是大勢所趨。ADMEMS推薦的是經(jīng)過優(yōu)化的5視圖方法，如下圖所示。<ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>T向控制流直向元伴謖輯架構(gòu)二職孟迪分職責(zé)間協(xié)作面向Table或文件數(shù)據(jù)架構(gòu)7存工故推單元數(shù)捱存儲格式運行架構(gòu)控制流控制流組哄

6、物理架構(gòu)物嗖節(jié)點、物理節(jié)點.尼才市、/面向節(jié)點用向?qū)Φ然蚨聵?gòu)化2.2圖表與模型閱讀指南對后續(xù)文檔內(nèi)容中所用到的建模語言（例如說明。UML）、表格（例如目標-場景-決策表）等進行3. 架構(gòu)設(shè)計目標功能、質(zhì)量、約束，一個都不能少。3.1 關(guān)鍵功能對架構(gòu)設(shè)計至關(guān)重要的功能，包括如下4類：核心功能、必做功能、高風(fēng)險功能、獨特功能。所謂獨特功能，指這個功能覆蓋了上述3類功能沒有涉及到的職責(zé)。3.2關(guān)鍵質(zhì)量屬性人之所以痛苦，很多時候是因為追求錯誤的東西。下圖是大原則的整體思路圖。ADMEMS方法確定關(guān)鍵質(zhì)量的5<ProjectName>Version:<1.0>SoftwareAr

7、chitectureDocumentDate:<yyyy-mm-dd><documentidentifier>3.3業(yè)務(wù)需求和約束因素ADMEMS方法創(chuàng)造性地提出約束需求的4大類型，這是一種極為實用的分類方式。特別是業(yè)務(wù)需求對架構(gòu)設(shè)計而言是一種約束的觀點，解決了很多架構(gòu)師的現(xiàn)實困惑。下圖標明了4類約束在“需求層次-需求方面矩陣（又稱ADMEMS矩陣）”中的位置，可以幫助我們理解產(chǎn)生約束需求白根源。4. 架構(gòu)設(shè)計原則投標時經(jīng)常講“架構(gòu)設(shè)計原則”，但到了架構(gòu)文檔，這些著眼大局的考慮卻“丟了”。ADMEMS方法推薦的本文檔模板，認為應(yīng)當(dāng)把它們“找回來”。4.1 架構(gòu)設(shè)計原則著

8、重描述重大的權(quán)衡取舍考慮。4.2 備選架構(gòu)設(shè)計方案及被否原因在概念架構(gòu)一級，對備選架構(gòu)設(shè)計方案進行描述，并闡述它們未被采用的原因。這有利于團隊了解當(dāng)前架構(gòu)設(shè)計方案的來龍去脈，提高團隊對當(dāng)前架構(gòu)設(shè)計方案的認可度。4.3 架構(gòu)設(shè)計對后續(xù)工作的限制（詳設(shè)，部署等）架構(gòu)設(shè)計不僅應(yīng)該包含“指導(dǎo)”，也應(yīng)該包含重要的“限制”。例如，一份只是說明“性能和可擴展性都重要”的架構(gòu)文檔，實際上忽視了“可擴展性和性能之間存在的矛盾關(guān)系”。此時，最有效的辦法就是在架構(gòu)文檔中明確說明“任何提升可擴展性的架構(gòu)設(shè)計和詳細設(shè)計，都應(yīng)通過架構(gòu)團隊的評審才能引入，以確保性能目標不受重大影響”。ADMEMS裁巴提陶說J力花<P

9、rojectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>5.邏輯架構(gòu)視圖關(guān)注點：此架構(gòu)設(shè)計視圖的關(guān)注點是職責(zé)劃分。注意：邏輯架構(gòu)視圖無疑是最重要的，但同時也應(yīng)避免“架構(gòu)=模塊+接口”等以偏概全的認識。參考：任何復(fù)雜系統(tǒng)的架構(gòu)設(shè)計都不是一蹴而就的，所以架構(gòu)師需要理性思維過程的指導(dǎo)。針對邏輯架構(gòu)設(shè)計這個關(guān)鍵環(huán)節(jié)，一線架構(gòu)師實踐指南一書給出了2條建議：一是“以質(zhì)疑驅(qū)動的螺旋思維”，二是相對分離地考慮“結(jié)構(gòu)方面的切分”和“行為方面的定義”。

10、下圖所示即為ADMEMS方法推薦的邏輯架構(gòu)設(shè)計理性思維過程。結(jié)構(gòu)方面的切分質(zhì)疑自己的設(shè)講，特殊功能場景支持嗎?耦合性.重用性咋樣?5.1 職責(zé)劃分與職責(zé)確定內(nèi)容：將系統(tǒng)切分成更小的單元，并明確這些單元的職責(zé)。具體而言，職責(zé)單元可以是層、子系統(tǒng)、模塊、關(guān)鍵類等。意義：一句話，職責(zé)劃分不合理，功能和質(zhì)量都會受到影響。也就是說，功能需求和質(zhì)量需求無一不和職責(zé)劃分相關(guān)：一方面，每個功能都是由一條職責(zé)協(xié)作鏈完成的；另一方面，職責(zé)劃分方式也影響著質(zhì)量，于是需要職責(zé)模型針對特定質(zhì)量屬性要求做出相應(yīng)調(diào)整和優(yōu)化。很多人認為架構(gòu)設(shè)計就是職責(zé)劃分的藝術(shù)，雖略顯片面，但足以表明職責(zé)劃分的重要性。參考：基于對業(yè)界大量案

11、例的研究，ADMEMS方法梳理出了“模塊劃分的3種必用手段”，如下圖所示，更多內(nèi)容可參考一線架構(gòu)師實踐指南一書。<ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>人的因素考慮架構(gòu)本身考點5.2 接口設(shè)計與協(xié)作機制內(nèi)容：本節(jié)描述接口的定義，以及協(xié)作的方式和規(guī)范。意義：恰恰是因為有了各模塊之間“未來合作的契約”，分頭開發(fā)各模塊才有了基本保證。參考：ADMEMS方法推薦利用“包-接口”圖，來識別接口。下圖為一個“包-接口”

12、圖的示例。ADMEMSPage7of17裁巴步周宙J方花<ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>進度展現(xiàn)回調(diào)接口Facade命令描述接鐘接口智能攝沖機制內(nèi)容援沖達“物定仙|窖;對利應(yīng)接口進行網(wǎng)調(diào)對超出額2Tull容量的內(nèi)容進不性能保仃參考：ADMEMS方法推薦使用序列圖，建議少用、甚至杜絕使用協(xié)作圖。下圖為一個序列圖的示例。ADMEMS敦網(wǎng)齪甌ifid方景<ProjectName>Version

13、:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>5.3 重要設(shè)計包內(nèi)容：對重要子系統(tǒng)的設(shè)計進行“灰盒”級描述。意義：“每個子系統(tǒng)在架構(gòu)設(shè)計中都應(yīng)保持黑盒子”的觀點，過于理想化了。對于業(yè)務(wù)層、通用協(xié)作機制而言，經(jīng)常需要在架構(gòu)設(shè)計期間就引入“灰盒”級描述。參考：類圖和灰盒包圖，在本節(jié)中較多出現(xiàn)。下圖為一灰盒包圖示例。ADMEMSPage9of17枝H鼻陽IfiH方景ProjectName>Version:<1.0>SoftwareArchitectur

14、eDocumentDate:<yyyy-mm-dd><documentidentifier>:口，才p忸r模式；展現(xiàn)層國電數(shù)據(jù)-inter!het?GanttChartdtGanttChartfmpI束白笫三方的H特圖第制包業(yè)務(wù)所-inieillicqj!PrgMgtModel6. 開發(fā)架構(gòu)視圖關(guān)注點：此架構(gòu)設(shè)計視圖的關(guān)注點是程序單元組織。注意：此架構(gòu)設(shè)計視圖是必須的、不應(yīng)“剪裁”掉的。但實際情況卻是，很多架構(gòu)師不關(guān)注開發(fā)架構(gòu)視圖，導(dǎo)致很多程序開發(fā)人員抱怨“架構(gòu)師就知道高來高去，架構(gòu)對編程工作沒什么指導(dǎo)性”。6.1 Project劃分內(nèi)容：本節(jié)說明整個系統(tǒng)將劃分成哪幾個

15、Project來開發(fā)，其中，Project指開發(fā)環(huán)境所感知到的“工程”。意義：基本好處是，有利于開發(fā)的組織；而對一些大型的集成系統(tǒng)而言，由于同時涉及了Web應(yīng)用、桌面應(yīng)用、嵌入式應(yīng)用等軟件形態(tài)，所以此時Project劃分其實是不得不做的；最后，我們推薦核心代碼應(yīng)主動地切分到單獨的Project以進行獨立的軟件配置管理（SCM）,以降低核心代碼外泄的風(fēng)險。參考：Project劃分必然是屬于“架構(gòu)設(shè)計”的工作，嚴格來講僅靠“需求分析”劃分的業(yè)務(wù)域（BusinessArea）直接映射到Project經(jīng)常意味著工作內(nèi)容的遺漏。其實，業(yè)界不少有見地的專家已經(jīng)認識到WBS（工作分解結(jié)構(gòu)）做得太早太草率危害

16、很大，就與“Project劃分不到位”不無關(guān)系。6.2 Project1內(nèi)容：對Project劃分后的每個Project進行目錄結(jié)構(gòu)、程序單元組織、框架與應(yīng)用關(guān)系的說ADMEMSPage10of17裁巴人由力京ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>明。6.2.1 Project目錄結(jié)構(gòu)指導(dǎo)內(nèi)容：關(guān)于該Project一級目錄、二級目錄等基本目錄結(jié)構(gòu)的約定。意義：為團隊并行開發(fā)提供必要基礎(chǔ)，讓不同程序小組看到自己應(yīng)該

17、負責(zé)的程序目錄。參考：不要把所有程序目錄的約定都定義得太細，否則這份架構(gòu)文檔就要天天更新了。6.2.2 程序單元組織內(nèi)容：源碼、程序庫、框架、目標碼等類型程序單元之間的編譯依賴關(guān)系。意義：或許有人認為這沒什么技術(shù)含量，但架構(gòu)設(shè)計本來就不是只關(guān)心技術(shù)含量最高問題的。君不見，很多軟件工程師跳槽到新的企業(yè)之后，竟然連一個能正常編譯源碼的開發(fā)環(huán)境都建不起來其實，他們“不知道Project所依賴的Library有哪些”是其中重要原因這本應(yīng)在架構(gòu)文檔中給出明確描述的。6.2.3 框架與應(yīng)用之間的關(guān)系(可選)內(nèi)容：框架(Framework)。意義：既然不適用Framework的開發(fā)越來越少了，既然程序員犯的

18、很多錯誤都和對Framework理解不到位有關(guān)，架構(gòu)師就有責(zé)任明確說明Framework和待開發(fā)系統(tǒng)之間的關(guān)系。參考：下圖描述了JGraph框架和待開發(fā)應(yīng)用的關(guān)系。參考：下圖描述了Struts框架和待開發(fā)應(yīng)用的關(guān)系。<ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>應(yīng)用區(qū)View6.3Project2A-rtinnKarra*i-llidikiei)網(wǎng)電出EMContmllftrSlrylr?oo-nfigxmlAc

19、tionS4rvIplWMvciivn"eciitMT.AiCiludiexmrri)ModtolHyBeani內(nèi)容：對Project劃分后的每個Project進行目錄結(jié)構(gòu)、程序單元組織、框架與應(yīng)用關(guān)系的說明。6.4Projectn內(nèi)容：對Project劃分后的每個Project進行目錄結(jié)構(gòu)、程序單元組織、框架與應(yīng)用關(guān)系的說明。7.運行架構(gòu)視圖關(guān)注點：此架構(gòu)設(shè)計視圖的關(guān)注點是控制流組織。注意：進程和線程是廣為人知的控制流實現(xiàn)技術(shù)，但在架構(gòu)設(shè)計思維當(dāng)中，對于系統(tǒng)軟件和嵌入式軟件極為重要的中斷服務(wù)程序也是控制流，這樣利于架構(gòu)師統(tǒng)一利用不同控制流手段設(shè)計并行和并發(fā)。7.1控制流組織內(nèi)容：控

20、制流有哪些，每條控制流各是何種形式（例如進程、線程、中斷服務(wù)程序），哪些軟件單元是控制流的起點，整條控制流中分別調(diào)用了哪些軟件單元。意義：這是對系統(tǒng)運行時結(jié)構(gòu)的刻畫，主要反映系統(tǒng)的動態(tài)結(jié)構(gòu)。ADMEMS裁姆提同由J方在<ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>7.2 控制流的創(chuàng)建、銷毀、通信內(nèi)容：描述進程、線程和中斷服務(wù)程序的創(chuàng)建和銷毀，以及多條控制流之間的通信關(guān)系的定義。意義：一旦引入了多條控制流，附加工作

21、就產(chǎn)生了一一此時控制流的創(chuàng)建和銷毀、以及控制流之間的通信關(guān)系往往是必須考慮的。7.3 加鎖設(shè)計內(nèi)容：系統(tǒng)中有多條控制流在同時運行的情況下，一個經(jīng)典問題是多于一條控制流可能會同時修改某些數(shù)據(jù)結(jié)構(gòu)，而造成數(shù)據(jù)的不一致。為此，架構(gòu)師需要關(guān)注加鎖設(shè)計，合理引入臨界區(qū)或同步機制。意義：加鎖設(shè)計事關(guān)系統(tǒng)的正確性。值得注意的是，忽略加鎖設(shè)計造成的問題往往以“不易重現(xiàn)的Bug”的形式出現(xiàn)，困惑的程序員會對測試人員說，“你看你報的Bug在我機器上根本就不存在呀"。參考：對通用組件、通用模塊的設(shè)計而言，加鎖設(shè)計應(yīng)予以專門關(guān)注，思維要點是研究未來通用模塊的各種可能使用場景。8. 物理架構(gòu)視圖關(guān)注點：此架構(gòu)

22、設(shè)計視圖的關(guān)注點是物理節(jié)點（Node）分布，以及軟件到硬件的具體映射關(guān)系。注意：物理節(jié)點即可以是PC機或服務(wù)器，也可以是單片機、單板機或?qū)Ｓ脵C，從而物理架構(gòu)視圖既適用于描述企業(yè)信息系統(tǒng)，也適合于描述嵌入式軟件系統(tǒng)。8.1 物理拓撲內(nèi)容：一為硬件選型，二為硬件之間的拓撲連接關(guān)系。意義：對于分布式系統(tǒng)的設(shè)計，此節(jié)極為重要、而且是必須的。參考：下圖是某企業(yè)級系統(tǒng)的物理拓撲圖。<ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>

23、;數(shù)據(jù)左業(yè)務(wù)居(Tlet)!上融修庫部門管珅看PC一參考：下圖是某嵌入式系統(tǒng)的物理拓撲圖。8.2 軟件到硬件的映射內(nèi)容：明確每個物理節(jié)點上有哪些（一到多個）軟件的目標單元，并說明具體的“映射方式”是安裝、是部署、還是燒寫、抑或是下載。ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd>documentidentifier>意義：如果把此節(jié)漏了，就無法表明本文檔的主題一一軟件系統(tǒng)一一和上述硬件、硬件拓撲的關(guān)系。參考：下圖所示為設(shè)備調(diào)試系統(tǒng)中，軟件到硬件的映射關(guān)系。中嵬面部分

24、IItsxtgui.exe調(diào)試機S嵌入部分tsxt.hex8.3 優(yōu)化部署內(nèi)容：為達降低成本、提高性能和可靠性等等目標，應(yīng)特別關(guān)注的部署考慮。意義：物理架構(gòu)設(shè)計的優(yōu)劣，造成的成本差異和質(zhì)量差異，可能是天壤之別。所以必須重視。網(wǎng)絡(luò)爭用最終目標投資與維護成本合理睚柱能目標的滿足設(shè)出內(nèi)容節(jié)點選擇分布柘撲軟件單元和數(shù)據(jù)單元的職責(zé)與分布噌加Cd廿舊等饅計架枸肺思維要點計茸和通信開第小刁蚪葉室和通信時即硬盤心PUJ陶靖沖突經(jīng)濟性技木可行性屬維護性可伸縮性目標層性能持續(xù)可用性通信開銷計算開銷內(nèi)哼爭用CFU爭用謔盤爭用政據(jù)爭用軟件單元結(jié)果層I-p'IL*參考：下圖展示的，是ADMEMS方法重點推薦的“

25、物理架構(gòu)設(shè)計思維要點”，更多內(nèi)容可參考一線架構(gòu)師實踐指南一書。9. 數(shù)據(jù)架構(gòu)視圖關(guān)注點：此架構(gòu)設(shè)計視圖的關(guān)注點是持久化。具體而言，場景化可以借助扁平文件、關(guān)系數(shù)據(jù)庫、實時數(shù)據(jù)庫、Flash等方式中的一種或多種完成。<ProjectName>Version:<1.0>SoftwareArchitectureDocumentDate:<yyyy-mm-dd><documentidentifier>注意：本視圖單獨歸檔時，請在此節(jié)注明其文檔名稱等信息。9.1 持久化機制的選擇內(nèi)容：如下持久化機制的一種或多種：扁平文件、關(guān)系數(shù)據(jù)庫、實時數(shù)據(jù)庫、Flasho意義：不要假設(shè)在你的系統(tǒng)中，持久化只需一種機制；隨著如今的系統(tǒng)變得越來越復(fù)雜，我們經(jīng)常需要綜合利用不同持久化機制。9.2 持久化存儲方案