mermaid

这段内容是审核时保存的快照。外部来源才是完整且最新的版本。

---
name: mermaid
description: Internal routing hub for mermaid diagram skills
user-invocable: false
allowed-tools: Read, Grep, Glob, Bash
---

# Mermaid — Diagram and Documentation Skill

Mermaid diagram and documentation system with specialized guides and code-to-diagram capabilities.

## Entry Points

| Entry point | When to use |
|-------------|-------------|
| `/mermaid-{type}` commands | You know the diagram type — fastest path |
| `/mermaid-diagram` | Unsure of type — describe what you want, gets routed automatically |
| `/mermaid-validate` | Batch-check existing `.md` files for broken diagrams |
| `/mermaid-render` | Render an existing `.mmd` file to SVG |
| `/mermaid-config` | Configure defaults and check dependencies |
| `/mermaid-architect` | Analyze a codebase path and generate a diagram suite |
| `diagram-architect` agent | Claude detects diagram need during active development work |
| This skill (SKILL.md) | Extended sessions: design docs, code-to-diagram, multi-diagram projects |

## Diagram Type Routing

Load only the guide for the requested type. Do not pre-load all guides.

**Suite requests** ("generate diagrams from this codebase", "diagram this project"): use `/mermaid-architect` — it selects multiple diagram types automatically from actual code.

**Ambiguous type** (description matches multiple types): use `/mermaid-diagram` — it asks one clarifying question and routes automatically.

| User wants | Load |
|------------|------|
| Workflow, process, approval flow, user journey | `references/guides/diagrams/activity-diagrams.md` |
| Infrastructure, cloud, K8s, deployment | `references/guides/diagrams/deployment-diagrams.md` |
| System architecture, components, microservices | `references/guides/diagrams/architecture-diagrams.md` |
| API flow, service interactions, request/response | `references/guides/diagrams/sequence-diagrams.md` |
| Class hierarchy, OOP design, data models | `references/guides/diagrams/class-diagrams.md` |
| Database schema, ER model | `references/guides/diagrams/er-diagrams.md` |
| State machines, lifecycle, FSM | `references/guides/diagrams/state-diagrams.md` |

## Reference Guides

| Need | Load |
|------|------|
| Syntax errors, rendering failures | `references/guides/troubleshooting.md` (18 documented patterns) |
| Learning Mermaid, preventing errors | `references/guides/common-mistakes.md` |
| Color schemes, accessibility, themes | `references/guides/styling-guide.md` |
| Production workflow, validation loop | `references/guides/resilient-workflow.md` |
| Quick routing from symptom to action | `references/guides/quick-decision-matrix.md` |

`styling-guide.md` is a special-case reference. Do not load it by default. Load it only when the user explicitly asks for custom palette/theme behavior, brand colors, accessibility tuning, or style overrides.

## Code-to-Diagram

**Routing rule:** if the user names a framework → use the row below. If no framework is named → use `/mermaid-architect`.

| Framework | Load | Which diagram guide |
|-----------|------|---------------------|
| Spring Boot | `examples/spring-boot/README.md` | Routes/controllers → sequence · Models/entities → class · Overview → architecture |
| FastAPI / Python API | `examples/fastapi/README.md` | Endpoints/deps → sequence · Pydantic models → class · Overview → architecture |
| React / frontend | `examples/react/README.md` | architecture (always) |
| Python ETL / batch | `examples/python-etl/README.md` | activity (always) |
| Node/Express | `examples/node-webapp/README.md` | Middleware/routes → sequence · Overview → architecture |
| Java Web App | `examples/java-webapp/README.md` | Routes → sequence · Models → class · Overview → architecture |
| Any codebase | `references/guides/code-to-diagram/README.md` | Master guide determines type |

## Design Document Templates (`assets/`)

| Template | When to load |
|----------|--------------|
| `architecture-design-template.md` | "Create architecture doc", "Document system design