agentleFS
farukzahrafarukzahra/agent-skills/skills/diagrams-mermaid/SKILL.md

diagrams-mermaid

Skill0 starsChanged 2 months agoMITView on GitHub

Use Mermaid for flow and architecture diagrams; validate syntax before showing the user. Never hand-drawn ASCII diagrams. Use in specs, ADRs, README, or when explaining flows.

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 4 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use Mermaid (flowchart, sequenceDiagram, stateDiagram, erDiagram) in Markdown and specs.

    line 14
  2. Distinctive:

    Update diagrams when the flow changes.

    line 16
  3. Very specific:

    Prefer flowchart / sequenceDiagram.

    line 18
  4. Distinctive:

    Every Mermaid block must parse successfully: before you send the doc or message.

    line 22
  5. Distinctive:

    Write the Mermaid block.

    line 26
  6. Distinctive:

    If validation fails, fix the diagram and re-run — do not show broken Mermaid to the user.

    line 33

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Diagrams — Mermaid

Rules

  1. Use Mermaid (flowchart, sequenceDiagram, stateDiagram, erDiagram) in Markdown and specs.
  2. Never hand-draw ASCII diagrams (boxes with |---|, trees in plain text).
  3. Update diagrams when the flow changes.
  4. Exception: terminal commands and config snippets are not diagrams.
  5. Prefer flowchart / sequenceDiagram; avoid block-beta (poor viewer support).

Validate before showing the user

Every Mermaid block must parse successfully before you send the doc or message.

Workflow

  1. Write the Mermaid block.
  2. Validate syntax:
    # Write block to a temp .mmd file, then:
    npx -y @mermaid-js/mermaid-cli -i diagram.mmd -o diagram.svg
    On Windows if -o fails, use -o nul or -o diagram.svg in a temp folder.
  3. If validation fails, fix the diagram and re-run — do not show broken Mermaid to the user.
  4. Optional quick check: mermaid.live only when CLI is unavailable; still fix errors before final output.

In specs

Store diagrams in docs/superpowers/specs/ or docs/ alongside prose — they are part of the approved design.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.