| name | docs |
| description | Обновление технической документации docs/ARCHITECTURE.md и docs/COMPARISON.md по текущему состоянию кода. Сложная задача - полная сверка паттернов, примеров и формулировок. |
Skill: Обновление документации (docs/)
Актуализация docs/ARCHITECTURE.md и docs/COMPARISON.md по текущему состоянию кода. Это сложная задача, требующая тотальной сверки каждого утверждения с реальным кодом.
Перед началом
Обязательно загрузи скилл /humanize и применяй его правила ко всему генерируемому тексту.
Целевые файлы
docs/ARCHITECTURE.md - описание архитектуры, слоёв, паттернов, примеры кода
docs/COMPARISON.md - сравнительная таблица "было (стандартный Yii2) vs стало (текущая архитектура)"
Шаги
1. Полное чтение документации
Прочитай оба файла целиком. Зафиксируй все утверждения, которые нужно проверить.
2. Сверка с кодом
Для КАЖДОГО утверждения и примера кода в документации выполни проверку.
ARCHITECTURE.md:
- Все упомянутые классы, интерфейсы, пространства имён существуют
- Сигнатуры методов в примерах совпадают с реальными
- Описания слоёв соответствуют реальной структуре
src/
- Упомянутые паттерны (Repository, Use Case, Pipeline, Specification, ...) реально используются
- Диаграммы потоков данных отражают реальные зависимости
COMPARISON.md:
- Столбец "было" корректно описывает стандартный подход Yii2
- Столбец "стало" точно отражает текущую реализацию
- Примеры кода в обоих столбцах актуальны
- Нет устаревших паттернов, которые уже были заменены или удалены
3. Обновление
Обнови всё, что расходится с кодом. Добавь новые паттерны и решения, если они появились, но отсутствуют в документации.
4. Проверка стиля
- Скилл
/humanize - все правила из него обязательны
- Тон - пиши как опытный коллега, коротко и по делу
- Типографика - обычные дефисы (-), без длинных тире (—), без двоеточий и точек с запятой в прозе
- Регистр - Sentence case в заголовках, после двоеточия с маленькой буквы
- Терминология - инфраструктурные термины переводим (контроллеры, формы, слои), доменные паттерны оставляем (Value Object, Use Case, DTO, Repository, Handler, Query Service)
- Каждый пункт подтверждается кодом - никаких предположений
5. Валидация
Запусти bin/validate-docs для проверки ссылок.
6. Что НЕ трогать
README.md (для него отдельные скиллы /readme и /badges)
docs/DECISIONS.md
7. Финализация
⛔️ НЕ ДЕЛАЙ КОММИТ. Оставь файлы изменёнными. Пользователь сам решит когда коммитить.