Создать/обновить README — what/quickstart/usage/config/troubleshooting, примеры проверены на запускаемость, языковые версии в паритете (роль docs). Use когда README отсутствует, устарел или разъехался с кодом.
Installs into .claude/skills of the current project.
Are you the author of Docs Readme?
Add the live security badge to your README. It updates with every re-scan.
[](https://www.skillsdirectory.com/skills/vitammiin-docs-readme)
---
name: docs-readme
description: Создать/обновить README — what/quickstart/usage/config/troubleshooting, примеры проверены на запускаемость, языковые версии в паритете (роль docs). Use когда README отсутствует, устарел или разъехался с кодом.
---
# Задача: создать/обновить README
Создай или обнови README (см. `$technical-writing`).
1. Изучи реальность: `package.json` (`scripts`, `engines`), lock-файл, структура, точки входа, `.env.example` — README описывает то, что есть в коде сейчас.
2. Структура: лид «что это и зачем» (без воды) → Quickstart (минимум шагов до работающего) → Usage → Configuration (таблица env/опций из кода) → Troubleshooting → лицензия.
3. **Каждый пример прогони** или сверь со `scripts`; флаги/env — грепом по коду. Пример работает копипастом; плейсхолдеры — явные `<...>`. Счётчики/версии — из реальных файлов. Относительные ссылки — проверь существование целей.
4. README на других языках — синхронизируй паритет: те же секции и факты, кодовые блоки идентичны (код не переводится), взаимные ссылки-переключатели.
По умолчанию — корневой `README.md`; существующий не переписывай стилистически без запроса — чини дрейф. Отдай путь + доказательства проверки примеров + статус паритета.
