assistant-diagrams

Category: Data & AI | Uploader: laimis91 | Downloads: 0 | Version: v1.0（Latest）

Visual documentation generator. Creates Mermaid diagrams from code: architecture, sequence, ER, flow, component, class, and state diagrams. Use when user says 'diagram', 'draw', 'visualize', 'show me the flow', 'architecture diagram', 'sequence diagram', 'ER diagram', 'data model diagram'.

Changelog: Source: GitHub https://github.com/laimis91/assistant-framework

Directory Structure

Current level: tree/main/skills/assistant-diagrams/

📁 contracts/
- 📄 input.yaml 972 B
- 📄 output.yaml 916 B
📄 arch-diagram.md 1.3 KB
📄 class-diagram.md 1.5 KB
📄 component-diagram.md 1.2 KB
📄 er-diagram.md 1.4 KB
📄 flow-diagram.md 1.2 KB
📄 sequence-diagram.md 1.3 KB
📄 SKILL.md 4.3 KB
📄 state-diagram.md 1.2 KB

SKILL.md

---
name: assistant-diagrams
description: "Visual documentation generator. Creates Mermaid diagrams from code: architecture, sequence, ER, flow, component, class, and state diagrams. Use when user says 'diagram', 'draw', 'visualize', 'show me the flow', 'architecture diagram', 'sequence diagram', 'ER diagram', 'data model diagram'."
effort: medium
triggers:
  - pattern: "diagram|draw|visualize|show me the flow|architecture diagram|sequence diagram|er diagram|data model|class diagram|state diagram|flow chart"
    priority: 65
    min_words: 3
    reminder: "This request matches assistant-diagrams. Consider invoking the Skill tool with skill='assistant-diagrams' for visual documentation."
---

# Diagram Generator

## Contracts

| File | Purpose |
|---|---|
| [`contracts/input.yaml`](contracts/input.yaml) | diagram_type, scope, source_files[], format |
| [`contracts/output.yaml`](contracts/output.yaml) | diagram_code, diagram_type, description |

- `diagram_type` and `scope` are required; `format` defaults to mermaid
- `diagram_code` must be valid syntax parseable by the target renderer
- `diagram_type` is echoed back in output to confirm what was generated

Creates accurate Mermaid diagrams from code analysis. Covers the developer's visual documentation weakness.

Core principle: **Diagrams should be generated from code, not drawn from memory.**

## Available Diagram Types

| Type | File | Best for |
|---|---|---|
| **Architecture** | `arch-diagram.md` | System overview, component relationships |
| **Sequence** | `sequence-diagram.md` | Request flows, interaction patterns |
| **Entity-Relationship** | `er-diagram.md` | Data models, database schema |
| **Flow** | `flow-diagram.md` | Business logic, decision trees, algorithms |
| **Component** | `component-diagram.md` | Module boundaries, dependencies |
| **Class** | `class-diagram.md` | Type hierarchies, interfaces, relationships |
| **State** | `state-diagram.md` | State machines, lifecycle transitions |

## Auto-Selection

```
Input arrives
    │
    ├─ "architecture" / "system overview"     → arch-diagram.md
    ├─ "flow" / "how does X work"             → sequence-diagram.md or flow-diagram.md
    ├─ "data model" / "entities" / "schema"   → er-diagram.md
    ├─ "dependencies" / "modules"             → component-diagram.md
    ├─ "class hierarchy" / "types"            → class-diagram.md
    ├─ "state" / "lifecycle" / "transitions"  → state-diagram.md
    └─ ambiguous                              → ask user or pick best fit
```

## General Protocol

For all diagram types:

1. **Read the relevant code** — trace the actual paths, don't guess
2. **Right-size the diagram** — show what matters, omit noise
3. **Verify accuracy** — every box/arrow must correspond to real code
4. **Use project terminology** — names from code, not generic labels
5. **Output as Mermaid** — embeddable in markdown, renderable everywhere

## Diagram Complexity Guidelines

| Project Size | Guideline |
|---|---|
| Small (< 10 files) | Single diagram can show everything |
| Medium (10-50 files) | One overview + detail diagrams per area |
| Large (50+ files) | Layered: L0 overview → L1 component → L2 detail |

## Output Format

Always output Mermaid inside a fenced code block:

````markdown
```mermaid
[diagram content]
```
````

Include a brief description above each diagram explaining what it shows.

## Where to Place Diagrams

- If generating docs (via `assistant-docs`): embed in the doc
- If user asks directly: output inline in conversation
- If generating architecture doc: embed in `docs/architecture.md`
- For standalone diagrams: `docs/diagrams/[name].md`

## Mermaid Best Practices

- Keep node labels short (2-4 words)
- Use meaningful edge labels (verb phrases: "calls", "reads from", "publishes to")
- Group related nodes with `subgraph`
- Use direction that reads naturally (TD for hierarchies, LR for flows)
- Limit to ~15-20 nodes per diagram — split larger ones

## Rules

- **Every element must exist in code** — no aspirational boxes
- **Don't show everything** — show what helps understanding
- **Label relationships** — unlabeled arrows are useless
- **Use consistent styling** — same type of component gets same shape
- **Test rendering** — Mermaid syntax errors are common, validate mentally

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

assistant-diagrams

Directory Structure

SKILL.md

Report

Notice