Документация ArchMap

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

ArchMap описывает программную систему в виде дерева объектов произвольной глубины. У каждого уровня дерева своя архитектурная схема, у каждого объекта своя страница с документацией.

К ArchMap можно подключить своего ИИ-агента по протоколу MCP. Читателю агент отвечает на вопросы об устройстве системы: какой сервис за что отвечает, кто пишет в таблицу, через какие каналы идёт событие. Ответы он берёт из схем и документации проекта.

Архитектору агент помогает документировать систему. Агент с доступом к исходному коду изучает сервисы и сразу записывает в ArchMap схемы, логику операций и факты из кода.

Примечание

Документирование через ИИ-агента пока работает в режиме бета-версии, поэтому результат агента стоит перепроверить, а кое-где поправить вручную.

Документация поделена по ролям. Выберите руководство в дереве слева или воспользуйтесь поиском вверху страницы.

Руководства

Руководство пользователяКак читать схемы, перемещаться по уровням, открывать страницы объектов и находить нужное.
Руководство архитектораКак строить схему, наполнять её из кода и держать документацию живой.
Руководство администратораУстановка, обновление, учётные записи и резервные копии.