К основному содержанию
скилл CX Codex

technical-doc-creator — скилл для Claude Code и установка

Скилл technical-doc-creator создаёт HTML-документацию для API и систем: с примерами кода, диаграммой архитектуры и пошаговыми сценариями.

Apache-2.0 221 установок ★ 697 обновлён 2026-07-25

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a claude-code
Открыть на GitHub

Что делает technical-doc-creator

Скилл собирает HTML-документацию для API, сервисов и других технических систем. Он формирует обзор, раздел быстрого старта, справочник эндпоинтов с примерами запросов и ответов, блоки кода с подсветкой синтаксиса и SVG-диаграмму архитектуры, если она нужна.

Рабочий процесс начинается с разбора эндпоинтов, методов и параметров. Затем агент добавляет примеры распространённых операций и описывает процессы по шагам. Для HTTP-методов используются разные цвета: GET — зелёный, POST — синий, DELETE — красный.

Документ записывается в файл [system]-docs.html, поэтому перед запуском нужно определить имя системы. Скилл доступен в Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode.

Какие задачи решает

  • собрать HTML-документацию для API
  • описать эндпоинты с запросами и ответами
  • добавить подсвеченные примеры кода
  • показать архитектуру системы в SVG
  • разложить API-процесс по шагам

Примеры запросов агенту

  • Создай документацию API для сервиса в файле [system]-docs.html.
  • Опиши эндпоинты, параметры и примеры запросов и ответов в HTML.
  • Сделай техническую документацию для системы с диаграммой архитектуры и примерами кода.

Как установить technical-doc-creator

1Через Skills CLI (Vercel)

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

2Вручную: положить файлы

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

Папка скилла целиком; для одного проекта — .claude/skills/technical-doc-creator/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о technical-doc-creator

Как установить technical-doc-creator в Claude Code?

Выполните npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a claude-code, затем проверьте файл ~/.claude/skills/technical-doc-creator/SKILL.md.

Что делает technical-doc-creator?

Скилл создаёт HTML-документацию с обзором, быстрым стартом, API-справочником, примерами кода, рабочими процессами и SVG-диаграммой архитектуры.

Какой файл создаёт скилл?

По рабочему процессу результат записывается в [system]-docs.html. Имя системы нужно подставить вместо [system].

Исходный текст

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

Похожие скиллы

Все скиллы по теме «Тексты и документация» →
technical-design-doc-creator tech-leads-club Скилл technical-design-doc-creator помогает составить технический дизайн-документ (TDD, RFC, спеку) перед разработкой через интерактивные вопросы. Пригодится при согласовании архитектуры и миграций в команде. CX Codex +1 655установок swagger-doc-creator Jeremy Longshore Скилл swagger-doc-creator помогает составлять документацию Swagger и спецификации OpenAPI, настраивать конфигурации и проверять схемы API по стандартам индустрии. CX Codex +1 239установок dart-use-doc-examples flutter Скилл dart-use-doc-examples учит агента вставлять внешние примеры кода в Dartdoc через директиву {@example} вместо inline-блоков. CX Codex +1 9 200установок context7 dotneet Получает через Context7 актуальную документацию библиотек и примеры кода. Отвечает на вопросы об API и конкретных версиях. CX Codex +1 412установок design-doc-mermaid SpillwaveSolutions Скилл design-doc-mermaid генерирует диаграммы Mermaid и техническую документацию по коду или описанию задачи. Подходит для оформления GitHub wiki, системных архитектур и схем баз данных. CX Codex +1 101 800установок technical-specification secondsky Скилл technical-specification для Claude Code ведёт агента по шаблону технической спецификации: требования, архитектура, API, план внедрения, тесты и риски. Фиксирует договорённости до написания кода. CX Codex +1 498установок

Из того же набора15

Весь набор →
timeline-creator Скилл timeline-creator для Claude Code собирает интерактивный HTML-таймлайн проекта с диаграммой Ганта, фазами и вехами. Показывает план на кварталы в одном файле. CX Codex +1 337установок code-refactor Скилл code-refactor для Claude Code массово переименовывает переменные и функции, заменяет устаревшие паттерны и обновляет вызовы API в нескольких файлах. Для 10+ файлов автоматически выбирает режим, экономящий до 90% токенов. CX Codex +1 304установок feature-planning Скилл feature-planning превращает запрос на новую функцию или сложное изменение в пошаговый план с задачами, файлами и проверками. Пригодится до начала реализации. CX Codex +1 297установок code-execution Скилл code-execution для Claude Code запускает Python локально для массовых операций с файлами, анализа кода и Git. Выполняет большие многошаговые задачи. CX Codex +1 294установок conversation-analyzer Скилл conversation-analyzer изучает локальную историю диалогов Claude Code, чтобы выявить повторяющиеся ошибки, однотипные запросы и пиковые часы продуктивности. CX Codex +1 249установок ensemble-solving Скилл ensemble-solving запускает трёх субагентов для параллельного поиска решений задачи, сравнивает подходы по шкале критериев и выдаёт лучший вариант с разбором альтернатив. CX Codex +1 218установок project-bootstrapper Скилл project-bootstrapper для Claude Code, Cursor, Codex и других платформ, который разворачивает структуру нового проекта или достраивает имеющийся: директории, конфиги линтеров, тесты, Git-хуки, CI/CD и документацию. CX Codex +1 212установок code-transfer Скилл code-transfer для Claude Code переносит код между файлами по номерам строк. Перемещает функции, извлекает классы в модули и вставляет код на заданную строку. CX Codex +1 173установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой