Разобрать рекомендации к схеме

Примечание

ArchMap сам проверяет проект и подсказывает, что ещё можно дополнить: объекты без связей, связи к контейнеру вместо компонента, пометки в схемах логики без описанных фактов, шаги процессов без документации и другое. Рекомендации видят архитекторы с правом редактировать проект.

Открыть рекомендации#

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

Откройте страницу проекта или редактор.
Нажмите кнопку Рекомендации (лампочка):
- на странице проекта она в шапке, справа;
- в редакторе она в правом верхнем углу холста.
Откроется панель Рекомендации с разделами по видам рекомендаций.
В панели нажмите на пункт. ArchMap покажет, к чему относится рекомендация:
- объект откроется на своей странице (в редакторе выделится на схеме);
- связь или группа объектов выделится в редакторе;
- бизнес-процесс откроется в режиме Процессы.
Исправьте то, о чём говорит рекомендация (см. Что означают рекомендации). Пункт пропадёт из панели.

Примечание

Точка в углу кнопки Рекомендации означает, что рекомендации есть. Если их нет, панель покажет Рекомендаций нет. Схема описана полностью.

Примечание

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

Что означают рекомендации#

Схема#

Рекомендация	Что означает	Как исправить
Объекты без связей	Объект не участвует ни в одной связи.	Добавьте связи (см. Добавить связи между объектами) или удалите объект, если он лишний.
Связи в контейнер	Связь ведёт к контейнеру целиком, а не к его компоненту.	Перевесьте конец связи на компонент (см. Изменить или удалить связь).
Связи в собственный компонент	Связь соединяет объект с его же компонентом, хотя вложенность и так видна по дереву.	Удалите связь или перевесьте её на другой объект.
Изолированные группы	Схема распалась на несколько групп объектов, не связанных между собой. Обычно это значит, что между группами не хватает связи.	Добавьте недостающую связь (см. Добавить связи между объектами).
Пользователи внутри контейнера	Объект типа Пользователь вложен в сервис, хотя пользователи находятся вне системы.	Вынесите его на корневой уровень (см. Перенести объект в другой контейнер).

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

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

Бизнес-процессы#

Рекомендация	Что означает	Как исправить
Незадокументированные сообщения	Связь, по которой шёл шаг процесса, удалили из схемы.	В процессе нажмите Восстановить связи на панели над диаграммой или удалите шаг.
Ответ на асинхронном канале	Шаг-ответ идёт по асинхронной связи, а у такой связи ответа не бывает.	На панели Шаг сценария в поле Тип канала выберите Синхронный или удалите шаг.
Незадокументированные участники	Участник процесса не сопоставлен ни с одним объектом схемы.	На шапке участника нажмите привязать и выберите объект.
Шаги без схемы логики	К шагу процесса не привязана схема логики.	Привяжите её на панели Шаг сценария (см. Настроить шаг).