← Все статьи

Какие UML-диаграммы реально нужны системному аналитику

· 7 мин чтения

Из четырнадцати диаграмм UML в работе системного аналитика регулярно встречаются пять-шесть. Разбираем, какие именно, для каких задач каждая, что на ней показывать и чего избегать, а какие диаграммы можно смело оставить архитекторам и разработчикам.

Спецификация UML 2.5 описывает четырнадцать типов диаграмм. Учебники разбирают их все, вакансии требуют «знания UML», а на практике системный аналитик регулярно рисует пять-шесть из них, а некоторые не встречает годами. Это не недостаток квалификации: UML создавался как универсальный язык для всего цикла разработки, и большая его часть нужна архитекторам и разработчикам. Разберём, какие диаграммы действительно работают в аналитике, для чего каждая и как сделать так, чтобы её читали, а не пролистывали.

Карта UML

Диаграммы UML делятся на две группы:

  • Структурные — что есть в системе: классов, объектов, компонентов, развёртывания, пакетов, составной структуры, профилей.
  • Поведенческие — что система делает: вариантов использования, деятельности, состояний, и подгруппа диаграмм взаимодействия — последовательности, коммуникации, обзора взаимодействия, временная.

Для аналитика ценность каждой определяется простым вопросом: помогает ли она договориться о требованиях или о решении быстрее, чем текст?

ДиаграммаНасколько нужна аналитикуТипичная задача
Последовательностипостоянноинтеграции, взаимодействие сервисов, сценарии API
Деятельностичастоалгоритмы, логика обработки, процессы внутри системы
Состоянийчастожизненный цикл заказа, заявки, документа
Вариантов использованияиногдаграницы системы, роли и их функции
Классовиногдаконцептуальная и логическая модель предметной области
Компонентов, развёртыванияредкопонимание архитектуры — чаще рисует архитектор
Объектов, пакетов, коммуникации, временная, обзора взаимодействия, составной структуры, профилейпочти никогдаспециальные задачи

Диаграмма последовательности

Самая востребованная диаграмма системного аналитика. Показывает, какие участники обмениваются какими сообщениями и в каком порядке. Участники — системы, сервисы, пользователь; сообщения — вызовы API, события, ответы.

Когда использовать:

  • описание интеграции: кто кого вызывает, что передаёт, что получает;
  • сценарий, проходящий через несколько сервисов;
  • обработка ошибок и альтернативные ветки (фрагменты alt, opt, loop);
  • асинхронное взаимодействие через брокер.
@startuml
actor Покупатель
participant "Веб-приложение" as web
participant "API заказов" as api
participant "Платёжный провайдер" as pay
queue "Kafka" as bus

Покупатель -> web : Нажимает «Оплатить»
web -> api : POST /orders/{id}/payments\nIdempotency-Key
api -> pay : Создать платёж
pay --> api : URL страницы оплаты
api --> web : 201, paymentUrl
web --> Покупатель : Переход на страницу оплаты
...
pay -> api : Webhook: платёж успешен
api -> bus : OrderPaid
alt повторный webhook
  api --> pay : 200 (уже обработан)
end
@enduml

Советы:

  • подписывайте сообщения конкретно: метод и путь, имя события, а не «запрос данных»;
  • различайте синхронные вызовы (сплошная стрелка), ответы (пунктир) и асинхронные сообщения;
  • не пытайтесь уместить все ветки на одну диаграмму — успешный сценарий и обработку ошибок часто лучше разделить;
  • больше 8–10 участников — признак того, что диаграмму пора делить.

Диаграмма деятельности

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

Когда использовать:

  • алгоритм обработки: расчёт скидки, проверка заявки, маршрутизация обращения;
  • логика экранной формы или пакетной обработки;
  • процесс внутри системы, когда BPMN избыточен.

Советы: каждое условие ветвления должно иметь взаимоисключающие подписи на выходах ([сумма > 10 000] / [иначе]); у диаграммы должны быть явные начало и конец; дорожки используйте, когда важно, кто выполняет шаг.

Когда процесс бизнесовый, с участием людей и нескольких организаций, лучше подходит BPMN — о выборе между ними будет отдельная статья.

Диаграмма состояний

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

Когда использовать: всегда, когда у сущности есть статус. Заказ, заявка, договор, платёж, обращение в поддержку, документ на согласовании.

@startuml
[*] --> Новый
Новый --> ОжидаетОплаты : оформлен
ОжидаетОплаты --> Оплачен : платёж успешен
ОжидаетОплаты --> Отменён : таймаут 30 мин / отмена клиентом
Оплачен --> Собирается : передан на склад
Собирается --> Отгружен : собран
Оплачен --> Отменён : отмена [до сборки] / возврат денег
Отгружен --> Доставлен : подтверждение доставки
Доставлен --> [*]
Отменён --> [*]
@enduml

Почему эта диаграмма так ценна: она явно показывает, какие переходы запрещены. Из «Отгружен» нельзя вернуться в «Новый», отменить можно только до сборки. Без диаграммы эти правила рассыпаны по тексту требований и коду, и рано или поздно кто-то добавляет кнопку, которая переводит заказ в невозможное состояние.

Диаграмма состояний — также основа для тестирования: каждый переход и каждый запрещённый переход — тест-кейс.

Диаграмма вариантов использования

Показывает действующих лиц (актёров), функции системы (варианты использования) и границу системы.

Когда использовать:

  • в начале проекта — договориться о границах системы и составе функций;
  • для обзора ролей и прав доступа;
  • как оглавление к подробным текстовым сценариям.

Важно понимать: сама диаграмма содержит мало информации. Ценность варианта использования — в его текстовом описании: предусловия, основной сценарий, альтернативные сценарии, постусловия. Диаграмма без описаний — красивая картинка с овалами.

Чего избегать: декомпозиции функций до уровня «нажать кнопку», запутанных связей include и extend, которые читатели понимают по-разному.

Диаграмма классов

У разработчиков — модель кода. У аналитика — модель предметной области: понятия, их атрибуты и связи с кратностью.

Когда использовать:

  • концептуальная модель — сущности и связи без технических деталей;
  • логическая модель данных, если в команде принят UML, а не ER-нотация;
  • структура сложных сообщений и документов.

Советы: не добавляйте методы — аналитику они почти никогда не нужны; показывайте кратность на обоих концах связи (1, 0..1, *, 1..*); используйте композицию (закрашенный ромб), когда часть не существует без целого (позиция заказа без заказа).

Для моделей данных, близких к базе, многие команды предпочитают ER-диаграммы — они привычнее разработчикам и DBA.

Диаграммы, которые аналитику нужны реже

  • Компонентов и развёртывания — описывают архитектуру и инфраструктуру. Аналитику важно уметь их читать, но рисует их обычно архитектор. Для обзора архитектуры многие команды используют модель C4 вместо этих диаграмм.
  • Коммуникации — те же взаимодействия, что на диаграмме последовательности, но с акцентом на связи между участниками. На практике последовательность читается легче.
  • Временная — изменение состояний во времени с точными интервалами. Нужна во встроенных системах и телеметрии, в бизнес-системах почти не встречается.
  • Обзора взаимодействия — диаграмма деятельности, где узлы — диаграммы взаимодействия. Громоздка; обычно её заменяет набор ссылок в документе.
  • Объектов — снимок конкретных экземпляров. Иногда полезна, чтобы показать пример данных к диаграмме классов, но таблица или JSON-пример часто нагляднее.
  • Пакетов, составной структуры, профилей — инструменты архитекторов и разработчиков.

Как выбирать диаграмму

Нужно показатьДиаграмма
кто с кем обменивается сообщениями и в каком порядкепоследовательности
шаги, условия и ветвления алгоритмадеятельности
статусы объекта и переходы между нимисостояний
кто что делает в системе, где её границавариантов использования
понятия предметной области и их связиклассов
из чего состоит система и как связаны её частиC4 (контейнеры) или компонентов
бизнес-процесс с людьми и организациямиBPMN, а не UML

Правила, которые делают диаграммы полезными

  • Одна диаграмма — одна мысль. Если её нельзя описать одним предложением, она перегружена.
  • Строгость там, где она помогает. Не обязательно соблюдать каждую деталь спецификации UML, но элементы, которые вы используете, должны означать одно и то же во всех ваших диаграммах.
  • Текст и диаграмма дополняют друг друга. Диаграмма даёт обзор, текст — детали и правила. Не дублируйте одно другим.
  • Диаграммы как код. PlantUML или Mermaid позволяют хранить диаграммы в репозитории, видеть изменения и обновлять их так же легко, как текст.
  • Актуальность важнее полноты. Три актуальные диаграммы полезнее двадцати устаревших.

Итог

Системному аналитику не нужно владеть всеми четырнадцатью диаграммами UML одинаково. Рабочий набор — последовательности для интеграций, деятельности для алгоритмов, состояний для жизненных циклов, вариантов использования для границ системы и классов для модели предметной области. Их достаточно, чтобы закрыть большинство задач, а остальные диаграммы достаточно уметь читать.

Все эти диаграммы можно писать текстом в редакторе PlantUML. Пошаговые инструкции — в гайдах по диаграмме последовательности, диаграмме активности, диаграмме вариантов использования и диаграмме классов. Для обзора архитектуры вместо диаграмм компонентов — статья «Модель C4».