Лучшие практики в sequence-диаграммах для системных аналитиков

Конспект статьи. Автор оригинала: Михаил Пискунов

Системный архитектор переносит идеи Clean Code на sequence-диаграммы. Примеры — в PlantUML.

Принципы

• Понятные имена участников: Order Service, Payment Provider.
• Одна стрелка — одно осмысленное действие.
• Повторяющиеся фрагменты выносить в отдельную диаграмму и ссылаться через ref.
• Показывать только участников сценария, сложное делить.
• Конструкции по назначению: alt — варианты, opt — необязательный шаг, loop — повтор, par — параллельно.
• Комментарии — только там, где имена не справляются.

Ошибки через break, а не через вложенные alt

Вложенные alt для ошибок похожи на «лесенку» условий в коде. Лучше break — аналог раннего выхода: при ошибке сценарий прерывается, а основной путь остаётся плоским. Alt и opt — для штатных бизнес-альтернатив.

Циклы и большие объёмы

Чтение всех записей одним запросом может закончиться нехваткой памяти (в примере автора — на шести миллионах записей). Правильно — порционная обработка: внешний loop получает порции, внутренний обрабатывает элементы.

Поддержка

Хранить диаграммы текстом рядом с кодом и обновлять вместе с логикой. Применять док-ревью, единый стиль, KISS и DRY. Цветом группировать БД и внешние системы.