Skip to main content
skill CX Codex

technical-doc-creator — Claude Code skill: docs and setup

technical-doc-creator builds HTML documentation for APIs and systems with code samples, architecture diagrams, syntax highlighting, and workflow steps.

Apache-2.0 221 installs ★ 697 updated 2026-07-25

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a claude-code
Open on GitHub

What technical-doc-creator does

This skill turns API or system details into an HTML documentation page. It can lay out an overview, setup guide, endpoint reference with request and response samples, highlighted code blocks, and an SVG architecture diagram when relevant.

Its workflow first extracts endpoints, HTTP methods, and parameters. It then adds examples for common operations and describes processes as ordered steps. HTTP methods receive distinct semantic colors: GET is green, POST is blue, and DELETE is red.

The workflow writes the result to [system]-docs.html, so the system name must be chosen before generation. The skill is available for Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, and OpenCode.

What it helps with

  • create HTML API documentation
  • describe endpoints with request and response samples
  • add syntax-highlighted code examples
  • draw a system architecture diagram in SVG
  • turn API workflows into ordered steps

Example prompts for the agent

  • Create HTML documentation for this API and save it as [system]-docs.html.
  • Document the endpoints, parameters, and request and response examples for this service.
  • Generate developer docs for the system with an architecture diagram and code samples.

How to install technical-doc-creator

1Skills CLI (Vercel)

npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a claude-code

2Manually: put the files in place

~/.claude/skills/technical-doc-creator/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/technical-doc-creator/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about technical-doc-creator

How do I install technical-doc-creator in Claude Code?

Run npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a claude-code, then check ~/.claude/skills/technical-doc-creator/SKILL.md.

What does technical-doc-creator do?

It creates HTML technical documentation with an overview, setup section, API reference, code examples, workflow steps, and an SVG architecture diagram.

What file does the skill create?

Its workflow writes the generated document to [system]-docs.html. Replace [system] with the system name.

Source text

SKILL.md · Apache-2.0
---
name: technical-doc-creator
description: 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.
---

# 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": 123,
  "name": "John Doe",
  "email": "[email protected]"
}</code></pre>
</div>
```

## Code Block Pattern

```html
<pre><code>// Installation
npm install package-name

// Usage
import { feature } from 'package-name';
const result = feature.doSomething();</code></pre>
```

## Workflow

1. Extract API endpoints, methods, parameters
2. Create overview and getting started sections
3. Document each endpoint with examples
4. Add code snippets for common operations
5. Include architecture diagram if relevant
6. Write to `[system]-docs.html`

Use semantic colors for HTTP methods: GET (green), POST (blue), DELETE (red).

© mhattingpete · Apache-2.0 · mhattingpete/claude-skills-marketplace

Similar skills

All skills for Writing and docs →

From the same set15

The whole set →
timeline-creator timeline-creator turns a project's tasks and dates into an interactive HTML timeline with Gantt bars, phases and milestones. Handy when a plan has to live in one file. CX Codex +1 337installs code-refactor code-refactor is a Claude Code skill for bulk code changes across files: renaming variables and functions, replacing deprecated patterns, and updating API calls. It automatically selects a mode that saves up to 90% of tokens for 10+ files. CX Codex +1 304installs feature-planning The feature-planning skill turns feature requests and complex changes into ordered implementation plans with concrete tasks. Use it before coding when the scope needs structure. CX Codex +1 297installs code-execution The code-execution skill runs Python locally for bulk file work, code analysis, transformations, and Git tasks. It fits large or multi-step workflows. CX Codex +1 294installs conversation-analyzer conversation-analyzer analyzes your local Claude Code session logs to detect recurring errors, repetitive prompts, and workflow bottlenecks. CX Codex +1 249installs ensemble-solving ensemble-solving spawns three parallel subagents to explore diverse solutions, scores each approach against weighted criteria, and returns the best outcome with trade-offs. CX Codex +1 218installs project-bootstrapper project-bootstrapper — a skill for Claude Code, Cursor, Codex and other platforms that scaffolds a new project or levels up an existing one: directories, linter configs, tests, Git hooks, CI/CD and documentation. CX Codex +1 212installs code-transfer A skill for precise code transfer between files using line-based positioning. Useful when you need to move a function to another file, extract a class into a separate module, or insert code at a specific line number. CX Codex +1 173installs

Project sponsors

Companies that keep this analytics open