From visual-documentation
Use when someone asks to create technical documentation, API docs, developer docs, a README, getting started guide, SDK reference, endpoint documentation, or wants to document a library, service, or system for developers. Triggers on: technical documentation, API docs, developer guide, getting started, SDK docs, endpoint reference, REST API documentation, library docs, technical reference, generate docs.
How this skill is triggered — by the user, by Claude, or both
Slash command
/visual-documentation:technical-doc-creatorThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Generates HTML technical documentation for APIs, libraries, services, and developer tools.
Generates HTML technical documentation for APIs, libraries, services, and developer tools. Output is a standalone HTML file with syntax-highlighted code examples, structured sections, and an optional architecture diagram.
Before writing docs, gather from the codebase, user description, or existing docs:
Every technical doc includes these five sections:
Read references/technical-docs.md for the HTML template and styling guide.
[system-name]-docs.htmlApply these badge colors for REST API docs:
| Method | Color | Usage |
|---|---|---|
| GET | #48bb78 (green) | Read / list |
| POST | #4299e1 (blue) | Create |
| PUT / PATCH | #ed8936 (orange) | Update |
| DELETE | #e53e3e (red) | Remove |
| WS / SSE | #9f7aea (purple) | Streaming |
Use a lightweight token-based approach with <span class="token-*"> wrappers:
<span class="token-keyword">const</span> result = <span class="token-fn">fetchUser</span>(<span class="token-string">'user_123'</span>);
CSS classes: .token-keyword, .token-fn, .token-string, .token-number,
.token-comment, .token-operator, .token-type
See references/technical-docs.md for the full CSS and code block template.
// do your thing here is not a code example — write real codeuserId without saying it's a string is incomplete401 or 422, document itnpx claudepluginhub prakhar625/my-plugins --plugin visual-documentationGuides writing technical documentation including README files, API docs, user guides, and inline code documentation. Provides templates and best practices for clear, scannable docs.
Provides templates and best practices for README files, API documentation, user guides, changelogs, inline code comments, and architecture docs.
Guides creation of README files, API docs, user guides, developer guides, and troubleshooting docs with structured process, templates, and best practices.