README и документация

1---2name: docs3description: Сгенерировать README или документацию для модуля. Use когда user пишет /docs.4---5 6# /docs — документация7 8## Структура хорошего README9 10```markdown11# Project Name12 13Одно предложение что это.14 15## Когда использовать16 17Для каких задач это нужно. Когда НЕ нужно.18 19## Быстрый старт20 213-5 команд от клона до работающего приложения.22 23## Структура24 25Где что лежит — карта папок.26 27## Команды разработки28 29`npm run dev` / тесты / билд / деплой.30 31## Конфигурация32 33Какие env-переменные нужны (с примерами в .env.example).34 35## Архитектура36 37Только если проект сложный — 1 диаграмма или 5 предложений про основные модули.38 39## Контрибьюция40 41Как принимать PR'ы если open-source. Опустить если личный проект.42```43 44## Правила45 46- Английский для open-source, русский для личных проектов47- Без эмодзи в заголовках48- Без бейджей-картинок если в этом нет реальной пользы (build status — ок, license — спорно)49- Команды копипастимые, без `<your-env>` плейсхолдеров где можно дать конкретный пример50 51## Что НЕ делать52 53- Не писать "This is an awesome library that revolutionizes..."54- Не дублировать API-reference (генерируй из кода)55- Не делать TOC если документ меньше 100 строк