| name | readme |
| description | Обновление текстового описания README.md - архитектурные блоки, формулировки, примеры кода. Без изменения цифр и бейджей. |
Skill: README (контент)
Обновление текстового содержания README.md. Цифры, бейджи и метрики НЕ трогать.
Перед началом
Обязательно загрузи скилл /humanize и применяй его правила ко всему генерируемому тексту.
Шаги
1. Анализ текущего состояния
Прочитай README.md и сверь каждую формулировку с реальным кодом. Формулировки должны отражать то, что есть в коде прямо сейчас.
2. Обновить секции
- 🏗 Архитектурные решения - описания слоёв, паттернов, DI, Event/Queue, pagination, observability
- Примеры кода - сигнатуры, имена классов, структура
Каждый php-блок сопоставь с реальными классами. Обнови при любом расхождении.
3. Проверка стиля
- Скилл
/humanize - все правила из него обязательны
- Тон - пиши как опытный коллега, коротко и по делу
- Типографика - обычные дефисы (-), без длинных тире (—), без двоеточий и точек с запятой в прозе
- Регистр - Sentence case в заголовках, после двоеточия с маленькой буквы
- Терминология - инфраструктурные термины переводим (контроллеры, формы, слои), доменные паттерны оставляем (Value Object, Use Case, DTO, Repository, Handler, Query Service)
- Сверка с кодом - каждый пункт подтверждается кодом
4. Что НЕ трогать
- Цифры, бейджи, метрики тестирования
- Дерево файлов (Project Structure)
- Другие файлы документации (docs/)
5. Валидация
Запусти bin/validate-docs для проверки ссылок.
6. Финализация
⛔️ НЕ ДЕЛАЙ КОММИТ. Оставь файлы изменёнными. Пользователь сам решит когда коммитить.