opencode-workflow/skills/generate_mermaid_diagram
王性驊 acd1d057af add AGENTS 2026-04-10 22:44:49 +08:00
..
README.zh-TW.md add AGENTS 2026-04-10 22:44:49 +08:00
SKILL.md add AGENTS 2026-04-10 22:39:08 +08:00

README.zh-TW.md

產生 Mermaid 圖表 (Generate Mermaid Diagram) 技能指南

概述

generate_mermaid_diagram 是可交付技能,用來產生系統架構圖、序列圖、資料流圖、事件流圖與狀態機圖。供 design-architecture 在產生 Mermaid Diagrams 章節時參考。

核心原則

圖表必須可視化系統架構,且所有圖表中的元件都必須在架構文件文字中描述。不得有無法對應到實際元件的孤兒元件。

必備圖表(至少 3 張)

  1. System Architecture Diagram:所有服務、資料庫、佇列、快取與外部整合及其連接方式
  2. Sequence Diagram:主要快樂路徑的互動流程
  3. Data Flow Diagram:資料如何流經系統,含轉換與儲存點

選用圖表

  • Event Flow Diagram:事件如何傳播
  • State Machine Diagram:實體生命週期與狀態轉換

圖表指南

  • 命名慣例Services 用 PascalCaseDatabases 用 DB suffixQueues/Topics 用描述性名稱
  • 關係標籤:同步用 -->,非同步用 -.->
  • 元件命名:有意義的標籤,非縮寫(除非文件中已定義縮寫)

防範佔位符規則

範例僅供說明用途。不要重複使用範例中的佔位符元件、服務、資料庫或關係。

不應做的事

  • 不產生與架構文件內容無關的圖表
  • 不產生獨立圖表檔案(所有圖表必須嵌入 docs/architecture/{feature}.md