Skip to main content
skill CX Codex

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

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add wedsamuel1230/embedded-engineering-skills --skill mermaid-diagram-generator -a claude-code
Open on GitHub

What 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-code

2Manually: put the files in place

~/.claude/skills/mermaid-diagram-generator/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/mermaid-diagram-generator/

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.

mermaid-diagram-generator patricio0312rev mermaid-diagram-generator is a Claude Code skill that generates Mermaid diagrams in markdown and activates on requests for a Mermaid diagram, flowchart, or architecture diagram. CX Codex +1 348installs external-diagram-mermaid-generate forcedotcom external-diagram-mermaid-generate turns Salesforce architecture into Mermaid diagrams: OAuth flows, ERDs, integration sequences, Agentforce structure. Ships an ASCII fallback for plain-text use. CX Codex +1 5,600installs mermaid-diagram-specialist davila7 mermaid-diagram-specialist generates Markdown-ready Mermaid diagrams for flowcharts, ERDs, sequence diagrams, and C4 architecture. Useful for technical writers and system architects. CX Codex +1 145installs agent-mermaid-diagram-specialist softaworks agent-mermaid-diagram-specialist — a plugin that generates Mermaid diagrams: flowcharts, sequence diagrams, ERDs, and architecture visualizations. Saves time when you need to sketch out processes, data relationships, or system interactions. ★ 2,707repo stars mermaid-diagram-ui przeprogramowani mermaid-diagram-ui guides the agent to analyze requirements and generate Mermaid UI architecture diagrams for Astro and React auth modules. CX Codex +1 ★ 267repo stars mermaid-diagram-journey przeprogramowani mermaid-diagram-journey guides Claude Code to build a Mermaid state diagram for login and onboarding flows straight from project requirements. CX Codex +1 ★ 267repo stars code-to-diagram zebbern The code-to-diagram skill maps imports in a codebase and produces architecture diagrams, flowcharts, and file hierarchies. Use it before review, documentation, or refactoring. CX Codex +1 ★ 4,719repo stars

From the same set19

The whole set →
code-review-facilitator The code-review-facilitator skill reviews Arduino, ESP32, and RP2040 projects for memory risks, structural issues, and common mistakes. Use it before publishing code or after finishing a feature. CX Codex +1 154installs readme-generator readme-generator generates README.md files for Arduino, ESP32, and RP2040 projects. Use it when a working project needs clear GitHub documentation. CX Codex +1 147installs sensor-calibration-workbench The sensor-calibration-workbench skill guides sensor calibration from warm-up and reference readings to coefficient storage and drift checks for CO2, load-cell, magnetic, color, and analog sensors. CX Codex +1 137installs i2c-bringup-diagnostician i2c-bringup-diagnostician diagnoses I2C bring-up failures on Arduino and ESP32 boards, covering wiring, scanner mismatches, and driver bugs. CX Codex +1 134installs freertos-patterns freertos-patterns picks the right FreeRTOS pattern for ESP32 tasks or RP2040 dual-core work: queues, mutexes, notifications, stack checks. CX Codex +1 120installs ota-deployment-guardian ota-deployment-guardian prevents remote bricking on ESP32 boards and Arduino Uno R4 WiFi during OTA updates. Troubleshoots disappearing network ports and sets up rollback workflows. CX Codex +1 115installs field-power-and-connectivity-triager field-power-and-connectivity-triager is a Claude Code skill that investigates power and connectivity faults when a board works over USB but fails on its intended supply. It checks voltage drops, current peaks, regulators, and wiring. CX Codex +1 113installs arduino-serial-monitor arduino-serial-monitor is a Claude Code skill that reads and analyzes Arduino serial output, including boot logs, sensor data, and communication failures. CX Codex +1 1installs

Project sponsors

Companies that keep this analytics open