technical-doc-creator
Technical Doc Creator builds polished HTML documentation for APIs and systems, complete with endpoint references, code samples, and architecture diagrams. It structures content with getting started guides, request/response examples, and syntax-highlighted code blocks. Perfect for creating developer-facing documentation that's ready to share.
Technical Doc Creator generates HTML documentation with API endpoints, code examples, and system architecture diagrams.
AI-generated summary based on this skill's SKILL.md
Install
mhattingpete/claude-skills-marketplace/technical-doc-creator · repository language: HTML
git clone https://github.com/mhattingpete/claude-skills-marketplace
cp -r claude-skills-marketplace/visual-documentation-plugin/skills/technical-doc-creator ~/.claude/skills/technical-doc-creatorFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
What does technical-doc-creator do?
Technical Doc Creator builds polished HTML documentation for APIs and systems, complete with endpoint references, code samples, and architecture diagrams. It structures content with getting started guides, request/response examples, and syntax-highlighted code blocks—perfect for creating developer-facing documentation that's ready to share.
Can technical-doc-creator generate HTML docs for REST API?
Yes. Technical Doc Creator generates HTML technical documentation for developer reference, with full support for REST API endpoints, request/response examples, and syntax-highlighted code blocks. It produces polished, shareable documentation ready for your developer audience.
Does technical-doc-creator include code examples?
Technical Doc Creator specializes in building syntax-highlighted code examples for technical guides. It generates comprehensive API documentation with code samples, curl examples, and request/response blocks integrated throughout your documentation.
Can I create system architecture documentation with diagrams?
Technical Doc Creator supports documenting system architecture and API workflows with diagrams. It helps you visualize workflows and system design alongside your endpoint documentation and code examples.
Does technical-doc-creator help with getting started guides?
Yes. Technical Doc Creator creates getting started and installation guides for APIs as part of its comprehensive documentation output. These guides help developers quickly understand how to set up and begin using your API.
What license does technical-doc-creator use?
Technical Doc Creator is released under the Apache-2.0 license, allowing broad use and modification for both open-source and commercial projects.
SKILL.md
rendered from the published skill — quoted content, verbatim
Technical Documentation Creator
Create comprehensive HTML technical documentation with code examples and API workflows.
When to Use
- "Create API documentation for [endpoints]"
- "Generate technical docs for [system]"
- "Document API reference"
- "Create developer documentation"
Components
- Overview: purpose, key features, tech stack
- Getting Started: installation, setup, quick start
- API Reference: endpoints with request/response examples
- Code Examples: syntax-highlighted code blocks
- Architecture: system diagram (SVG)
- Workflows: step-by-step processes
HTML Structure
```html <!DOCTYPE html> <html> <head> <title>[API/System] Documentation</title> <style> body { font-family: system-ui; max-width: 1000px; margin: 0 auto; } pre { background: #1e1e1e; color: #d4d4d4; padding: 15px; border-radius: 4px; overflow-x: auto; }
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 4 files
visual-documentation-plugin/skills/technical-doc-creator/SKILL.md
visual-documentation-plugin/skills/technical-doc-creator/assets/templates/base_template.html
visual-documentation-plugin/skills/technical-doc-creator/references/design_patterns.md
visual-documentation-plugin/skills/technical-doc-creator/references/svg_library.md