# crafting-effective-readmes

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

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

## Что делает

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

Для разных проектов предусмотрены шаблоны: `templates/oss.md` для открытых проектов, `templates/personal.md` для личных проектов и портфолио, `templates/internal.md` для внутренней документации и `templates/xdg-config.md` для конфигурационных файлов. Скилл также обращается к `section-checklist.md`, `style-guide.md` и `using-references.md`, чтобы подобрать разделы и проверить изложение.

В каждом README должны быть название, краткое объяснение назначения и инструкции по использованию. При обновлении агент читает существующий файл, сопоставляет его с `package.json` и основными файлами проекта, а затем предлагает конкретные правки. Это важно: если в коде нет подтверждения старой инструкции, её нельзя считать актуальной только потому, что она осталась в README.

## Установка

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

1. **Через claude-code-templates**
```bash
npx claude-code-templates@latest --skill productivity/crafting-effective-readmes
```

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

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

### Codex

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

### Cursor

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

### GitHub Copilot

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

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

### Gemini CLI

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

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/crafting-effective-readmes/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/productivity/crafting-effective-readmes

## Когда брать
- Создать README для нового репозитория с нуля
- Добавить описание функции в существующую документацию
- Найти устаревшие инструкции после изменения кода
- Подобрать разделы README для внутреннего проекта или конфигурации
- Проверить, соответствует ли документация файлам проекта

## Примеры запросов агенту
- Создай README для открытого проекта и используй шаблон `templates/oss.md`.
- Проверь README и сравни инструкции с `package.json` и основными файлами проекта.
- Добавь в существующий README раздел о новой функции и предложи конкретные правки.

## Похожие
- [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) — 651 карточка

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