technical-doc-creator

Featured

Create HTML technical documentation with code blocks, API workflows, system architecture diagrams, and syntax highlighting. Use when users request technical documentation, API docs, API references, code examples, or developer documentation.

AI & Automation 657 stars 91 forks Updated 3 days ago Apache-2.0

Install

View on GitHub

Quality Score: 92/100

Stars 20%
94
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 1. **Overview**: purpose, key features, tech stack 2. **Getting Started**: installation, setup, quick start 3. **API Reference**: endpoints with request/response examples 4. **Code Examples**: syntax-highlighted code blocks 5. **Architecture**: system diagram (SVG) 6. **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; } .endpoint { background: #f7fafc; padding: 15px; margin: 10px 0; border-left: 4px solid #4299e1; } code { background: #e2e8f0; padding: 2px 6px; border-radius: 3px; } </style> </head> <body> <h1>[System] Documentation</h1> <!-- Overview, Getting Started, API Reference, Examples --> </body> </html> ``` ## API Endpoint Pattern ```html <div class="endpoint"> <h3><span style="color: #48bb78;">GET</span> /api/users/{id}</h3> <p>Retrieve user by ID</p> <h4>Request</h4> <pre><code>curl -X GET https://api.example.com/users/123</code></pre> <h4>Response</h4> <pre><code>{ "id...

Details

Author
mhattingpete
Repository
mhattingpete/claude-skills-marketplace
Created
9 months ago
Last Updated
3 days ago
Language
HTML
License
Apache-2.0

Integrates with

Anthropic · AI

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

technical-writer

Expert technical documentation writer who creates clear, structured docs including API references, guides, tutorials, and README files. Use when writing documentation, API docs, or developer guides.

2 Updated yesterday
Marine-softdrink524
AI & Automation Solid

api-documentation-writer

Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. Creates OpenAPI/Swagger specs, REST API docs, and developer-friendly reference materials. Use when users need to document APIs, create technical references, or write developer documentation.

229 Updated 1 weeks ago
OneWave-AI
AI & Automation Listed

technical-writer

Use when you need to create, improve, or maintain technical documentation including API references, user guides, SDK documentation, and getting-started guides.

1 Updated yesterday
risadams