Документировать систему с помощью ИИ-агента
Бета-версия
Документирование с помощью ИИ-агента пока работает в режиме бета-версии. Перед применением проверьте, что предлагает агент, а после применения при необходимости поправьте результат вручную.
Примечание
ИИ-агент описывает систему по её коду. ArchMap выдаёт агенту промпт с правилами оформления, агент читает репозиторий и готовит документацию, а ArchMap перед записью проверяет её и показывает, что изменится в проекте. Удалить из проекта агент ничего не может.
Примечание
Работать с агентом можно двумя способами. В окнах ArchMap вы копируете промпт, запускаете агента в папке репозитория и загружаете в окно файлы, которые он подготовил. Через MCP-сервер агент сам берёт промпт у ArchMap, показывает план изменений и после вашего подтверждения записывает их в проект (см. Подключить своего агента через MCP-сервер). Правила оформления у обоих способов одни и те же.
Примечание
Промпт из окна ArchMap рассчитан на агента, который умеет запускать субагентов: один субагент пишет документацию, второй проверяет её по коду. Если агент субагентов не поддерживает, он остановится и сообщит об этом.
Описать систему по порядку#
Чтобы описать систему с помощью агента, выполните следующие действия:
- Постройте схему системы по коду (см. Импортировать схему, собранную агентом из кода). Если система живёт в нескольких репозиториях, объедините их в один проект (см. Объединить файлы из нескольких репозиториев в один проект).
- Опишите структуру баз данных (см. Описать структуру базы данных).
- Опишите каналы брокеров сообщений (см. Описать каналы брокера).
- Опишите параметры конфигурации сервисов (см. Описать конфигурацию сервиса).
- Если в сервисе много операций, составьте их список (см. Составить список операций).
- Опишите логику операций и воркеров (см. Описать логику с помощью ИИ-агента).
- Добавьте спецификации OpenAPI сервисов (см. Получить спецификацию от агента).
- Привяжите шаги бизнес-процессов к схемам логики (см. Настроить шаг).
- Разберите рекомендации к схеме (см. Разобрать рекомендации к схеме).
Примечание
Схемы логики описываются после таблиц, каналов и параметров, потому что ссылаются на них пометками «читает», «пишет», «публикует», «потребляет» и «зависит от». Промпт схем логики передаёт агенту имена уже описанных таблиц, каналов и параметров, и агент ставит пометки с этими именами. Если описать логику раньше, часть пометок может не совпасть с именами, и такие пометки появятся в Рекомендациях.
Примечание
Список операций нужен крупным сервисам. ArchMap создаёт по пустой схеме на каждую операцию из списка, и потом их можно описывать по одной. Небольшой сервис агент опишет и без списка, одним пакетом.
Примечание
Когда код изменится, шаги можно повторить. Схему обновляет окно Обновить из репозитория (см. Обновить схему после изменений в коде), а таблицы, каналы, параметры и схемы логики агент дополнит в тех же окнах, что и в первый раз.