drawio-academic-skills

name: drawio-academic-skills version: "2.3.0" description: "Publication-figure overlay for draw.io. Use instead of the general drawio skill whenever a diagram is for a paper, thesis, dissertation, journal, conference, IEEE/ACM submission, manuscript, camera-ready, Word/LaTeX figure, or other publication. Applies venue, figure-type, color, caption/legend, formula, and paper-readability gates for architecture, workflow, roadmap, network-topology, and replicated paper figures. Runs offline and YAML-first through the sibling ../drawio base for CLI, references, themes, schemas, styles, and Desktop export; never requires MCP or a live backend." license: MIT homepage: https://github.com/bahayonghang/drawio-skills compatibility: "Requires sibling ../drawio in the same skills directory. Node 20+ is required for the shared YAML/CLI workflow. draw.io Desktop is optional and only needed for PNG/PDF/JPG or embedded .drawio.svg exports. No MCP server is required." platforms: [macos, linux, windows] metadata: category: visual-design tags: - drawio - academic - paper-figure - ieee - thesis - manuscript - workflow - math - svg argument-hint: [figure-description-or-instruction]

allowed-tools: Read, Write, Bash, AskUserQuestion

Draw.io Academic Overlay

Create, edit, replicate, validate, and export publication-ready draw.io figures by applying academic policy on top of the sibling Draw.io Base Skill.

This overlay is intentionally thin. It owns academic policy, academic docs, and paper examples; it does not copy base scripts, themes, schemas, official references, or workflow docs. It calls the sibling base package at ../drawio for all shared execution.

Boundary

• Base (../drawio): shared execution primitives — CLI, schema, renderer, themes (including academic / academic-color), general references, general examples, style presets, Desktop export.
• This overlay: academic policy/gates, the publication overlay doc, the academic figure playbook + checklist, and paper/pipeline examples.

Themes are a base rendering primitive and stay in the base; academic policy, docs, and examples stay here.

Required Sibling Base

Resolve shared resources relative to this overlay directory:

Overlay-local academic assets: references/docs/publication-overlay.md, references/docs/academic-figure-playbook.md, references/docs/academic-export-checklist.md, and references/examples/.

If ../drawio/scripts/cli.js is missing, stop and report that the sibling base skill must be installed next to this overlay. Do not silently recreate or vendor-copy base resources into the overlay.

Non-Negotiable Contract

• Keep academic authoring YAML-first and offline-first.
• Never create, require, or route through .mcp.json, MCP, or a live backend.
• Treat .drawio and .svg as the default academic final deliverables.
• Keep .spec.yaml, .arch.json, raw YAML, and diagnostics in a project-local work directory such as .drawio-tmp/<name>/, unless the user explicitly asks for a reproducible sidecar bundle beside the final output.
• Use draw.io Desktop only as an optional export enhancer for PNG/PDF/JPG or embedded .drawio.svg.
• If a requested Desktop export cannot be produced locally, still deliver the editable .drawio and SVG, then report the unavailable export clearly.
• Perform paper-readability and visual self-checks on exported SVG first, or on Desktop-exported PNG/PDF/JPG/embedded SVG when available. Do not substitute browser or Playwright screenshots when an exported artifact exists.
• Treat external image-generation previews as optional concept previews only. They never replace YAML, .drawio, SVG, sidecars, or exported-artifact verification.
• Keep academic-specific policy in this overlay; keep shared execution in ../drawio.
• Do not create or modify scratch JS scripts under a user's project-local .agents/skills/drawio; port durable fixes to the sibling base skill source instead.

Academic Preflight

Before generating or editing, determine and state: venue/audience; figure type (architecture, roadmap, or workflow); color policy; caption/legend/title needs; formula and text-fidelity needs; export expectations.

Also estimate the node budget. The single authoritative budget guidance (targets, warning thresholds, node-efficient patterns, split strategies) lives in references/docs/academic-figure-playbook.md § Node Budget Management. If the estimate exceeds the playbook's recommended target, confirm a split/simplify strategy with the user before generating, and use compact patterns from references/templates/.

Full decision detail: references/docs/publication-overlay.md § Required Academic Decisions.

Source Understanding

Extract only what the figure needs from papers, reference images, or text-only prompts, and keep uncertainties explicit. See references/docs/publication-overlay.md § Source Understanding (source-type table) and references/docs/academic-figure-playbook.md § Scientific Figure Patterns.

Diagram Plan Gate

For complex paper-derived figures or academic image-replication work, present a concise diagram plan and wait for confirmation before rendering. Simple, clear academic diagrams may skip the gate and proceed to YAML/SVG. Plan template and field list: references/docs/publication-overlay.md § Diagram Plan Gate.

Optional Image Preview

Use an external image-generation tool only as an optional concept preview, only after the diagram plan is confirmed, and only with privacy approval before sending unpublished or sensitive content. Treat generated text as approximate and correct final labels/formulas/geometry in YAML. Full rules: references/docs/publication-overlay.md § Optional Image Preview.

