utility-mermaid-diagrams
Skill777 starsChanged 10 months agoApache-2.0View on GitHub
Teaches PMs to create syntactically valid mermaid diagrams by selecting the right diagram type for their communication need, following syntax validity rules, and validating before shipping. Covers all 15 mermaid diagram types with PM-relevant examples and a dual-lens navigation system.
In this repository69 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- define-hypothesisSkill
- define-jtbd-canvasSkill
- define-opportunity-treeSkill
- define-prioritization-frameworkSkill
- define-problem-statementSkill
- deliver-acceptance-criteriaSkill
- deliver-edge-casesSkill
- deliver-launch-checklistSkill
- deliver-prdSkill
- deliver-release-notesSkill
- deliver-user-storiesSkill
- develop-adrSkill
- develop-design-rationaleSkill
- develop-solution-briefSkill
- develop-spike-summarySkill
- discover-competitive-analysisSkill
- discover-interview-synthesisSkill
- discover-journey-mapSkill
- discover-market-sizingSkill
- discover-stakeholder-summarySkill
- foundation-build-risk-reviewSkill
- foundation-lean-canvasSkill
- foundation-meeting-agendaSkill
- foundation-meeting-briefSkill
- foundation-meeting-recapSkill
- foundation-meeting-synthesizeSkill
- foundation-okr-writerSkill
- foundation-personaSkill
- foundation-prioritized-action-planSkill
- foundation-stakeholder-briefingsSkill
- foundation-stakeholder-updateSkill
- iterate-lessons-logSkill
- iterate-pivot-decisionSkill
- iterate-refinement-notesSkill
- iterate-retrospectiveSkill
- measure-dashboard-requirementsSkill
- measure-experiment-designSkill
- measure-experiment-resultsSkill
- measure-instrumentation-specSkill
- measure-okr-graderSkill
- measure-survey-analysisSkill
- tool-design-sprint-briefSkill
- tool-design-sprint-decide-and-storyboardSkill
- tool-design-sprint-map-and-targetSkill
- tool-design-sprint-prototype-planSkill
- tool-design-sprint-readinessSkill
- tool-design-sprint-sketchSkill
- tool-design-sprint-test-and-scoreSkill
- tool-foundation-sprint-approach-optionsSkill
- tool-foundation-sprint-basicsSkill
- tool-foundation-sprint-briefSkill
- tool-foundation-sprint-differentiationSkill
- tool-foundation-sprint-founding-hypothesisSkill
- tool-foundation-sprint-magic-lensesSkill
- tool-foundation-sprint-readinessSkill
- tool-note-and-voteSkill
- utility-pm-changelog-curatorSkill
- utility-pm-criticSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
7 rules. About 0 are common, 4 are distinctive, and 3 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.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 19
Create effective, syntactically valid mermaid diagrams for product documents.
- Very specific: line 79
Comment your intent: - Use %% comments to document non-obvious choices (why this layout direction, why this grouping)
- Very specific: line 88
Select a diagram type: - Use the selection guide above, browse references/pm-use-cases.md by task, or browse references/diagram-catalog.md …
- Very specific: line 90
Write the mermaid code: - Follow references/syntax-guide.md rules.
- Distinctive: line 91
Validate: - Run through the quality checklist below
- Distinctive: line 92
Embed: - Place the validated mermaid code block in your document
- Distinctive: line 98
Quality gate: All items in the quality checklist pass
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 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
<!-- PM-Skills | https://github.com/product-on-purpose/pm-skills | Apache 2.0 -->Mermaid Diagrams
Create effective, syntactically valid mermaid diagrams for product documents.
When to Use
- Creating mermaid diagrams for PRDs, specs, roadmaps, or stakeholder presentations
- Choosing which of 15 diagram types fits a specific communication need
- Debugging mermaid code that won't render or renders incorrectly
- Reviewing diagrams for clarity, accuracy, and accessibility
When NOT to Use
- Exporting diagrams to image files (PNG/SVG) - that's a rendering tool concern
- Using non-mermaid diagramming tools (Figma, Lucidchart, draw.io)
- Creating purely decorative visuals with no informational purpose
- Producing a full customer-journey artifact (stages, touchpoints, emotional curve, pain points) rather than a standalone diagram - use
discover-journey-map, which composes this skill for its timeline or flowchart section
The Cardinal Rule
Don't diagram what a list can say.
Diagrams earn their place when they reveal relationships, branching, or flow that prose flattens. Before creating any diagram, ask:
Does this show branching, relationships, or flow that a list or table would flatten?
- Yes → proceed with a diagram
- No → use a numbered list, bullet list, or table instead
A 5-step linear process is a list. A 5-step process with two decision points and a retry loop is a diagram.
Diagram Selection Guide
| I need to show... | Use | Also consider |
| A decision or approval process | Flowchart | State |
| Multi-service or multi-party interactions | Sequence | Flowchart |
| Feature lifecycle or status transitions | State | Flowchart |
| Work stages or pipeline status | Kanban | State |
| Release or sprint timeline with dependencies | Gantt | Timeline |
| Version history or chronological milestones | Timeline | Gantt |
| 2D prioritization (effort/impact, risk/value) | Quadrant | - |
| Allocation breakdown or composition | Pie | Treemap |
| Problem decomposition or brainstorming | Mindmap | - |
| Domain models or data relationships | ER | Class |
| API or object contracts | Class | ER |
| System topology or infrastructure | Architecture | Flowchart |
| Flow quantities or budget allocation | Sankey | Pie |
| Hierarchical proportional data | Treemap | Pie |
| Trends or time-series metrics | XY-Chart | - |
For worked examples organized by PM task, see references/pm-use-cases.md.
For full syntax and options per type, see references/diagram-catalog.md.
Syntax Validity Principles
Six rules that prevent most rendering failures:
- Quote labels - Any label containing spaces, parentheses, brackets, colons, commas, or reserved words must be quoted with double quotes
- Escape special characters - Characters with mermaid or markdown meaning (
>,<,-at line start,#) need escaping or quoting - Declare before referencing - Define a node before using it in an edge; referencing an undeclared node causes silent failures in some types
- Respect limits - Each diagram type has a maximum node/participant count beyond which readability collapses (see
references/diagram-catalog.mdfor per-type limits) - Comment your intent - Use
%%comments to document non-obvious choices (why this layout direction, why this grouping) - Test before shipping - Paste into a mermaid renderer (mermaid.live, VS Code preview, or your target environment) and verify it renders correctly
For the complete syntax reference, see references/syntax-guide.md.
Instructions
- Identify what you're communicating - What relationship, flow, hierarchy, or proportion needs to be visible? Who is the audience?
- Apply the cardinal rule - Confirm a diagram adds value over a list or table
- Select a diagram type - Use the selection guide above, browse
references/pm-use-cases.mdby task, or browsereferences/diagram-catalog.mdby type - Plan the diagram - Fill out the planning worksheet in
references/TEMPLATE.md: purpose, audience, node inventory, type rationale - Write the mermaid code - Follow
references/syntax-guide.mdrules; start with the minimal syntax example fromreferences/diagram-catalog.mdand expand - Validate - Run through the quality checklist below
- Embed - Place the validated mermaid code block in your document
Output Contract
- Planning artifact: A completed diagram planning worksheet (
references/TEMPLATE.md) - Final output: A syntactically valid mermaid code block embedded in the target document
- Quality gate: All items in the quality checklist pass
Quality Checklist
- Diagram renders without error in target environment
- Cardinal rule satisfied - a list or table would not communicate this more clearly
- No linear sequences without branching, relationships, or hierarchy
- All labels with spaces or special characters are properly quoted
- Special characters escaped where needed
- Node/participant count within type-specific limits
- Colors are accessible (WCAG AA 3:1 contrast minimum, black text on light backgrounds)
- Color is never the sole differentiator - shapes and labels also distinguish elements
- Diagram has a descriptive title or surrounding prose context
%%comments document any non-obvious layout or grouping choices
References
| File | Purpose |
references/TEMPLATE.md | Diagram planning worksheet - fill out before writing mermaid code |
references/EXAMPLE.md | Worked example: PM creating 4 diagrams for a product launch |
references/diagram-catalog.md | All 15 diagram types: syntax, PM examples, limits, pitfalls |
references/pm-use-cases.md | PM task → diagram type mapping with mini worked examples |
references/syntax-guide.md | Complete syntax validity rules, escaping, styling, and validation checklist |
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.

