visual-docs-diagrams
Installation
SKILL.md
Visual Docs Diagrams
Use this skill to decide whether developer docs need visuals and to design or review those visuals for comprehension, accessibility, performance, and maintainability.
This skill is derived from Docs for Developers: An Engineer's Field Guide to Technical Writing, especially Chapter 6, "Adding visual content." The guidance is transformed and paraphrased; do not copy book prose into user outputs. Source: https://link.springer.com/book/10.1007/978-1-4842-7217-6
Quick Start
- Load
guidelines.mdto choose the smallest useful reference set. - Define what the visual must help the reader understand or do.
- Choose screenshot, diagram, flowchart, swimlane, or text-only based on the task.
- Use
workflows/design-technical-visual.mdfor full visual design or review. - Check accessibility, performance, placement, source files, and maintenance before finalizing.
Default Output
When designing or reviewing visual docs, return: