# План: 024 — оптимизация README по образцу ipam_control ## Context README вырос за 23 изменения: длинные абзацы, повторы (требования к секретам — в трёх разделах, генерация ключей — в двух), история изменений — список с длинными описаниями без ссылок на документы, нет раздела об отчётах ревью, эксплуатационные сведения (том, миграции, один процесс, WAL) разбросаны. Пользователь просит переверстать README по образцу `/opt/lvraid/claude/ipam_control/README.md`. ## Изменения (только `README.md`) Структура образца: 1. Заголовок и абзац о проекте (+ схема компонентов). 2. **Быстрый старт** — команды и адреса UI/OpenAPI, вход. 3. **Конфигурация (`.env`)** — одна таблица «Переменная | По умолчанию | Назначение», требования к секретам — только здесь и в «Безопасности». 4. **Архитектура** — таблица слоёв и дерево каталогов. 5. **Функциональность и правила** — полужирные подзаголовки: устройства, состояния «Upgrade ROS», группы и фильтры, операции и задачи, бэкапы, откат ROS, идентификаторы, журнал событий. 6. **Требования к устройствам**. 7. **API (`/api/v1`)** — таблица по областям + «Соглашения». 8. **Безопасность** — секреты, вход, cookie, шифрование, секреты в бэкапах. 9. **Эксплуатация** — контейнер и том, миграции, один процесс, кэш бакета, копирование БД в режиме WAL (замечание 13 повторного ревью — только документация), текущий стенд на порту 8001. 10. **Интерфейс** — короткий список. 11. **Тесты** — команда и число тестов. 12. **История изменений** — таблица «№ | Изменение | Документы» со ссылками на `plan.md`/`summary.md` (001–024). 13. **Отчёты ревью** — ссылки на `docs/reviews/` с указанием, в какие изменения они вылились. Содержание не теряется: каждое утверждение текущего README переносится в свой раздел (сверка списком фактов при ревью). ## Исполнение Только документация — оркестратор сам (навык change-flow: документация без исполнителя). Код не меняется, стенд не пересобирается. ## Проверка - Все ссылки на `docs/changes/*/plan.md|summary.md` и `docs/reviews/*.md` указывают на существующие файлы (скрипт). - Сверка фактов: переменные `.env` из `app/config.py`, эндпоинты из `app/api/v1.py`, число тестов из `pytest --collect-only`.