實踐篇(三):如何有效評審軟體架構圖?

来源:https://www.cnblogs.com/Jcloud/archive/2023/02/22/17140223.html
-Advertisement-
Play Games

設計意圖的傳達是架構可視化關註的重要維度,在技術方案評審過程中不可避免的會出現各種各樣的架構圖或設計圖,這些圖形化表述在設計意圖傳達效果層面表現不一,本文從圖形化的視角為軟體架構圖的評審關註點提供了參考。 ...


作者:京東科技 倪新明

設計意圖的傳達是架構可視化關註的重要維度,在技術方案評審過程中不可避免的會出現各種各樣的架構圖或設計圖,這些圖形化表述在設計意圖傳達效果層面表現不一,本文從圖形化的視角為軟體架構圖的評審關註點提供了參考。

註:關於架構及架構可視化參考文章 《 探尋軟體架構的本質,到底什麼是架構? 》 《 軟體架構可視化及C4模型:架構設計不僅僅是UML


 

1 原則

明確的主題:架構圖要表達的意圖明確,比如是容器圖、組件圖還是部署圖 一致的抽象層級:保持一致的抽象層級,不應超過2個以上的層次變化 粒度合適的範圍:不應試圖在一張圖表達“所有的東西”,每張架構圖聚焦於自身職責邊界的範圍 清晰的圖例說明:對架構圖顏色、形狀等有明確的圖例,以方便閱讀導航 圖形顏色不宜太多:過多顏色增加認知成本,建議不超過 4 種 圖形元素不宜太多:過多圖形元素增加認知成本 明確的連線關係描述

2 評審檢查單

如同上線檢查單和開發檢查單,針對於軟體架構圖的評審制定一套檢查單同樣具有價值。不論架構設計者,還是參與設計評審的開發人員,對於形式各異的 “架構圖” 是提供通用的參考關註點,以便干係人更多、更深入、更高效、更有針對性的獲取架構圖的更多信息。

2.1 通用檢查項

架構圖是否具有標題? 是否能夠理解架構圖的類型是什麼? 是否能夠理解架構圖的範圍是什麼? 架構圖是否有圖例

2.2 元素

架構圖中每一個元素是否有名字 是否能夠理解架構圖中每個元素的類型? (比如,抽象級別,軟體系統?容器?組件?等等) 是否能夠理解架構圖中的每個元素是做什麼的?簡要描述信息? 是否能夠理解與該元素相關的技術選型(適合標明技術選型的元素) 是否能夠理解架構圖中使用的所有縮寫/簡稱的含義? 是否能夠理解架構圖中元素使用的所有顏色的含義 是否能夠理解架構圖中元素使用的所有形狀的含義 是否能夠理解架構圖中元素使用的所有圖標的含義? 是否能夠理解架構圖中元素使用的所有邊框樣式的含義? (比如,實線 vs 虛線) 是否能夠理解架構圖中使用的所有元素大小的含義? (比如, 小框 vs 大框 )

2.3 關聯關係

架構圖中的每條線是否有描述關係含義的信息? 是否能夠理解架構圖中的每個關聯關係適合標明技術選型的場景技術選型是什麼? (比如,進程間的交互的協議) 是否能夠理解架構圖中的關聯關係的簡稱或縮寫 是否能夠理解架構圖中的連線顏色的含義? 是否能夠理解架構圖中的連線箭頭的含義? 是否能夠理解架構圖中的連線樣式的含義? (比如,實線 vs 虛線)

3 結語

本文描述了軟體架構圖的一些評審關註點,其實不只是評審的視角,對於任何一個圖形化的軟體系統架構或設計表訴,如何能夠快速的瞭解其要表達的意圖至關重要,對於設計者而言如何快速傳遞架構設計信息並於干係人達成一致也至關重要。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 原理:dispatchEvent 自定義觸發事件,常用於自定義滑鼠事件或點擊事件 ,原生控制項input打開上傳文件方案:vue項目,點擊自己的上傳文件圖標,通過dispatchEvent主動觸發一個自定義上傳文件事件 . 原生控制項 input accept 屬性: accept = "audio/* ...
  • for in 遍歷對象,返回的是對象的key; 遍曆數組/字元串,返回的是數組的下標for of 只能遍歷的是數組 遍曆數組對象,返回單個對象; 遍曆數組元素/字元串,返回單個元素 舉例說明: 可以看到得出: for in 能夠遍歷對象 for of 不能遍歷對象 可以看到得出: for in 能夠 ...
  • 要將一張圖片垂直和水平居中在一個 <div> 元素中,你可以使用以下 CSS 樣式: div { display: flex; justify-content: center; align-items: center; } img { max-width: 100%; max-height: 100 ...
  • Bearer token是一種常見的身份驗證機制,通常用於Web API和其他Web服務。在前端中,Bearer token通常是通過HTTP頭(HTTP header)發送的,具體來說是通過"Authorization"頭。 在使用Bearer token進行身份驗證時,需要將token包含在HT ...
  • 在JavaScript中,可以使用 slice() 方法來截取數組的一部分。該方法接受兩個參數,第一個參數是截取的起始位置(包括該位置),第二個參數是截取的結束位置(不包括該位置)。 例如,假設有一個數組 myArray: var myArray = [1, 2, 3, 4, 5]; 要截取從第二個 ...
  • 問題 利用 map() 把字元串數組映射成整數數組 ["1", "2", "3"].map(parseInt); 是不是覺得結果應該返回 [1, 2, 3]? 但是事與願違,結果是: Output: [1, NaN, NaN] 為什麼呢? 回顧 parseInt parseInt() 函數解析一個字 ...
  • title: Hbuilder項目轉vue-cli項目 date: 2023-02-22 10:26:33 category: 工作 技能提升 cover: https://s1.ax1x.com/2022/11/23/z8L8PS.jpg tags: uniapp description: Hbu ...
  • 第一等級:代表 內聯樣式,如 style="",權值為 1,0,0,0; 第二等級:代表 ID選擇器,如 #id="", 權值為 0,1,0,0; 第三等級:代表 calss | 偽類 | 屬性 選擇器,如 .class | :hover,:link,:target | [type], 權值 0,0 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...