Mermaid diagrams
A curated collection of practical, evidence-backed skills for coding agents.
npx -y skills add zacharygcook/agent-skills --skill mermaid-diagramsAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- 26 days oldThe repository was created 26 days ago. New is not bad, but a brand new repository carrying a familiar-sounding name is the shape a typosquat arrives in, and there has been no time for anyone else to find a problem with it.
- 2 stars2 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Create, review, render, and maintain Mermaid diagrams for architecture, flows, sequences, state machines, schemas, timelines, and tradeoffs. Use when a visual model materially clarifies structure or behavior and the result should remain diagrams-as-code or exported SVG/PNG.
SKILL.md
2.2 KB, as published. Nobody here has run it
Mermaid Diagrams
Use a diagram only when relationships, sequence, hierarchy, state, or ownership are harder to understand in prose or a small table.
Choose the Smallest Useful Form
flowchart/graph: pipelines, decisions, dependencies.sequenceDiagram: request/response and async interaction.stateDiagram-v2: lifecycle and transition rules.erDiagram: entities, keys, and cardinality.classDiagram: type/object relationships.- C4 context/container: system boundaries and ownership.
timeline: history or roadmap.quadrantChart: explicit two-axis tradeoffs.
Start with fewer than ten meaningful nodes when possible; split crowded diagrams by concern.
Authoring Rules
- Verify labels and edges against source code or authoritative docs.
- Use short nouns or verb phrases, and quote labels containing punctuation.
- Draw direction only when it carries meaning.
- Encode status or category with color sparingly; never rely on color alone.
- Add a caption that states the diagram's purpose.
- Keep layout deterministic enough that future edits remain readable.
- Prefer SVG for documentation and PNG for quick review when both are supported.
Validate and Render
Use repository-native docs/build tooling first. Otherwise use an already available Mermaid CLI or renderer; do not require a global install merely for a small draft. Inspect the actual render for syntax failures, clipped labels, crossing edges, and light/dark contrast.
Store source and exports according to repository convention. If the user wants only a review artifact, keep scratch source and renders in a gitignored location. If the diagram is durable documentation, track the source next to its consumer and ensure docs do not link to disposable paths.
Handoff
Provide the source, rendered artifact paths, validation command, and any assumptions the diagram makes. Do not claim the visual is authoritative unless it was checked against the implementation.