agentleFS
wedsamuel1230wedsamuel1230/embedded-engineering-skills/skills/mermaid-diagram-generator/SKILL.md

mermaid-diagram-generator

Skill28 starsChanged 32 days agoMITView on GitHub

Use when users need Mermaid diagrams for Arduino code structure, state machines, timing diagrams, task architecture, or workflow documentation.

4 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    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. Distinctive:

    Use this skill when the request asks to:

    line 21
  2. Distinctive:

    document timing or protocol sequences

    line 25
  3. Distinctive:

    add a diagram to project documentation

    line 27
  4. Distinctive:

    Do not use it for tiny code snippets where a diagram adds no clarity.

    line 29
  5. Distinctive:

    Prefer the simplest diagram that explains the behavior.

    line 38
  6. Very specific:

    Use scripts/generate_diagram.py when the input is structured enough for automation.

    line 39
  7. Very specific:

    Run through references/validation-checklist.md before presenting the final Mermaid output.

    line 41
  8. Distinctive:

    Use the shared Arduino skill contract: state assumptions, required tools and versions, implementation steps, tests/evidence by proof stage, …

    line 60

≈ “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.

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

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: state assumptions, required tools and versions, implementation steps, tests/evidence by proof stage, known limitations, and recovery/security notes.

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.