README по образцу ipam_control
README переверстан (docs/changes/024): быстрый старт, конфигурация одной таблицей, архитектура с деревом каталогов, функциональность и правила по разделам (таблица состояний «Upgrade ROS»), API по областям с соглашениями, безопасность, эксплуатация (в т.ч. копия БД в режиме WAL, стенд на порту 8001), интерфейс, тесты, история изменений таблицей со ссылками на план и итог, отчёты ревью. Повторы убраны. Все 51 ссылка на документы проверены; переменные, эндпоинты и число тестов сверены с кодом. Код не менялся. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
ae826fc562
commit
7c830be721
3 files changed
+227
-145
No files matched your search
@@ -0,0 +1,32 @@
|
||||
# План: 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`.
|
||||
@@ -0,0 +1,18 @@
|
||||
# Итоги: 024 — оптимизация README по образцу ipam_control
|
||||
|
||||
## Сделано
|
||||
- README переверстан по структуре `/opt/lvraid/claude/ipam_control/README.md`: «Быстрый старт», «Конфигурация» (одна таблица),
|
||||
«Архитектура» (таблица слоёв и дерево каталогов), «Функциональность и правила» (полужирные подзаголовки, таблица состояний «Upgrade ROS»),
|
||||
«Требования к устройствам», «API» (таблица по областям и «Соглашения»), «Безопасность», «Эксплуатация», «Интерфейс», «Тесты»,
|
||||
«История изменений» (таблица со ссылками на `plan.md`/`summary.md` 001–024), «Отчёты ревью».
|
||||
- Убраны повторы: требования к секретам и команды генерации — по одному месту; длинные описания истории изменений — в документах изменений.
|
||||
- Добавлено: раздел «Отчёты ревью», копирование БД в режиме WAL (замечание 13 повторного ревью, только документация), текущий стенд на порту 8001,
|
||||
коды ошибок API (включая 401), синхронность смены канала одного устройства и `refresh`.
|
||||
|
||||
## Проверено
|
||||
- Все 51 ссылка (49 на `docs/changes/*`, 2 на `docs/reviews/*`) указывают на существующие файлы.
|
||||
- Переменные `.env` сверены с `app/config.py`, эндпоинты — с `app/api/v1.py`, число тестов (33) — с `pytest --collect-only`.
|
||||
- Код не менялся, стенд не пересобирался.
|
||||
|
||||
## Оговорки
|
||||
- Документы изменений в этом проекте названы `plan.md`/`summary.md` (в образце — `PLAN.md`/`SUMMARY.md`); регистр сохранён как есть.
|
||||
Reference in new issue
Block a user