agentleFS
brunohappbrunohapp/skills-de-infografico/skills/visual-explainer/skill/SKILL.md

visual-explainer

Skill0 starsChanged 3 months agoMITView on GitHub

Generate self-contained HTML visual explanations for systems, code changes, plans, data, and technical concepts. Use for diagrams, architecture overviews, diff or plan reviews, project recaps, comparison tables, slide decks, and other visual explanations.

28 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use verification-before-completion.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • OpenAISkill

    verification-before-completion

    Use when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions always

    Also in 3 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

25 rules. 0 are common, 10 are distinctive, and 15 are very specific to this project.

  • 0

    Common

    Most of the 26 edited versions we read keep these.

  • 10

    Distinctive

    This author's own choices. Worth a look.

  • 15

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Prefer an HTML page over terminal ASCII when the output is inherently visual.

    line 17
  2. Distinctive:

    If a table would have 4+ rows or 3+ columns, render it as HTML and give only a short chat summary.

    line 18
  3. Very specific:

    Write files to ~/.agent/diagrams/ or the explicit eval output path.

    line 19
  4. Distinctive:

    Read only the references needed for the current output:

    line 25
  5. Very specific:

    Use theme: 'base' with custom themeVariables matching the page palette.

    line 52
  6. Very specific:

    Never use bare <pre class="mermaid">.

    line 54
  7. Very specific:

    Use the canonical diagram-shell pattern from templates/mermaid-flowchart.html: .diagram-shell > .mermaid-wrap > .zoom-controls + …

    line 55
  8. Very specific:

    Every Mermaid diagram needs zoom in/out/reset/expand controls, Ctrl/Cmd+scroll zoom, drag panning, and click-to-expand.

    line 56
  9. Very specific:

    Prefer flowchart TD for complex diagrams.

    line 57
  10. Very specific:

    Use <br/> in quoted flowchart labels.

    line 58
  11. Very specific:

    Never define page-level .node.

    line 59
  12. Very specific:

    Use semantic HTML where it helps accessibility and copy/paste: <table>, headings, lists, <details>, captions.

    line 64
  13. Very specific:

    Use CSS custom properties for palette: --bg, --surface, --border, --text, --text-dim, and 3–5 accents.

    line 65
  14. Very specific:

    Avoid generic defaults: no body font that is only Inter, Roboto, Arial, Helvetica, or system-ui.

    line 67
  15. Very specific:

    Do not set display: flex directly on <li> when list markers matter.

    line 71
  16. Distinctive:

    Use depth sparingly: hero/elevated only for primary sections.

    line 72
  17. Very specific:

    Use entrance/hover animation only when it clarifies hierarchy.

    line 73
  18. Distinctive:

    Use slides only when explicitly requested or when a command asks for slides.

    line 77
  19. Distinctive:

    Use larger type, fewer objects per slide, varied compositions, and visible navigation.

    line 80
  20. Distinctive:

    Before writing HTML, inventory the source and map every source item to slides.

    line 82
  21. Distinctive:

    Do not drop content to fit a fixed slide count.

    line 83
  22. Very specific:

    Use the 10 slide types from slide-patterns.md: Title, Section Divider, Content, Split, Diagram, Dashboard, Table, Code, Quote, Full-Bleed.

    line 84
  23. Very specific:

    If surf is available, generated images may be embedded as base64 for hero banners, conceptual illustrations, or educational visuals.

    line 88
  24. Distinctive:

    no console errors when opened.

    line 96
  25. Distinctive:

    no horizontal overflow at normal desktop width.

    line 97

“Common” is measured: kept by at least 6 in 10 of the 26 edited versions of this file we could read. “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

Visual Explainer

Generate self-contained HTML pages that explain systems, code changes, plans, data, and technical concepts visually. Use this skill for diagram requests, architecture overviews, diff/plan reviews, project recaps, comparison tables, slide decks, and any visual explanation.

Trigger and delivery rules

  • Prefer an HTML page over terminal ASCII when the output is inherently visual.
  • If a table would have 4+ rows or 3+ columns, render it as HTML and give only a short chat summary.
  • Write files to ~/.agent/diagrams/ or the explicit eval output path. Use descriptive filenames.
  • Open generated pages in the browser when running normally. In Pi package installs, use visual_explainer with prepare for planning/context and render only after the complete HTML document exists.
  • The final page must be a complete self-contained HTML document, including embedded CSS and any needed JS.

Reference routing

Read only the references needed for the current output:

NeedRead
Text-heavy architecture/cards./templates/architecture.html
Mermaid flowcharts, sequence, ER, state, class, C4, data flow./templates/mermaid-flowchart.html, Mermaid sections in ./references/libraries.md
Data tables, comparisons, audits./templates/data-table.html
Slide decks./templates/slide-deck.html, ./references/slide-patterns.md
CSS layout, overflow, depth, collapsibles, SVG connectors, generated images./references/css-patterns.md
Pages with 4+ major sections./references/responsive-nav.md
Prose-heavy pages“Prose Page Elements” in css-patterns.md, typography sections in libraries.md

