technical-doc-creator — скилл для Claude Code и установка
Скилл technical-doc-creator создаёт HTML-документацию для API и систем: с примерами кода, диаграммой архитектуры и пошаговыми сценариями.
Apache-2.0 221 установок ★ 697 обновлён 2026-07-25
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a claude-codeЧто делает 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-code2Вручную: положить файлы
~/.claude/skills/technical-doc-creator/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/technical-doc-creator/
1Через Skills CLI (Vercel)
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a codex2Вручную: положить файлы
.agents/skills/technical-doc-creator/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a cursor2Вручную: положить файлы
.cursor/skills/technical-doc-creator/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install mhattingpete/claude-skills-marketplace visual-documentation-plugin/skills/technical-doc-creator2Вручную: положить файлы
.github/skills/technical-doc-creator/SKILL.md1Через Skills CLI (Vercel)
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a gemini-cli2Командой платформы
gemini skills install https://github.com/mhattingpete/claude-skills-marketplace --path visual-documentation-plugin/skills/technical-doc-creatorВручную: положить файлы
.devin/skills/technical-doc-creator/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add mhattingpete/claude-skills-marketplace --skill technical-doc-creator -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в 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