visual-docs-diagrams
Design and review visual content for developer documentation, including screenshots, architecture diagrams, boxes-and-arrows diagrams, flowcharts, s…
它会碰到什么
这一栏是扫描器报的事实，不是结论。命中多不等于有毒（安全工具、规则库、示例脚本本来就会包含危险写法），命中少也不等于干净。它和你手上的凭据、文件、网络有什么关系，需要你自己看。
技能内容
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:
- Visual purpose - what the reader must understand faster or better.
- Recommended visual type - screenshot, boxes-and-arrows, flowchart, swimlane, video, or no visual.
- Design notes - scope, labels, annotations, contrast, placement, and format.
- Accessibility and performance checks - alt text, captions, transcripts, SVG/image size, responsiveness.
- Maintenance plan - source file, owner, update trigger, and review cadence.
Contents
| Need | Start Here |
|------|------------|
| Understand visual types | references/core/knowledge.md |
| Apply visual rules | references/core/knowledge.md |
| See visual decision examples | references/core/knowledge.md |
| Design or review a visual | workflows/design-technical-visual.md |
| Route by task | guidelines.md |
Core Posture
- Use visuals to supplement text, not replace critical instructions.
- Prefer one idea or level of detail per visual.
- Treat accessibility and maintenance as part of visual design, not post-production polish.
- Avoid video unless the motion itself is necessary and maintenance is realistic.
想直接用这个技能？
本站把开放许可（MIT / Apache 等）的技能按仓库打包整理到网盘，点一下转存到你自己的网盘，不用一个个从 GitHub 拉。许可未声明的技能只给原始仓库链接，不打包。
它属于哪个仓库
plugins/LVTD-LLC/skills/skills/visual-docs-diagrams/SKILL.md