# documentation-patterns

Скилл documentation-patterns для Codex даёт шаблоны README, ADR, OpenAPI-документации и changelog. Помогает оформлять документацию проекта и записывать архитектурные решения.

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

## Что делает

Внутри пять наборов правил: для структуры README, записей ADR, API-документации по OpenAPI 3.1, changelog в формате Keep a Changelog и технического стиля. Правила лежат в отдельных файлах и загружаются по мере необходимости. Для API описаны схемы, пути и ответы об ошибках RFC 9457.

Скилл также задаёт формат ADR с контекстом, решением и последствиями, а для текстов рекомендует активный залог, настоящее время и короткие предложения. В Claude Code скилл помечен как недоступный для пользовательского вызова и отключён для вызова моделью, поэтому не рассчитывайте запускать его обычной командой или одним промптом.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add yonatangross/orchestkit --skill documentation-patterns -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add yonatangross/orchestkit --skill documentation-patterns -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add yonatangross/orchestkit --skill documentation-patterns -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install yonatangross/orchestkit src/skills/documentation-patterns
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add yonatangross/orchestkit --skill documentation-patterns -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/yonatangross/orchestkit --path src/skills/documentation-patterns
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add yonatangross/orchestkit --skill documentation-patterns -a opencode
```

### Claude.ai

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

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

## Когда брать
- составить README с разделами для установки и использования
- зафиксировать архитектурное решение вместе с последствиями
- описать REST API в OpenAPI 3.1
- оформить историю релизов по Keep a Changelog
- привести технический текст к единому стилю

## Примеры запросов агенту
- Подготовь README проекта с разделами для установки, использования и конфигурации.
- Запиши это архитектурное решение в формате ADR: добавь контекст и последствия.
- Опиши REST API в OpenAPI 3.1 и включи ответы об ошибках.

## Похожие
- [code-documentation](https://affpapa.org/nevibecode/skills/moizibnyousaf-code-documentation.md) — скилл · 571 установка
- [make-documentation](https://affpapa.org/nevibecode/skills/make-documentation.md) — скилл · 1500 установок
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10800 установок
- [documentation-and-adrs](https://affpapa.org/nevibecode/skills/documentation-and-adrs.md) — скилл · 80700 установок
- [technical-documentation](https://affpapa.org/nevibecode/skills/technical-documentation.md) — скилл · 1900 установок
- [markdown-documentation](https://affpapa.org/nevibecode/skills/markdown-documentation.md) — скилл · 1300 установок

Из того же набора: [yonatangross/orchestkit](https://affpapa.org/nevibecode/by/yonatangross/orchestkit.md) — 86 карточек

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

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