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

Импортировать схему, собранную агентом из кода

Бета-версия

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

Примечание

ArchMap может построить схему системы по её исходному коду. ArchMap выдаёт промпт, вы запускаете с ним своего ИИ-агента (например, Claude Code или Qwen Code) в репозитории системы, агент изучает код и возвращает файл YAML. По этому файлу ArchMap создаёт проект.

Скопировать промпт#

Чтобы скопировать промпт для агента, выполните следующие действия:

  1. На экране Проекты нажмите кнопку Новый проект. Откроется окно Новый проект.
  2. В окне Новый проект выберите способ ИИ-агент.
  3. Справа в поле Название введите название системы. Под этим именем агент опишет систему, и с ним же будет создан проект.
  4. В списке Язык описаний выберите, на каком языке агент напишет описания объектов и связей.
  5. Если нужно, в поле Подсказки агенту коротко опишите устройство репозитория (например, «монорепо, сервисы в services/*»).
  6. Нажмите кнопку Скопировать промпт. Надпись на кнопке сменится на Промпт скопирован ✓.

Примечание

Кнопка Скопировать промпт неактивна, пока не заполнено поле Название.

Примечание

Если браузер не дал скопировать текст, под кнопкой появится поле с промптом. Выделите текст в поле и скопируйте его вручную.

Запустить агента#

Чтобы получить YAML от агента, выполните следующие действия:

  1. Запустите ИИ-агента в папке репозитория системы.
  2. Вставьте промпт в агента и отправьте его. Агент изучит репозиторий и выведет схему в виде YAML.
  3. Сохраните ответ агента в файл с расширением .yaml или скопируйте его текст.

Примечание

Промпт рассчитан на агента, который умеет запускать субагентов: один субагент строит схему, второй проверяет её по коду, и в ответ приходит уже проверенный файл. Если агент субагентов не поддерживает, он остановится и сообщит об этом.

Примечание

Если система живёт в нескольких репозиториях, запустите агента с тем же промптом в каждом из них. Получится по файлу YAML на репозиторий: ArchMap объединит их в один проект (см. Объединить файлы из нескольких репозиториев в один проект).

Примечание

Пока агент работает, окно Новый проект можно закрыть. Потом откройте его снова, выберите способ ИИ-агент и введите то же название.

Создать проект из YAML#

Чтобы создать проект из файла агента, выполните следующие действия:

  1. В окне Новый проект на способе ИИ-агент добавьте YAML в поле справа одним из способов:
    • перетащите файл в поле;
    • нажмите кнопку Загрузить файлы… и выберите файл;
    • вставьте текст YAML в поле.
  2. Дождитесь проверки. Под полем появится одна из строк:
    • Готово к импорту: файл разобран, проект можно создавать;
    • Не всё сошлось идеально: ниже есть вопросы или замечания, их можно разобрать перед созданием;
    • Что-то пошло не так: в файле ошибка, проект создать нельзя.
  3. Нажмите кнопку Создать проект. Вместо поля появится отчёт: сколько объектов и связей создано.
  4. Нажмите кнопку Открыть проект. Откроется страница нового проекта.

Примечание

Если проверка нашла ошибку, в строке Что-то пошло не так указан номер строки и что не так. Отправьте этот текст агенту в ту же сессию: он исправит файл и выведет его заново. Замените текст в поле исправленным.

Примечание

Вопросы под строкой статуса появляются, когда файлы расходятся между собой или объединение не может решить что-то само. Ни один вопрос не обязателен: без ответов проект создаётся так, как написано в сноске Если не отвечать, то … у каждого вопроса (см. Объединить файлы из нескольких репозиториев в один проект).

Проверить черновик#

Примечание

Схема от агента — черновик: агент мог пропустить связь или назвать объект не так, как принято в команде.

Чтобы проверить черновик, выполните следующие действия:

  1. Откройте страницу проекта и просмотрите схему по уровням (см. Перемещаться по уровням схемы).
  2. В шапке страницы нажмите кнопку Рекомендации (лампочка). Откроется панель с подсказками, что ещё можно дополнить в схеме: объекты без связей, связи к контейнеру вместо компонента и другие (см. Разобрать рекомендации к схеме).
  3. Поправьте схему в редакторе (см. Добавить объекты и контейнеры, Добавить связи между объектами).

Примечание

Когда код изменится, схему можно обновить тем же способом, не теряя ручных правок (см. Обновить схему после изменений в коде).

Примечание

С построения схемы работа только начинается: схемы логики, структуру баз данных, каналы брокеров и параметры конфигурации агент добавит отдельными промптами (см. Документировать систему с помощью ИИ-агента).