工程開發
mcaf-architecture-overview avatar

mcaf-architecture-overview

維護一個包含 Mermaid 圖表的集中式架構總覽,記錄系統邊界、模組依賴與介面契約,以利於專案導覽與重構。

簡介

此技能作為架構文件的主要維護工具,專注於 docs/Architecture/Overview.md 的管理。它提供了一種結構化的機制來定義軟體專案的全局架構圖,確保系統邊界、核心模組與介面契約與實際程式碼保持同步。透過強制使用 Mermaid 圖表,代理程式能建立既易於人類閱讀又便於機器導覽的系統架構視覺化表示。此技能旨在防止「架構漂移」,要求每個圖表元素都必須參考真實的組件或檔案路徑,避免使用預留位置或抽象推測。對於正在進行導入、重大重構或定義複雜系統新邊界的團隊而言至關重要。它遵循 MCAF(模型-上下文-架構-框架)標準,確保架構決策連結至 ADR 與功能,而不會因行為邏輯或實作細節導致總覽雜亂。

  • 根據現有的資料夾結構與命名空間自動生成或更新 docs/Architecture/Overview.md

  • 使用標準化 Mermaid 圖表視覺化模組邊界、依賴方向與核心介面契約。

  • 透過將每個圖表元素連結至對應的原始碼或文件,為開發人員與代理程式提供「從這裡開始」的導覽點。

  • 透過執行依賴規則(允許與禁止的呼叫)並識別橫向關注點,維護嚴格的架構完整性。

  • 透過在 1 分鐘內的閱讀時間內總結系統職責與高階互動模式,促進專案導入效率。

  • 代理程式預期現有的資料夾結構能代表領域邊界(如 Docs/Architecture/Docs/ADR/)。

  • 在提議更改之前務必驗證當前架構狀態,以確保不會引入虛構的組件或無意義的內容。

  • 使用此技能來保持文件穩定;僅在結構邊界或重大互動模式變更時進行更新。

  • 專注於結構圖而非行為流程;將行為特定文件委託給 docs/Features/

  • 確保每張圖表保持可讀性;如果系統變得過於複雜,請透過邊界進行拆分以保持清晰度。

倉庫統計

Star 數
18
Fork 數
0
Open Issue 數
0
主要語言
C#
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 下午04:46
在 GitHub 查看