Task Routing

Choose one route first, then load only the referenced files.

Academic Defaults

For academic-paper requests, set these before rendering:

meta:
  profile: academic-paper
  figureType: architecture # architecture | roadmap | workflow
  theme: academic # or academic-color when color is acceptable
  title: Caption-ready title
  description: One sentence explaining the figure intent
  legend: Required when symbols, colors, line styles, or icons need explanation

This section defines the default academic final deliverables.

Default deliverables:

• <name>.drawio
• <name>.svg

Intermediate work directory:

• <name>.spec.yaml
• <name>.arch.json
• raw or normalized YAML and diagnostics

Add <name>.png / .pdf / .jpg only when requested or needed for Word/A4/thesis/raster workflows, and only when draw.io Desktop export is available.

Create Flow

1. Classify the figure as architecture, roadmap, or workflow.
2. For complex paper-derived requests, extract the research evidence chain and confirm the diagram plan before rendering.
3. When the optional image-preview trigger applies, generate a concept preview after confirmation, then revise the plan if needed.
4. Draft or normalize the YAML spec as the canonical source; use concise labels (shorten labels before shrinking fonts).
5. Validate through the sibling base CLI, then render the editable .drawio and standalone SVG with sidecars in the work directory.
6. Run an exported-artifact self-check before reporting completion.

node ../drawio/scripts/cli.js input.yaml figure.drawio --validate --write-sidecars --sidecar-dir .drawio-tmp/figure --strict-warnings
node ../drawio/scripts/cli.js input.yaml figure.svg --validate --write-sidecars --sidecar-dir .drawio-tmp/figure --strict-warnings

Use paths relative to the overlay directory, or absolute paths when running from another working directory. Detailed figure-type patterns: references/docs/academic-figure-playbook.md.

Edit and Replicate Flow

• If a .spec.yaml sidecar exists, edit the YAML spec first. If only .drawio exists, import it through the base CLI (--input-format drawio --export-spec).
• For image/SVG replication, preserve text boxes, captions, legends, formulas, edge labels, baseline/offset, font family/size/italic state, alignment, and spacing when visible. Use explicit bounds for standalone text/formula blocks and labelOffset for connector labels off the line.
• Keep all regenerated files on the same basename so final artifacts and work-dir sidecars stay round-trippable.

Export Policy

Use the sibling base CLI for deterministic exports.

# Editable .drawio + offline SVG with work-dir sidecars
node ../drawio/scripts/cli.js input.yaml figure.drawio --validate --write-sidecars --sidecar-dir .drawio-tmp/figure --strict-warnings
node ../drawio/scripts/cli.js input.yaml figure.svg --validate --write-sidecars --sidecar-dir .drawio-tmp/figure --strict-warnings

# Desktop-enhanced exports
node ../drawio/scripts/cli.js input.yaml figure.drawio.svg --validate --write-sidecars --sidecar-dir .drawio-tmp/figure --use-desktop
node ../drawio/scripts/cli.js input.yaml figure.png --validate --use-desktop
node ../drawio/scripts/cli.js input.yaml figure.pdf --validate --use-desktop

If Desktop is unavailable, generate a diagrams.net URL from the .drawio artifact and report the missing export honestly:

node ../drawio/scripts/runtime/diagrams-net-url.js figure.drawio

Do not claim PNG/PDF/JPG files exist when Desktop export was unavailable.

Style Presets

Use overlay-specific user presets first (~/.drawio-academic-skills/styles/), then sibling base bundled presets (../drawio/styles/built-in/). Never mutate bundled base presets; copy a bundled preset into the user preset directory before editing or making it a default.

Quality Gate

Do not claim completion until:

• final .drawio and .svg are aligned with work-dir .spec.yaml and .arch.json
• meta.profile is academic-paper and meta.figureType is architecture, roadmap, or workflow
• node count satisfies the playbook budget (references/docs/academic-figure-playbook.md § Node Budget Management); split or simplify when it is exceeded
• labels are readable at paper/A4 scale; formulas use official delimiters ($$...$$, \(...\), or AsciiMath backticks)
• captions, legends, callouts, formulas, and edge labels are not clipped or placed on connector lines
• legends use compact form (single multi-line text node, not many separate nodes)
• colors are not the only carrier of meaning
• visual self-check used the exported SVG or Desktop-exported artifact before any live/browser preview, checking overlap, clipped text, connector-label clearance, arrows crossing text/nodes, missing modules, and mismatch from the confirmed plan/source
• if a visible defect was found, the YAML spec was corrected and rerendered once before final reporting
• requested Desktop exports were attempted or clearly reported as unavailable
• no MCP config, MCP server, or live backend is required for the result

Completion Report

End with a concise report:

• deliverables written, with paths
• intermediate work directory, when sidecars or diagnostics were generated
• sibling base CLI commands run for validation/export
• unavailable Desktop exports and fallback provided
• remaining visual or venue-specific manual checks, if any