Community / AGENT SKILL

docs-readme

0 installs 2 GitHub stars

Создать/обновить README — what/quickstart/usage/config/troubleshooting, примеры проверены на запускаемость, языковые версии в паритете (роль docs). Use когда README отсутствует, устарел или разъехался с кодом.

One new superpower.

Run this command in your project to choose an agent and install the skill.

npx skillycli add https://github.com/Vitammiin/agent-vorcl-flow --skill docs-readmeView original source

BEFORE YOU INSTALL

Understand the trade-offs.

SECURITY REVIEW

Not yet assessed

Review the original instructions and requested permissions before installing.

No security review is available for this catalog entry yet.

SKILL QUALITY

Not yet assessed

How clearly the skill guides your agent, how complete its workflow is, and how you can check the outcome.

No quality assessment is available for this catalog entry yet.

The full skill.

Original instructions from the publisher’s SKILL.md

# Задача: создать/обновить 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`; существующий не переписывай стилистически без запроса — чини дрейф. Отдай путь + доказательства проверки примеров + статус паритета.