Аудит источников и исходных артефактов¶
Базовые входные документы¶
README.mdSERVICES.mddocker-compose.services.yml.gitverse/workflows/gitverse-ci.yaml(и связанныеgitverse-*.yamlв том же каталоге)wiki/Home.mdwiki/Артефакты/Home.md
Инвентаризация существующей документации¶
Технические и эксплуатационные документы¶
db/README.mdtelegram_bot_service/README.mdproduct_service/product_app/management/commands/DOCKER_IMPORT_INSTRUCTIONS.mdproduct_service/product_app/management/commands/IMPORT_SETS_GUIDE.mdproduct_service/product_app/management/commands/README_IMPORT_SETS.md
Wiki-материалы управления проектом¶
wiki/Направление-проекта.mdwiki/Паспорт-проекта.mdwiki/Устав-проекта.mdwiki/Модель-ЖЦ.mdwiki/Проектная-среда.mdwiki/Анализ-конкурентов.mdwiki/Обоснование-стека.mdwiki/Дневник-проекта.mdwiki/Личный-дневник-Архитектора.md
Wiki-артефакты¶
wiki/Артефакты/Use-Case.mdwiki/Артефакты/User-Story-Map.mdwiki/Артефакты/Верификация-и-валидация.mdwiki/Артефакты/Диаграмма-ЖЦ.mdwiki/Артефакты/Диаграммы-C4-и-пользовательский-диалог.mdwiki/Артефакты/Диаграммы_C4_и_пользовательский_диалог.mdwiki/Артефакты/Концептуальная-модель-данных.mdwiki/Артефакты/План-тестирования.mdwiki/Артефакты/План-разработки.mdwiki/Артефакты/Технические-требования-к-API.mdwiki/Артефакты/Риски-проекта.mdwiki/Артефакты/Архитектурные-задачи.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.