# readme-best-practices

Скилл readme-best-practices для Claude Code помогает писать и проверять README проектов. Он подключается при создании файла, переработке существующего README или оценке его качества.

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

## Что делает

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

В рекомендациях есть таблица для описания функций, требования к командам и примерам, а также проверка ссылок и изображений. Разделы README предлагают включать только тогда, когда в них есть содержательная информация. Бейджи сборки, версии, лицензии и покрытия уместны, если проект настроен на CI или публикацию.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill readme-best-practices -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill readme-best-practices -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill readme-best-practices -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install Mindrally/skills readme-best-practices
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill readme-best-practices -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/Mindrally/skills --path readme-best-practices
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill readme-best-practices -a opencode
```

### Claude.ai

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

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

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

## Примеры запросов агенту
- Напиши README для моей библиотеки с установкой и коротким примером.
- Переработай README CLI и добавь ясный быстрый старт.
- Проверь README репозитория: ссылки, примеры и основные разделы.

## Похожие
- [create-readme](https://affpapa.org/nevibecode/skills/create-readme.md) — скилл · 19081 установка
- [readme-optimization](https://affpapa.org/nevibecode/skills/readme-optimization.md) — скилл · 13600 установок
- [readme-blueprint-generator](https://affpapa.org/nevibecode/skills/readme-blueprint-generator.md) — скилл · 9662 установки
- [indexion-readme](https://affpapa.org/nevibecode/skills/indexion-readme.md) — скилл · 5100 установок
- [beautify-github-readme](https://affpapa.org/nevibecode/skills/beautify-github-readme.md) — скилл · 1300 установок

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

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

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