Найти документацию сервиса

Примечание

Документация сервиса собрана на его странице: свойства, схема, связи, логика операций, API, факты из кода и участие в бизнес-процессах. В интерфейсе объект ищут по имени. Поиск по содержимому документации (по тексту схем логики, таблицам, каналам и параметрам) доступен только ИИ-агенту, подключённому к ArchMap по MCP (см. Задать вопрос о системе ИИ-агенту).

Найти сервис по имени#

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

Откройте проект.
В поле Поиск по имени… над деревом объектов введите часть имени. Под полем появится список объектов, в имени которых есть введённое.
В списке нажмите на нужный объект. Откроется его страница.

Поиск по имени в дереве — Поиск по имени: по запросу «заказ» найдены сервис, база данных и воркер

Примечание

Список находок не показывает, где объект лежит в дереве. Путь от корня проекта виден вверху страницы объекта.

Примечание

Если имя неизвестно, спуститесь к сервису по уровням от страницы проекта (см. Перемещаться по уровням схемы).

Найти нужный раздел на странице сервиса#

Чтобы найти нужную документацию на странице сервиса, прокрутите страницу до раздела, который отвечает на ваш вопрос:

с кем и как сервис обменивается данными: раздел Связи (см. Просмотреть связи сервиса);
как устроена операция или воркер: раздел Логика (см. Просмотреть логику операции или воркера);
какие операции есть у API сервиса: раздел OpenAPI (см. Просмотреть API сервиса);
какие параметры читает сервис: раздел Конфигурация (см. Просмотреть конфигурацию сервиса);
в каких бизнес-процессах участвует сервис: раздел Участвует в процессах (см. Просмотреть бизнес-процесс);
где лежит код сервиса: в разделе Свойства поле Источник (см. Найти репозиторий и путь к коду сервиса).

Примечание

Набор разделов зависит от типа объекта. У сервиса есть Логика, OpenAPI и Конфигурация; у базы данных вместо них раздел Структура с таблицами (см. Просмотреть структуру базы данных); у брокера сообщений раздел Каналы (см. Просмотреть каналы брокера); у пользователя только Свойства, Схема, Связи и Участвует в процессах. Разделы Логика, OpenAPI и Участвует в процессах скрываются, если в них ничего не описано; разделы фактов остаются с подписью «не описаны».

Примечание

У сервиса-контейнера разделы Логика и OpenAPI собирают документацию его компонентов, сгруппированную по компонентам.