Communitygithub.com

ChaoChuan05/Agent-Skills

根據需求或程式碼建立、完善或審查系統分析與軟體架構圖表,包括 UML、ERD、DFD、C4、BPMN 和工作流程,支援圖表選擇、符號檢查、跨圖一致性及可編輯的 Draw.io 交付物。

Agent-Skills 是什麼?

此技能專為需要從需求或程式碼建立、完善或審查系統分析與軟體架構圖表的開發者與 AI 代理設計。它支援多種圖表類型,包括 UML、實體關係圖(ERD)、資料流程圖(DFD)、C4 模型、BPMN 以及流程圖,並優先使用可編輯的 Draw.io 格式(.drawio)作為正式圖表。技能流程包含八大步驟:從確立受眾與系統邊界開始,接著透過參考路由表選擇合適的視圖,建構語義清單後遵循特定繪圖程序,再利用內建腳本驗證 XML 結構,並在 diagrams.net 中檢查渲染問題,最終交付可編輯的原始檔與預覽。此技能特別強調模型事實必須來自證據或明確標記的假設,並包含多項不可協商的檢查,例如驗證端點語義(DFD 箭頭傳遞資料,UML/BPMN 控制流代表執行意義)、避免從外鍵推斷生命週期所有權,以及維持圖表可編輯性(避免嵌入影像)。技能預期與 Claude Code、Cursor 或 Codex 等代理平台相容,並透過參考文件(如 diagram-validation.md、sources.md)和可執行腳本(validate_drawio.py)確保結構與語義正確性。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/ChaoChuan05/Agent-Skills/tree/HEAD/skill/system-design

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

系統設計

建立能回答使用者問題的最小視圖集合。對於正式圖表,優先使用可編輯的 .drawio 格式;尊重要求的符號系統、格式、課程評分標準以及現有檔案。有效的 XML 檔案並不等於正確的模型。

工作流程

  1. 確立受眾、系統邊界、問題、情境與抽象層次。閱讀提供的需求/綱要/程式碼以及任何評分標準。將不確定的基數、權限、生命週期規則和外部介面記錄為假設;僅在這些假設會實質改變答案時才提問。不要憑空發明基礎設施或強制性的關係。
  2. 使用下方的路由表選擇視圖。僅閱讀相關的參考資料以及 diagram-validation.md。區分現狀證據與提議設計。當多個圖表共享概念時,建立一個小型詞彙表,並使用穩定的概念 ID。
  3. 在放置形狀之前建立語義清單:參與者/元素、帶有方向和端點意義的關係、限制條件以及需求 ID。對於 DFD,加入流程字典和分解邊界簽章;對於資料模型,識別鍵與相依性。
  4. 遵循特定圖表的繪製程序。明確設定符號系統(例如 UML 2、Crow's Foot、Gane-Sarson;先情境圖再層級-0)。將語義規則與建議的版面配置選擇分開。如 sources.md 所述解決衝突來源。
  5. 對於 Draw.io,閱讀 drawio-rendering.md 和 layout.md。使用原生形狀和連接器建立穩定的 ID,並採用 XML 序列化器。僅在替換網域事實後,才複製相關範例。對於其他格式,閱讀 fallbacks.md。
  6. 執行 python3 <skill-dir>/scripts/validate_drawio.py <file-or-directory>。修復回報的結構性錯誤。使用語義和跨視圖檢查清單:該腳本無法證明 UML、DFD、ERD 或 BPMN 的正確性。
  7. 在 diagrams.net 中開啟/匯入,或使用可用的 Draw.io 渲染器匯出。檢查每一頁的標籤、箭頭末端、裁剪、包含關係與交叉;調整後再次檢查。如果沒有可用的渲染器,則交付可編輯的原始檔,並明確報告渲染未經驗證。請勿將 XML 解析視為可開啟性的測試。
  8. 交付原始檔、有用的預覽,以及簡短的驗證/假設說明。明確說明執行了哪些檢查。在編輯過程中保留現有的手動版面配置和不相關的頁面;更新過時的預覽。

參考路由表

使用者問題閱讀
UML 選擇 / 符號系統基準uml.md
參與者與使用者目標use-case.md
領域或軟體結構class-diagram.md
跨協作者的一個情境sequence-diagram.md
工作流程、分支、並行activity-diagram.md
單一實體的事件驅動生命週期state-machine.md
實例、鏈結、模組、執行時期配置structural-views.md
通訊、時序、互動概覽advanced-interactions.md
實體、關係、關聯式綱要erd.md, normalization.md
資料移動與分解dfd.md, context-diagram.md
架構層級c4-model.md
業務協作/流程bpmn.md
簡單程序或責任交接flowchart-swimlane.md
輸出生成 / 潤飾drawio-rendering.md, layout.md, fallbacks.md
審查 / 多視圖一致性diagram-validation.md
來源出處 / 版本 / 限制sources.md

輸出慣例

尊重使用者指定的路徑。否則使用 docs/diagrams/<系統>-<視圖>.drawio,並在可能的情況下提供對應的 .svg 或 .png 預覽。對於非平凡的假設,使用 <系統>-assumptions.md;對於多視圖審計,使用 <系統>-validation.md。將暫存匯出檔保留在最終交付物之外。對於獨立維護的視圖,使用獨立的檔案;對於協調的圖表集,使用命名的頁面。切勿在未告知的情況下,將要求的正式符號系統替換為通用流程圖。

不可協商的檢查

  • 模型事實必須來自證據或標記的假設。
  • 檢查端點語義;指向錯誤方向的箭頭在語法上可能仍是有效的。
  • DFD 箭頭傳遞資料;UML/BPMN 控制流傳遞執行意義。
  • 請勿從外鍵或模糊的「has-a」片語推斷生命週期所有權。
  • 審查相關的共用概念;對於不同範圍的視圖,不需要要求完全相同的內容。
  • 保持圖表可編輯;嵌入在 .drawio 檔案中的影像不是原生圖表。

範例和可執行的檢查位於 examples/ 和 scripts/ 目錄中。特定套件的測試證據位於 TEST-REPORT.md。

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

ChaoChuan05/Agent-Skills

Diagnose bugs and failures through reproduction, connected-flow evidence, and root-cause testing; recommend or apply the smallest authorized fix. Also handles explicit behavior-preserving refactoring and structural repair. Use for broken behavior, unexplained errors, or requested refactors; broad quality review and release verification belong to qa-tester.

ChaoChuan05/Agent-Skills

Turn a requested feature, change, or established fix into a repository-grounded implementation plan before coding. Use for implementation sequencing, affected-file and contract analysis, migration risks, and test acceptance planning. Planning does not authorize implementation; unexplained failures belong to debug-and-refactor and architectural modeling to system-design when needed.

ChaoChuan05/Agent-Skills

Test whether software satisfies its requirements. Use for QA reviews, acceptance testing, requirements traceability, test plans, exploratory testing, API/database/UI checks, defect reproduction, regression, fix verification and release readiness. Compare expected and actual behavior with evidence; existing passing tests alone are insufficient. Apply implementation fixes only when the user's task authorizes them.

ChaoChuan05/Agent-Skills

Create, audit, or maintain implementation-grounded developer documentation for software repositories. Use for README, onboarding, setup, configuration, architecture, API reference, deployment runbooks, troubleshooting, undocumented environment variables, and stale documentation. Inspect code and verify procedures; do not use for marketing copy or implementation changes alone.

相關技能