technical-doc-creator_skill

Overview

This skill generates clean, self-contained HTML technical documentation tailored for APIs, developer guides, and system overviews. It produces semantic sections—overview, getting started, API reference, code examples, workflows, and an SVG architecture diagram—ready to serve as a static docs page. Output emphasizes readable code blocks, syntax highlighting styles, and HTTP method color conventions for quick scanning.

How this skill works

The skill analyzes a provided system or API specification to extract endpoints, methods, parameters, request/response samples, and common usage patterns. It builds a structured HTML document with CSS for readable code blocks, endpoint cards, and inline code elements, and can embed an SVG diagram to illustrate architecture. It writes consistent examples (curl and language snippets), method-colored headers, and a getting-started section with installation and quick-start steps.

When to use it

• You need an HTML developer guide or API reference from an API spec or endpoint list.
• You want a single-file docs page to host as static documentation for a service.
• You require consistent, syntax-highlighted code examples and request/response samples.
• You want a quick developer onboarding page with setup and usage examples.
• You need an architecture diagram (SVG) included alongside API workflows.

Best practices

• Provide a clear list of endpoints, methods, and sample payloads to maximize automation accuracy.
• Include example auth tokens or authentication flows so examples are realistic but scrubbed of secrets.
• Prefer explicit request/response JSON examples and HTTP status codes for every endpoint.
• Supply a short description of the system stack to surface relevant getting-started steps.
• Use semantic colors for HTTP methods (GET green, POST blue, DELETE red) to improve readability.

Example use cases

• Generate API documentation for a microservice with CRUD endpoints and examples for each method.
• Create a developer quick-start page with installation commands, import examples, and a minimal app snippet.
• Produce an API reference that includes curl and JavaScript/TypeScript usage examples for every endpoint.
• Export a single-file HTML doc that includes an SVG system architecture diagram for product handoff.
• Document webhook payloads, retry workflows, and example consumer integration code.