Choose the representation

ContentDefault representation
Flowchart, pipeline, state machine, decision treeMermaid
Sequence, ER/schema, class, C4, topology-focused architectureMermaid
Text-heavy architecture, module internals, implementation plansCSS grid cards, optionally with a Mermaid overview
15+ element architectureHybrid: small Mermaid overview + CSS detail cards
Comparison/audit/status matrixSemantic HTML <table>
Timeline/roadmapCSS timeline
Dashboard/metricsCSS grid + charts/KPIs
Slide deck100dvh slides using slide template patterns

Mermaid invariants

  • Use theme: 'base' with custom themeVariables matching the page palette.
  • For complex diagrams use ELK layout when available.
  • Never use bare <pre class="mermaid">.
  • Use the canonical diagram-shell pattern from templates/mermaid-flowchart.html: .diagram-shell > .mermaid-wrap > .zoom-controls + .mermaid-viewport > .mermaid-canvas.
  • Every Mermaid diagram needs zoom in/out/reset/expand controls, Ctrl/Cmd+scroll zoom, drag panning, and click-to-expand.
  • Prefer flowchart TD for complex diagrams. Use LR only for simple 3–4 node linear flows.
  • Use <br/> in quoted flowchart labels. Do not use escaped \n labels.
  • Never define page-level .node; Mermaid uses it internally. Use namespaced page classes such as .ve-card.
  • For 15+ elements, do not cram everything into one Mermaid diagram. Use the hybrid overview + cards pattern.

Layout and style invariants

  • Use semantic HTML where it helps accessibility and copy/paste: <table>, headings, lists, <details>, captions.
  • Use CSS custom properties for palette: --bg, --surface, --border, --text, --text-dim, and 3–5 accents.
  • Pick a clear aesthetic direction before writing: blueprint, editorial, paper/ink, terminal, IDE-inspired, or data-dense.
  • Avoid generic defaults: no body font that is only Inter, Roboto, Arial, Helvetica, or system-ui; no violet/fuchsia Tailwind-default accents as the main palette (#8b5cf6, #7c3aed, #a78bfa, #d946ef); no cyan+magenta+purple neon dashboard; no gradient-mesh blobs.
  • Good font pair families: DM Sans + Fira Code; Instrument Serif + JetBrains Mono; IBM Plex Sans + IBM Plex Mono; Bricolage Grotesque + Fragment Mono; Plus Jakarta Sans + Azeret Mono.
  • Good accent directions: terracotta+sage, teal+slate, rose+cranberry, amber+emerald, deep blue+gold.
  • Prevent overflow: min-width: 0 on grid/flex children, overflow-wrap: break-word for long text, and scroll containers for wide tables/code.
  • Do not set display: flex directly on <li> when list markers matter.
  • Use depth sparingly: hero/elevated only for primary sections; flat/recessed for reference material.
  • Use entrance/hover animation only when it clarifies hierarchy. Respect prefers-reduced-motion. Do not use continuous glow, pulse, or breathing effects on static content.

Slide deck mode

Use slides only when explicitly requested or when a command asks for slides. Slides are a different medium, not a paginated article:

  • Each slide is one viewport (100dvh) with no page-level scrolling.
  • Use larger type, fewer objects per slide, varied compositions, and visible navigation.
  • Include slide nav chrome from slide-deck.html: prev/next controls, slide count, keyboard navigation, and carousel dots/indicators.
  • Before writing HTML, inventory the source and map every source item to slides.
  • Do not drop content to fit a fixed slide count. Add slides instead.
  • Use the 10 slide types from slide-patterns.md: Title, Section Divider, Content, Split, Diagram, Dashboard, Table, Code, Quote, Full-Bleed.

Optional generated images

If surf is available, generated images may be embedded as base64 for hero banners, conceptual illustrations, or educational visuals. Skip images for data-heavy, structural, or Mermaid/CSS-suitable content. Pages must stand on CSS, typography, and diagrams without images.

Final checklist

Before delivery, verify:

  • complete HTML document;
  • output written to the requested path;
  • no console errors when opened;
  • no horizontal overflow at normal desktop width;
  • fonts load with fallbacks;
  • tables preserve rows/columns and wrap long text;
  • Mermaid diagrams use diagram-shell with zoom/pan/expand;
  • slides fit one viewport, include carousel dots, and preserve source coverage;
  • visual hierarchy makes the main idea obvious in the first viewport;
  • styling would still be recognizable if compared against a generic dark/violet template.

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.