# technical-docs

Скилл technical-docs для Claude Code помогает писать и обновлять техническую документацию, строить диаграммы Mermaid и сверять документацию с кодом. Помогает вести doc-as-code и проверять покрытие.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 177 установок · ★ 29 у репозитория
- Автор: oakoss
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/oakoss/agent-skills/tree/HEAD/skills/technical-docs/SKILL.md
- Обновлён: 2026-08-17
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/technical-docs

## Что делает

Скилл задаёт рабочий процесс для документации рядом с кодом: изменения хранятся в системе контроля версий, проходят линтинг и CI-проверки. Он помогает описывать функции, готовить руководства и проверять, не отстала ли документация от экспорта и изменений в коде. Для рекламных текстов и блогов этот подход не предназначен.

Для диаграмм используются Mermaid: последовательности вызовов, ERD по схемам Drizzle или Prisma, git-графы и блок-схемы. В рекомендациях есть шаблоны ADR и runbook, правила Markdown и процесс черновика с последующей проверкой человеком. Сложные диаграммы предлагается делить на подграфы, ограничивая их 15–20 узлами.

API-справочник скилл советует генерировать по аннотациям JSDoc или TSDoc, а не писать вручную. Проверка покрытия опирается на сравнение изменений в `git diff main...HEAD` со сканированием экспортов, поэтому этот способ аудита рассчитан на проект с Git и веткой `main`.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add oakoss/agent-skills --skill technical-docs -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/technical-docs/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/technical-docs/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add oakoss/agent-skills --skill technical-docs -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add oakoss/agent-skills --skill technical-docs -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install oakoss/agent-skills skills/technical-docs
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add oakoss/agent-skills --skill technical-docs -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/oakoss/agent-skills --path skills/technical-docs
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add oakoss/agent-skills --skill technical-docs -a opencode
```

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/oakoss/agent-skills/tree/HEAD/skills/technical-docs/SKILL.md

## Когда брать
- сверить экспорты кода с покрытием документацией
- построить диаграмму последовательности вызовов в Mermaid
- сгенерировать ERD по схеме Drizzle или Prisma
- подготовить ADR с контекстом и последствиями решения
- составить runbook по симптомам и устранению сбоя

## Примеры запросов агенту
- Проверь изменения в `main...HEAD` и найди экспорты без документации.
- Построй Mermaid-диаграмму последовательности для вызовов между сервисами.
- Подготовь ADR для этого решения: опиши контекст, статус и последствия.

## Похожие
- [technical-writer](https://affpapa.org/nevibecode/skills/curiositech-technical-writer.md) — скилл · 221 установка
- [agent-technical-writer](https://affpapa.org/nevibecode/skills/agent-technical-writer.md) — скилл · 108 установок
- [technical-writing](https://affpapa.org/nevibecode/skills/rudolf-s-technical-writing.md) — скилл · ★ 587 у репозитория
- [project-docs](https://affpapa.org/nevibecode/skills/project-docs.md) — скилл · 1300 установок
- [tech-docs-writer](https://affpapa.org/nevibecode/agents/tech-docs-writer.md) — субагент · ★ 1064 у репозитория
- [figure-docs](https://affpapa.org/nevibecode/plugins/figure-docs.md) — плагин · ★ 65 у репозитория

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

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

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