mermaid-diagram-generator · wedsamuel1230 — Claude Code skill for Mermaid diagrams
mermaid-diagram-generator is a Claude Code skill that turns Arduino code and embedded-system behavior into Mermaid diagrams for mapping states, signal sequences, and FreeRTOS task architecture.
MIT 113 installs ★ 33 updated 2026-10-15
npx skills add wedsamuel1230/embedded-engineering-skills --skill mermaid-diagram-generator -a claude-codeWhat mermaid-diagram-generator does
This skill turns Arduino code and embedded-system descriptions into Mermaid diagrams, including flowcharts, state diagrams, timing views, and protocol sequences. It first matches the request to a diagram type. For a tiny code snippet, it advises against drawing a diagram when that would add no clarity.
The package includes the CLI script scripts/generate_diagram.py, diagram templates, code-analysis heuristics, and a validation checklist. State-flow requests use the code-pattern references; timing and protocol requests use the templates. Before returning a diagram, the workflow checks Mermaid syntax, abstraction level, and whether states, transitions, and signals match the source. That last check matters: a diagram with mismatched labels would misrepresent the code.
For FreeRTOS task diagrams, the skill can be paired with freertos-patterns. It also fits alongside arduino-code-generator when a generated sketch needs visual documentation, or readme-generator when the diagram belongs in repository docs.
What it helps with
- map state transitions in embedded code
- turn an Arduino sketch into a flowchart
- document timing or protocol exchanges
- show relationships between FreeRTOS tasks
- add a Mermaid diagram to project documentation
Example prompts for the agent
- Draw a state diagram for this Arduino code and check its transitions against the source.
- Create a timing diagram from this protocol description.
- Show how the FreeRTOS tasks in this architecture relate to each other.
How to install mermaid-diagram-generator
1Skills CLI (Vercel)
npx skills add wedsamuel1230/embedded-engineering-skills --skill mermaid-diagram-generator -a claude-code2Manually: put the files in place
~/.claude/skills/mermaid-diagram-generator/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/mermaid-diagram-generator/
1Skills CLI (Vercel)
npx skills add wedsamuel1230/embedded-engineering-skills --skill mermaid-diagram-generator -a codex2Manually: put the files in place
.agents/skills/mermaid-diagram-generator/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add wedsamuel1230/embedded-engineering-skills --skill mermaid-diagram-generator -a cursor2Manually: put the files in place
.cursor/skills/mermaid-diagram-generator/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install wedsamuel1230/embedded-engineering-skills skills/mermaid-diagram-generator2Manually: put the files in place
.github/skills/mermaid-diagram-generator/SKILL.md1Skills CLI (Vercel)
npx skills add wedsamuel1230/embedded-engineering-skills --skill mermaid-diagram-generator -a gemini-cli2Platform CLI
gemini skills install https://github.com/wedsamuel1230/embedded-engineering-skills --path skills/mermaid-diagram-generatorManually: put the files in place
.devin/skills/mermaid-diagram-generator/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add wedsamuel1230/embedded-engineering-skills --skill mermaid-diagram-generator -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about mermaid-diagram-generator
How do I install mermaid-diagram-generator in Claude Code?
Run npx skills add wedsamuel1230/embedded-engineering-skills --skill mermaid-diagram-generator -a claude-code. The skill file is located at ~/.claude/skills/mermaid-diagram-generator/SKILL.md.
What does mermaid-diagram-generator do?
It creates Mermaid diagrams from Arduino code and embedded-system concepts, such as state flows, timing sequences, and task layouts. Its workflow checks the diagram syntax and compares labels and transitions with the source material.
How does it handle FreeRTOS task diagrams?
For task architecture, it draws on both code-analysis heuristics and diagram templates. The skill can be paired with freertos-patterns for this kind of diagram.
Source text
SKILL.md · MIT
---
name: mermaid-diagram-generator
description: Use when users need Mermaid diagrams for Arduino code structure, state machines, timing diagrams, task architecture, or workflow documentation.
metadata: {triggers: "Mermaid diagram, state machine diagram, timing diagram, workflow"}
---
# Mermaid Diagram Generator
Generate Mermaid diagrams from Arduino and embedded-system concepts without
loading unnecessary detail up front.
## Resources
- `scripts/generate_diagram.py` - CLI generator for diagram output
- `references/diagram-templates.md` - Mermaid templates by diagram type
- `references/code-patterns.md` - code-to-diagram extraction heuristics
- `references/validation-checklist.md` - rendering and syntax checks
## When to Use
Use this skill when the request asks to:
- visualize a state machine
- turn code into a flowchart
- document timing or protocol sequences
- show FreeRTOS task relationships
- add a diagram to project documentation
Do not use it for tiny code snippets where a diagram adds no clarity.
## Workflow
1. Identify the diagram type:
- state flow -> open `references/code-patterns.md`
- timing or protocol sequence -> open `references/diagram-templates.md`
- task architecture -> open both `code-patterns.md` and
`diagram-templates.md`
2. Prefer the simplest diagram that explains the behavior.
3. Use `scripts/generate_diagram.py` when the input is structured enough for
automation.
4. Run through `references/validation-checklist.md` before presenting the final
Mermaid output.
## Verification
- Mermaid syntax parses without errors.
- The diagram uses the correct abstraction level for the request.
- State names, transitions, or signals match the source material exactly.
- The output is readable without reverse-engineering the code.
## Integration
- Pair with `freertos-patterns` for task and synchronization diagrams.
- Pair with `arduino-code-generator` when a generated sketch also needs visual
documentation.
- Pair with `readme-generator` when the diagram should ship in repository docs.
## Shared Output Contract
Use [the shared Arduino skill contract](../../docs/arduino-skill-contract.md):
state assumptions, required tools and versions, implementation steps,
tests/evidence by proof stage, known limitations, and recovery/security notes.
© wedsamuel1230 · MIT · wedsamuel1230/embedded-engineering-skills
Similar skills
All skills for Writing and docs →mermaid-diagram-generator by other authors comes first.