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.
In this repository26 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .cursor/rules/automate-before-manual.mdcCursor rule
- .cursor/rules/finish-task-dev-server.mdcCursor rule
- brainstormingSkill
- caveman-commitSkill
- find-skillsSkill
- semantic-versionSkill
- systematic-debuggingSkill
- verification-before-completionSkill
- writing-plansSkill
- ask-before-architectureSkill
- automate-before-manualSkill
- caveman-commitSkill
- dont-be-lazySkill
- dont-forgetSkill
- find-jobSkill
- finish-with-dev-serverSkill
- google-calendar-mcpSkill
- init-fmzSkill
- instagram-chrome-postSkill
- project-initSkill
- recapSkill
- semantic-versionSkill
- skills-sh-maintainerSkill
- ui-change-e2eSkill
- validate-before-shareSkill
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
- Very specific: line 14
Use Mermaid (flowchart, sequenceDiagram, stateDiagram, erDiagram) in Markdown and specs.
- Distinctive: line 16
Update diagrams when the flow changes.
- Very specific: line 18
Prefer flowchart / sequenceDiagram.
- Distinctive: line 22
Every Mermaid block must parse successfully: before you send the doc or message.
- Distinctive: line 26
Write the Mermaid block.
- Distinctive: line 33
If validation fails, fix the diagram and re-run — do not show broken Mermaid to the user.
≈ “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.
Files
Diagrams — Mermaid
Rules
- Use Mermaid (
flowchart,sequenceDiagram,stateDiagram,erDiagram) in Markdown and specs. - Never hand-draw ASCII diagrams (boxes with
|---|, trees in plain text). - Update diagrams when the flow changes.
- Exception: terminal commands and config snippets are not diagrams.
- Prefer
flowchart/sequenceDiagram; avoidblock-beta(poor viewer support).
Validate before showing the user
Every Mermaid block must parse successfully before you send the doc or message.
Workflow
- Write the Mermaid block.
- Validate syntax:
On Windows if# Write block to a temp .mmd file, then: npx -y @mermaid-js/mermaid-cli -i diagram.mmd -o diagram.svg-ofails, use-o nulor-o diagram.svgin a temp folder. - If validation fails, fix the diagram and re-run — do not show broken Mermaid to the user.
- 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.
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
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.

