# technical-doc-creator

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

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 221 установка · ★ 697 у репозитория
- Автор: mhattingpete
- Лицензия: Apache-2.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/mhattingpete/claude-skills-marketplace/tree/HEAD/visual-documentation-plugin/skills/technical-doc-creator/SKILL.md
- Обновлён: 2026-07-25
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/technical-doc-creator

## Что делает

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

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

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

## Установка

### Claude Code (родная платформа)

1. **Через Skills CLI (Vercel)**
```bash
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/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/technical-doc-creator/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/technical-doc-creator/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install mhattingpete/claude-skills-marketplace visual-documentation-plugin/skills/technical-doc-creator
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/technical-doc-creator/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/mhattingpete/claude-skills-marketplace --path visual-documentation-plugin/skills/technical-doc-creator
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/technical-doc-creator/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/mhattingpete/claude-skills-marketplace/tree/HEAD/visual-documentation-plugin/skills/technical-doc-creator/SKILL.md

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

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

## Похожие
- [technical-design-doc-creator](https://affpapa.org/nevibecode/skills/technical-design-doc-creator.md) — скилл · 655 установок
- [swagger-doc-creator](https://affpapa.org/nevibecode/skills/swagger-doc-creator.md) — скилл · 239 установок
- [dart-use-doc-examples](https://affpapa.org/nevibecode/skills/dart-use-doc-examples.md) — скилл · 9200 установок
- [context7](https://affpapa.org/nevibecode/skills/dotneet-context7.md) — скилл · 412 установок
- [design-doc-mermaid](https://affpapa.org/nevibecode/skills/design-doc-mermaid.md) — скилл · 101800 установок
- [technical-specification](https://affpapa.org/nevibecode/skills/secondsky-technical-specification.md) — скилл · 498 установок

Из того же набора: [mhattingpete/claude-skills-marketplace](https://affpapa.org/nevibecode/by/mhattingpete/claude-skills-marketplace.md) — 15 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
