# documentation-templates

Скилл даёт структуру и шаблоны для README, API-документации, комментариев и других проектных записей. Пригодится, когда нужно оформить документацию с нуля или привести её к общему виду.

- скилл · `type=skill` · Claude Code · 305 установок
- Автор: davila7
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/davila7/claude-code-templates/tree/HEAD/cli-tool/components/skills/document-processing/documentation-templates
- Обновлён: 2026-10-24
- HTML: https://affpapa.org/nevibecode/skills/documentation-templates

## Что делает

Внутри есть шаблоны для README, описания API-эндпоинтов, комментариев JSDoc/TSDoc, changelog и ADR. Для README предложены разделы от краткого описания и быстрого старта до конфигурации и лицензии; в API-шаблоне предусмотрены параметры, ответы и пример запроса. Скилл также описывает, когда комментарий объясняет важную логику, а когда лишь повторяет очевидное из кода.

Отдельный раздел посвящён материалам для AI-инструментов: структуре `llms.txt` и подготовке документации для RAG-индексации. В рекомендациях есть иерархия заголовков, примеры JSON/YAML, диаграммы Mermaid и самостоятельные разделы. Шаблоны служат основой, которую нужно подстроить под проект. Для работы с файлами скиллу разрешены `Read`, `Glob` и `Grep`, поэтому он ориентирован на чтение и поиск, а не на инструменты записи.

## Установка

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

1. **Через claude-code-templates**
```bash
npx claude-code-templates@latest --skill document-processing/documentation-templates
```

2. **Через Skills CLI (Vercel)**
```bash
npx skills add davila7/claude-code-templates --skill documentation-templates -a claude-code
```

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

### Codex

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

### Cursor

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install davila7/claude-code-templates documentation-templates
```

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

### Gemini CLI

**Командой платформы**
```bash
gemini skills install https://github.com/davila7/claude-code-templates --path cli-tool/components/skills/document-processing/documentation-templates
```

### Windsurf (Devin Desktop)

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

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/davila7/claude-code-templates/tree/HEAD/cli-tool/components/skills/document-processing/documentation-templates

## Когда брать
- составить README с разделами для запуска и конфигурации
- описать API-эндпоинт с параметрами и вариантами ответа
- добавить комментарии к сложной логике и контрактам API
- оформить changelog или запись ADR
- подготовить документацию к AI-поиску и RAG-индексации

## Примеры запросов агенту
- Составь структуру README для этого проекта по шаблону скилла.
- Оформи документацию для API-эндпоинтов: добавь параметры, ответы и примеры.
- Проверь комментарии в коде и предложи, где нужно объяснить логику, а где комментарии лишние.

## Похожие
- [grill-with-docs](https://affpapa.org/nevibecode/skills/grill-with-docs.md) — скилл · 1219756 установок
- [skill-creator](https://affpapa.org/nevibecode/skills/skill-creator.md) — скилл · 414180 установок
- [setup-matt-pocock-skills](https://affpapa.org/nevibecode/skills/setup-matt-pocock-skills.md) — скилл · 1052851 установка
- [handoff](https://affpapa.org/nevibecode/skills/handoff.md) — скилл · 1038491 установка
- [triage](https://affpapa.org/nevibecode/skills/triage.md) — скилл · 990453 установки
- [domain-modeling](https://affpapa.org/nevibecode/skills/domain-modeling.md) — скилл · 876391 установка

Из того же набора: [davila7/claude-code-templates](https://affpapa.org/nevibecode/by/davila7/claude-code-templates.md) — 495 карточек

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