Перейти к содержанию

Финальный аудит полноты документации

Покрытие по сервисам

  • auth_service: полный API, модель пользователя, auth-flow.
  • user_service: профили, роли, seller request workflow.
  • product_service: каталог, ETL, медиа, риски доступа.
  • order_service: cart/order contracts, async ZIP pipeline, бот-интеграции.
  • review_service: бизнес-валидации отзывов и статистика.
  • admin_service: агрегатор, модерация, notifications, риски связности.
  • chat_service: conversations/messages, права, edge-cases.
  • telegram_bot_service: команды, FSM, payment and ZIP delivery flow.

Покрытие инфраструктуры и операций

  • Docker Compose topology.
  • Конфигурационная модель env.
  • PostgreSQL/Redis/Celery.
  • Runbooks: startup, incidents, backup/restore, release.

Покрытие governance

  • Стандарты документации.
  • Проектный контекст, устав, жизненный цикл.
  • ADR-реестр.
  • QA стратегия и управление изменениями.
  • Реестр рисков.

Контроль качества

  • Локальный markdown style-check script.
  • Локальный markdown link-check script.
  • mkdocs build --strict.
  • CI job docs_checks.

Открытые улучшения

  • Постепенная стандартизация error envelope между сервисами.
  • Введение OpenAPI-спецификаций для автоматизируемого API-реестра.
  • Ужесточение защиты bot endpoint-ов в order_service.

Master-alignment

Полный реестр формальных правил и ответственности см. в Master-документации проекта.

Дополнительный контроль полноты:

  1. Проверка наличия ссылки на master-страницу в ключевых разделах.
  2. Проверка покрытия обязательных блоков (CI/CD, AI, риски, MVP, RACI).
  3. Проверка отсутствия конфликтов между master-правилами и дочерними страницами.