visual-docs-diagrams
Design and review visual content for developer documentation, including screenshots, architecture diagrams, boxes-and-arrows diagrams, flowcharts, swimlanes, video decisions, accessibility, performance, annotations, and visual maintenance. Use when creating or auditing diagrams, screenshots, visual explanations, or media in technical docs.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 1.6k
- Forks
- 491
01 前言 Front Matter
- name
- visual-docs-diagrams
- license
- MIT
- metadata
- { "tags": "developer-docs,technical-writing,documentation,diagrams,accessibility", "version": "0.1.0", "category": "Writing", "displayName": "Visual Docs Diagrams" }
- description
- Design and review visual content for developer documentation, including screenshots, architecture diagrams, boxes-and-arrows diagrams, flowcharts, swimlanes, video decisions, accessibility, performance, annotations, and visual maintenance. Use when creating or auditing diagrams, screenshots, visual explanations, or media in technical docs.
- compatibility
- Codex, Claude Code, and other Agent Skills-compatible clients.
02 资源文件 3
- 参考文档guidelines.md1.2 KB
- 参考文档references/core/knowledge.md4.3 KB
- 参考文档workflows/design-technical-visual.md2.2 KB
03 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:
- 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.
04 同仓库更多 Skills
worktable-review-with-annotations
Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.
worktable-find-and-synthesize-context
Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.
worktable-create-or-update-docs
Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.
worktable-create-or-manage-records
Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.
worktable-create-or-manage-interactive-html
Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.
worktable-collaborate-threads
Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.