# indexion-readme

Скилл собирает README из шаблонов, doc-комментариев и статических файлов, а потом проверяет, что правки ничего не удалили.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 5100 установок · ★ 2
- Автор: trkbt10
- Лицензия: Apache-2.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/trkbt10/indexion-skills/tree/HEAD/skills/indexion-readme/SKILL.md
- Обновлён: 2026-09-22
- HTML: https://affpapa.org/nevibecode/skills/indexion-readme

## Что делает

Скилл закрывает сторону сборки документации: скаффолдинг, генерацию по пакетам, планирование текста, финальную сборку корневого README и проверку результата. Оценка уже написанной документации — это отдельный скилл `indexion-documentation`.

Внутри — работа с `doc.json` (в корне репозитория или в `.indexion/readme/`), шаблоном `docs/templates/readme.md`, статическими файлами вроде `docs/intro.md` и `docs/installation.md` и per-package README в `cmd/<name>/README.md`. Генерация `doc readme --per-package` не перезаписывает существующие файлы, а скелет получается только из API по `///`-комментариям — прозу про Overview, Usage, Options и Examples придётся дописывать руками. Проверка идёт через `plan drift`: сравнение старой и новой версии показывает, что именно добавилось, а что пропало.

Осторожнее с режимом `doc readme --template=<t> <paths...>`: он обходит указанные пути и сам создаёт README для пакетов, у которых его нет, даже без `--per-package`. Запустите на `cmd/` или `src/` — получите новые файлы в посторонних пакетах. Берите узкий путь или проверяйте `git status` после прогона.

## Установка

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

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

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install trkbt10/indexion-skills indexion-readme
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

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

### Claude.ai

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

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

## Когда брать
- собрать корневой README из статических файлов и README отдельных пакетов
- сгенерировать скелеты README по doc-комментариям без перезаписи готовых файлов
- разложить написание разделов на задачи через `plan readme`
- проверить, что правка README только добавила текст и ничего не выкинула
- поймать случайную крупную переписку README в CI через порог `--vocab-threshold`

## Примеры запросов агенту
- Собери корневой README по `doc.json` и покажи, какие секции попали в вывод
- Сгенерируй per-package README для `src/` и `cmd/`, существующие файлы не трогай
- Сравни `README.md` с версией из HEAD через `plan drift` и скажи, что пропало

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

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

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

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