mermaiddoc

Mermaiddoc Skill

Command: /mermaiddoc

Create readable Mermaid diagrams for repository documentation.

The skill creates Markdown files with Mermaid code blocks that render directly in GitHub.

The skill mainly creates these diagram types:

flowchart LR
sequenceDiagram

The skill stores generated diagram documentation in:

docs/diagrams/

Purpose

/mermaiddoc helps humans and agents create useful Mermaid diagrams for code documentation.

The goal is to create diagrams that:

• explain one focused concept
• render well in GitHub Markdown
• stay readable in pull requests and repository docs
• use simple Mermaid syntax
• use stable node IDs
• use short labels
• use clear arrows
• avoid visual clutter
• avoid layout tricks that break or look bad on GitHub
• can be maintained as text
• help future humans and agents understand the codebase faster

The goal is not to create decorative diagrams or complete visual models of the whole system.

Supported Diagram Types

Prefer these diagram types:

flowchart LR
sequenceDiagram

Use flowchart LR for:

• architecture overviews
• module dependencies
• request flow
• data flow
• build flow
• deployment flow
• agent workflow
• repository workflow
• command execution flow
• high-level process diagrams
• documentation generation flows

Use sequenceDiagram for:

• runtime interactions
• API calls
• request and response behavior
• agent and tool interactions
• user and system flows
• service-to-service communication
• event handling sequences
• retry sequences
• error handling paths

Do not use other Mermaid diagram types unless the user explicitly asks.

Slash Command

Use this skill when the user calls:

/mermaiddoc

Natural examples:

/mermaiddoc "Create a diagram for the authentication flow"
/mermaiddoc "Show the request lifecycle"
/mermaiddoc "Create a sequence diagram for startup and data processing"
/mermaiddoc "Show the main components of the application"