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

Аудит источников и исходных артефактов

Базовые входные документы

  • README.md
  • SERVICES.md
  • docker-compose.services.yml
  • .gitverse/workflows/gitverse-ci.yaml (и связанные gitverse-*.yaml в том же каталоге)
  • wiki/Home.md
  • wiki/Артефакты/Home.md

Инвентаризация существующей документации

Технические и эксплуатационные документы

  • db/README.md
  • telegram_bot_service/README.md
  • product_service/product_app/management/commands/DOCKER_IMPORT_INSTRUCTIONS.md
  • product_service/product_app/management/commands/IMPORT_SETS_GUIDE.md
  • product_service/product_app/management/commands/README_IMPORT_SETS.md

Wiki-материалы управления проектом

  • wiki/Направление-проекта.md
  • wiki/Паспорт-проекта.md
  • wiki/Устав-проекта.md
  • wiki/Модель-ЖЦ.md
  • wiki/Проектная-среда.md
  • wiki/Анализ-конкурентов.md
  • wiki/Обоснование-стека.md
  • wiki/Дневник-проекта.md
  • wiki/Личный-дневник-Архитектора.md

Wiki-артефакты

  • wiki/Артефакты/Use-Case.md
  • wiki/Артефакты/User-Story-Map.md
  • wiki/Артефакты/Верификация-и-валидация.md
  • wiki/Артефакты/Диаграмма-ЖЦ.md
  • wiki/Артефакты/Диаграммы-C4-и-пользовательский-диалог.md
  • wiki/Артефакты/Диаграммы_C4_и_пользовательский_диалог.md
  • wiki/Артефакты/Концептуальная-модель-данных.md
  • wiki/Артефакты/План-тестирования.md
  • wiki/Артефакты/План-разработки.md
  • wiki/Артефакты/Технические-требования-к-API.md
  • wiki/Артефакты/Риски-проекта.md
  • wiki/Артефакты/Архитектурные-задачи.md

Критичные наблюдения аудита

  • Отсутствуют mkdocs.yml и docs/ в исходном состоянии.
  • Отсутствуют OpenAPI/Swagger спецификации для сервисов.
  • В wiki есть дубли (Диаграммы-C4... и Диаграммы_C4...).
  • В wiki присутствуют ссылки на бинарные вложения, отсутствующие в репозитории.
  • Есть рассинхронизация портов БД в README.md/SERVICES.md и docker-compose.services.yml.
  • В CI отсутствовали проверки документации (mkdocs build, markdown lint, link checks).

Выход аудита

Результаты аудита использованы как исходный материал для:

  • проектирования новой информационной архитектуры документации;
  • миграции и нормализации wiki-страниц;
  • формирования формального шаблона страниц сервисов;
  • включения quality gates документации в CI.