建立精確、美觀且符合標準的軟體架構圖傳統上對開發人員和架構師而言是一項耗時的工作。從概念設計到完成圖示之間的差距,通常需要數小時的手動拖放操作。然而,人工智慧與建模工具的整合已彌補了這段差距。
這個Visual Paradigm AI C4 Studio(也稱為 AI 驅動的 C4 Studio)是整合於 Visual Paradigm Online 的尖端工具。它讓使用者能透過自然語言描述生成完整的C4 模型圖自然語言描述。透過利用人工智慧撰寫 PlantUML 程式碼,能立即將文字轉換為視覺化層級結構。
本逐步教學將介紹如何使用此工具來記錄一個軟體系統,以一個線上食物外送平台作為實際範例。
軟體架構中的關鍵概念
在深入使用工具之前,了解支撐AI C4 Studio.
C4 模型
由軟體架構師Simon Brown所創建的C4 模型是一種層級式的軟體架構圖繪製方法。它如同數位地圖,可從高階概觀逐步縮放至實作細節。它包含四個主要的抽象層級:
- 第一層:系統環境:這是「整體概觀」。它將軟體系統以中央的一個方框呈現,周圍則是與之互動的使用者(人物角色)與外部系統(例如:付款網關、電子郵件伺服器)。
- 第二層:容器:此層級深入軟體系統,呈現高階的構建模組或「容器」。範例包括網頁應用程式、行動應用程式、資料庫與微服務。
- 第三層:組件: 此層級將每個容器分解,以顯示其內部組件及其互動。
- 第4層:程式碼: 這展示了組件是如何實現的(例如,類圖 注意,Visual Paradigm 的 AI 工具專注於生成第1至第3層,第4層則留給基於 IDE 的工具,這與 C4 哲學一致,即將高階架構與程式碼分離。
PlantUML
背後,AI C4 Studio 使用了PlantUML。這是一款開源工具,允許使用者透過純文字語言建立圖表。由於 AI 會產生 PlantUML 程式碼,因此生成的圖表並非靜態影像;而是完全可編輯的文字定義,必要時可手動調整。
逐步指南:使用 AI 建立 C4 模型
依照以下步驟,為線上食物外送平台生成完整的架構文件。
步驟 1:存取工具
首先,登入您的Visual Paradigm Online工作區。此工具為雲端導向,方便存取與協作。
- 導航至儀表板,並在右上角找到使用 AI 建立按鈕。
- 選擇瀏覽 AI 應用程式.
- 在搜尋欄中輸入「C4」以篩選結果。
- 選擇AI C4 Studio,並按一下立即開始.
步驟 2:定義專案範圍
AI需要上下文才能生成準確的圖表。您將提供系統的身分以及它解決的問題。
- 專案名稱: 輸入「線上外送平台」。
- 系統背景: 提供系統功能的高階描述。您可以手動輸入,或點擊產生背景 讓AI根據專案名稱撰寫描述。請確保描述中提及關鍵互動,例如客戶下訂餐點、餐廳接收訂單,以及外送員送達餐點。
- 問題陳述: 描述系統所解決的挑戰(例如:「使用者需要一種方便的遠端訂餐方式」,或「餐廳需要一個簡化訂單管理的系統」)。您也可以在此使用產生 按鈕取得AI協助。
提示:生成圖表的品質取決於這些文字輸入的精確度。請在繼續前審查並優化它們。
步驟 3:產生核心 C4 圖表
設定背景後,您即可產生 C4 模型的層級視圖。該工具會將這些視圖分類為標籤頁。
等級 1:系統背景
切換至系統背景 標籤頁,並點擊產生圖表。AI 將分析您的描述,並產生兩個輸出:
- 左側面板: 產生的 PlantUML 程式碼。
- 右側面板: 圖表的視覺化呈現,顯示外送平台與客戶、餐廳及外送員之間的互動。
等級 2:容器
導航至容器 標籤頁,並點擊產生圖表。AI 將「放大」以揭示架構的組成單元。您應預期會看到如下的容器:
- 單頁應用程式(網頁應用程式)
- 行動應用程式
- API 網關或後端 API
- 資料庫
第 3 層:元件
查看特定容器的內部結構:
- 前往元件分頁。
- 從下拉式清單中選擇特定的容器(例如:「API 應用程式」)。
- 按一下產生圖表.
針對您希望詳細說明的每個容器重複此流程。這將提供後端內部控制器、服務與儲存庫的細節視圖。
步驟 4:產生補充視圖
C4 模型包含補充圖表,用以說明更廣泛的生態系、部署方式以及執行時行為。
- 系統地圖:使用地圖分頁來產生一個視圖,將您的系統置於包含多個軟體系統的廣泛企業生態系中。
- 動態與序列圖:使用動態與序列分頁來呈現行為。選擇一個容器或元件,然後按一下產生。這將以圖示方式呈現訊息在時間上的傳遞流程(例如:使用者下訂單時的事件序列)。
- 部署:使用部署分頁將您的容器對應至基礎設施。AI 將建議一個部署架構,例如將網頁應用程式對應至 CDN,將 API 對應至雲端伺服器,並將資料庫轉換為管理式資料庫服務。
步驟 5:管理、編輯與匯出
AI C4 Studio 最強大的功能之一是彈性。您不會被鎖定在最初的 AI 生成內容中。
- 可編輯性: 如果 AI 遺漏了某個關係,您可以在左側面板中直接修改 PlantUML 文字,圖表將立即更新。
- 匯出: 您可以將您的會話匯出為 JSON 檔案。這讓您可以備份您的工作,或將其匯入其他工具。
- 整合: 透過 檔案 > 儲存 將專案儲存至您的 Visual Paradigm Online 工作區。您可以將這些圖表匯入完整的 Visual Paradigm 圖表編輯器 以進行進階樣式設定、格式化與手動微調。
結論
Visual Paradigm 的 AI C4 Studio 使軟體建模更加普及。透過自動化 C4 模型第 1、2、3 級的建立,讓團隊能在數分鐘內而非數天內產出一致且高品質的文件。當 AI 處理語法與結構的繁重工作時,架構師可以專注於邏輯的優化與高階設計問題的解決。無論是新成員的入職訓練,還是向利害關係人展示,此工具都能確保您的架構圖清晰、專業且即時更新。