Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    View page history    Add new chapter    Reorder page    Raw


Диаграмма прецедентов

Use Case Diagram

Здесь можно ознакомиться с полезными дополнениями, которые можно использовать в любой из поддерживаемых диаграмм:

Рассмотрим несколько примеров:

Заметьте, что Вы можете отключить тени, используя команду skinparam shadowing false.

Let's have a few examples:

Прецеденты

Usecases

Прецеденты заключаются в две скобки (потому что две скобки выглядят как овал).

Вы можете использовать usecase для создания прецедента.

Также, Вы можете создать псевдоним, используя ключевое слово as. Этот псевдоним позже можно будет использовать для определения связей между элементами.

@startuml

(Один прецедент)
(Другой прецедент) as (UC2)
usecase Прецедент3
usecase (Последний\nпрецедент) as UC4

@enduml

Use cases are enclosed using between parentheses (because two parentheses looks like an oval).

You can also use the usecase keyword to define a usecase. And you can define an alias, using the as keyword. This alias will be used later, when defining relations.

@startuml

(First usecase)
(Another usecase) as (UC2)
usecase UC3
usecase (Last\nusecase) as UC4

@enduml

Акторы (Роли, Участники)

Actors

Примечание переводчика: я не нашел одного устоявшегося варианта перевода для этого термина. Встречаются варианты: Актор, Роль или Участник. Далее по тексту буду использовать слово Актор.

Определить актора можно просто указав его название между двумя вертикальными двоеточиями.

Другой вариант определения актора - это использование ключевого слова actor.

Также, при определении актора можно указать для него короткий псевдоним, который затем можно будет использовать при определении связей между элементами. Это делается при помощи ключевого слова as.

Пример ниже показывает разные варианты определения акторов.

@startuml

:Первый Actor:
:Второй\nactor: as Участник2
actor Участник3
actor :Последний actor: as Участник4

@enduml

The name defining an actor is enclosed between colons.

You can also use the actor keyword to define an actor. An alias can be assigned using the as keyword and can be used later instead of the actor's name, e. g. when defining relations.

You can see from the following examples, that the actor definitions are optional.

@startuml

:First Actor:
:Another\nactor: as Man2
actor Woman3
actor :Last actor: as Person1

@enduml

Изменение стиля отображения актора

Change Actor style

Вы можете изменить стиль стиль отображения актора. Доступны следующие варианты:
  • Человечек из палочек (по умолчанию);
  • В виде бюста, команда skinparam actorStyle awesome;
  • Контур человечка, команда skinparam actorStyle hollow .

Человечек из палочек (по умолчанию)

@startuml
:Пользователь: --> (Use)
"Главный админ" as Admin
"Использование приложения" as (Use)
Admin --> (Управление приложением)
@enduml

В виде бюста

@startuml
skinparam actorStyle awesome
:Пользователь: --> (Use)
"Главный админ" as Admin
"Использование приложения" as (Use)
Admin --> (Управление приложением)
@enduml

[Ссылка на QA-10493]

Контур человечка

@startuml
skinparam actorStyle Hollow 
:Пользователь: --> (Use)
"Главный админ" as Admin
"Использование приложения" as (Use)
Admin --> (Управление приложением)
@enduml

[ссылка на PR#396]

You can change the actor style from stick man (by default) to:
  • an awesome man with the skinparam actorStyle awesome command;
  • a hollow man with the skinparam actorStyle hollow command.

Stick man (by default)

@startuml
:User: --> (Use)
"Main Admin" as Admin
"Use the application" as (Use)
Admin --> (Admin the application)
@enduml

Awesome man

@startuml
skinparam actorStyle awesome
:User: --> (Use)
"Main Admin" as Admin
"Use the application" as (Use)
Admin --> (Admin the application)
@enduml

[Ref. QA-10493]

Hollow man

@startuml
skinparam actorStyle Hollow 
:User: --> (Use)
"Main Admin" as Admin
"Use the application" as (Use)
Admin --> (Admin the application)
@enduml

[Ref. PR#396]

Описание прецедентов

Usecases description

Если Вам нужно расположить описание в несколько строк, Вы можете использовать кавычки.

Также Вы можете использовать следующие разделители: --, .., == и __. Внутрь этих разделителей можно вставлять заголовки.

@startuml

usecase UC1 as "Вы можете использовать
несколько строчек для описания вашего прецедента.
Также, Вы можете использовать разделители:
--
Можно использовть несколько разных разделителей одновременно.
==
И еще Вы можете добавлять в разделители заголовки:
..ЗАКЛЮЧЕНИЕ..
Это позволяет делать очень большие и
развернутые описания."

@enduml

If you want to have a description spanning several lines, you can use quotes.

You can also use the following separators:
  • -- (dashes)
  • .. (periods)
  • == (equals)
  • __ (underscores)

By using them pairwise and enclosing text between them, you can created separators with titles.

@startuml

usecase UC1 as "You can use
several lines to define your usecase.
You can also use separators.
--
Several separators are possible.
==
And you can add titles:
..Conclusion..
This allows large description."

@enduml

Использование пакетов

Use package

Чтобы сгруппировать акторов или прецеденты, можно использовать пакеты.

@startuml
actor Гость as g
package Специалисты {
  actor "Шеф повар" as c
  actor "Ресторанный критик" as fc
}
package Ресторан {
  usecase "Есть" as UC1
  usecase "Платить" as UC2
  usecase "Пить" as UC3
  usecase "Составлять отзыв" as UC4
}
fc --> UC1
fc --> UC2
fc --> UC3
fc --> UC4
g --> UC1
g --> UC2
g --> UC3
@enduml

Для изменения венешнего вида пакета можно воспользоваться ключевым словом rectangle используя ег овместо ключевого слова package.

@startuml
left to right direction
actor "Ресторанный критик" as fc
rectangle Ресторан {
  usecase "Есть" as UC1
  usecase "Платить" as UC2
  usecase "Пить" as UC3
  usecase "Составлять отзыв" as UC4
}
fc --> UC1
fc --> UC2
fc --> UC3
fc --> UC4
@enduml

You can use packages to group actors or use cases.

@startuml
left to right direction
actor Guest as g
package Professional {
  actor Chef as c
  actor "Food Critic" as fc
}
package Restaurant {
  usecase "Eat Food" as UC1
  usecase "Pay for Food" as UC2
  usecase "Drink" as UC3
  usecase "Review" as UC4
}
fc --> UC4
g --> UC1
g --> UC2
g --> UC3
@enduml

You can use rectangle to change the display of the package.

@startuml
left to right direction
actor "Food Critic" as fc
rectangle Restaurant {
  usecase "Eat Food" as UC1
  usecase "Pay for Food" as UC2
  usecase "Drink" as UC3
}
fc --> UC1
fc --> UC2
fc --> UC3
@enduml

Простой пример

Basic example

Для создания связей между акторами и прецедентами используется стрелка -->.

Чем больше знаков тире - в стрелке, тем она длиннее. Вы можете добавить заметку на стрелку используя символ : после определения стрелки.

В этом примере можно заметить, что Пользователь не определён заранее и по умолчанию определяется как актор.

@startuml

Пользователь -> (Старт)
Пользователь --> (Использование приложения) : Небольшая заметка

:Главный админ: ---> (Использование приложения) : Еще одна\nнебольшая\nзаметка

@enduml

To link actors and use cases, the arrow --> is used.

The more dashes - in the arrow, the longer the arrow. You can add a label on the arrow, by adding a : character in the arrow definition.

In this example, you see that User has not been defined before, and is used as an actor.

@startuml

User -> (Start)
User --> (Use the application) : A small label

:Main Admin: ---> (Use the application) : This is\nyet another\nlabel

@enduml

Обобщение (наследование)

Extension

Если актор или прецедент являются обобщением других актора или прецедента, Вы можете использовать символ <|--.

@startuml
:Галавный админ: as Admin
(Работа с приложением) as (Use)

Пользователь <|-- Admin
(Работа) <|-- (Use)

@enduml

If one actor/use case extends another one, you can use the symbol <|--.

@startuml
:Main Admin: as Admin
(Use the application) as (Use)

User <|-- Admin
(Start) <|-- (Use)

@enduml

Использование заметок

Using notes

Вы можете использовать ключевые слова note left of , note right of , note top of , note bottom of чтобы создать и расположить заметку относительно какого-либо элемента.

Заметка так же может быть создана с помощью ключевого слова note, а затем прикреплена к какому-либо элементу при помощи символа ...

@startuml
:Главный админ: as Admin
(Работа с приложением) as (Use)

Пользователь -> (Работа)
Пользователь --> (Use)

Admin ---> (Use)

note right of Admin : Это пример заметки.

note right of (Use)
  Заметки могут занимать
  несколько строчек
end note

note "Эта заметка будет указывать\nсразу на несколько элементов." as N2
(Работа) .. N2
N2 .. (Use)
@enduml

You can use the note left of , note right of , note top of , note bottom of keywords to define notes related to a single object.

A note can be also define alone with the note keywords, then linked to other objects using the .. symbol.

@startuml
:Main Admin: as Admin
(Use the application) as (Use)

User -> (Start)
User --> (Use)

Admin ---> (Use)

note right of Admin : This is an example.

note right of (Use)
  A note can also
  be on several lines
end note

note "This note is connected\nto several objects." as N2
(Start) .. N2
N2 .. (Use)
@enduml

Шаблоны

Stereotypes

Вы можете добавить названия шаблонов когда определяете акторов или прецеденты используя символы << и >>.

@startuml
Пользователь << Человек >>
:Основная база данных: as MySql << Приложение >>
(Start) << One Shot >>
(Работа с приложением) as (Use) << Основное действие >>

Пользователь -> (Start)
Пользователь --> (Use)

MySql --> (Use)

@enduml

You can add stereotypes while defining actors and use cases using << and >>.

@startuml
User << Human >>
:Main Database: as MySql << Application >>
(Start) << One Shot >>
(Use the application) as (Use) << Main >>

User -> (Start)
User --> (Use)

MySql --> (Use)

@enduml

Смена направления стрелок

Changing arrows direction

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

@startuml
:Пользователь: --> (Прецедент 1)
:Пользователь: -> (Прецедент 2)
@enduml

Также можно изменить направление связи, переместив символ окончания стрелки на другую сторону:

@startuml
(Прецедент 1) <.. :Пользователь:
(Прецедент 2) <. :Пользователь:
@enduml

Можно управлять направлением связи добавляя ключевые слова left, right, up или down внутрь стрелки:

@startuml
:Пользователь: -left-> (Лево)
:Пользователь: -right-> (Право)
:Пользователь: -up-> (Верх)
:Пользователь: -down-> (Низ)
@enduml

Можно использовать более короткий синтаксис используя только первый символ указанных выше ключевых слов, например -d- или -do- вместо полного слова -down-.

Правда злоупотреблять такой короткой записью не стоит, так как GraphViz обычно дает более хороший результат, когда такая короткая запись НЕ используется.

И наконец, можно поменять все направления местами используя ключевое слово left to right direction. Для этого можно сравнить предыдущую диаграмму с диаграммой, представленной ниже:

@startuml
left to right direction
:Пользователь: -left-> (Лево)
:Пользователь: -right-> (Право)
:Пользователь: -up-> (Верх)
:Пользователь: -down-> (Низ)
@enduml

By default, links between classes have two dashes -- and are vertically oriented. It is possible to use horizontal link by putting a single dash (or dot) like this:

@startuml
:user: --> (Use case 1)
:user: -> (Use case 2)
@enduml

You can also change directions by reversing the link:

@startuml
(Use case 1) <.. :user:
(Use case 2) <- :user:
@enduml

It is also possible to change arrow direction by adding left, right, up or down keywords inside the arrow:

@startuml
:user: -left-> (dummyLeft)
:user: -right-> (dummyRight)
:user: -up-> (dummyUp)
:user: -down-> (dummyDown)
@enduml

You can shorten the arrow by using only the first character of the direction (for example, -d- instead of -down-) or the two first characters (-do-).

Please note that you should not abuse this functionality : Graphviz gives usually good results without tweaking.

And with the left to right direction parameter:

@startuml
left to right direction
:user: -left-> (dummyLeft)
:user: -right-> (dummyRight)
:user: -up-> (dummyUp)
:user: -down-> (dummyDown)
@enduml

Разделение диаграмм

Splitting diagrams

Ключевое слово newpage используется для разделения диаграмм на несколько страниц или изображений.

@startuml
:Актор1: --> (Прецедент1)
newpage
:Актор2: --> (Прецедент2)
@enduml

The newpage keywords to split your diagram into several pages or images.

@startuml
:actor1: --> (Usecase1)
newpage
:actor2: --> (Usecase2)
@enduml

Направление слева направо

Left to right direction

Общее поведение по умолчанию - построение диаграмм сверху вниз.

@startuml
'default
top to bottom direction
Актор1--> (Прецедент 1)
Актор2--> (Прецедент 2)
@enduml

Вы можете изменить направление на слева направо используя команду left to right direction. Часто результат с таким направлением выглядит лучше.

@startuml

left to right direction
Актор1--> (Прецедент 1)
Актор2--> (Прецедент 2)

@enduml

The general default behavior when building diagram is top to bottom.

@startuml
'default
top to bottom direction
user1 --> (Usecase 1)
user2 --> (Usecase 2)

@enduml

You may change to left to right using the left to right direction command. The result is often better with this direction.

@startuml

left to right direction
user1 --> (Usecase 1)
user2 --> (Usecase 2)

@enduml

Параметры отображения

Skinparam

Вы можете использовать команду skinparam для изменения шрифтов и цветов диаграммы.

Вы можете использовать данную команду :

Вы можете задать цвет или шрифт для шаблонов, в которые объединены акторы или прецеденты.

@startuml
skinparam handwritten true

skinparam usecase {
BackgroundColor DarkSeaGreen
BorderColor DarkSlateGray

BackgroundColor<< Работа >> YellowGreen
BorderColor<< Работа >> YellowGreen

ArrowColor Olive
ActorBorderColor black
ActorFontName Courier

ActorBackgroundColor<< Человек >> Gold
}

Пользователь << Человек >>
:Основная база данных: as MySql << Приложение >>
(Start) << One Shot >>
(Работа с приложением) as (Use) << Работа >>

Пользователь -> (Start)
Пользователь --> (Use)

MySql --> (Use)

@enduml

You can use the skinparam command to change colors and fonts for the drawing.

You can use this command :

You can define specific color and fonts for stereotyped actors and usecases.

@startuml
skinparam handwritten true

skinparam usecase {
BackgroundColor DarkSeaGreen
BorderColor DarkSlateGray

BackgroundColor<< Main >> YellowGreen
BorderColor<< Main >> YellowGreen

ArrowColor Olive
ActorBorderColor black
ActorFontName Courier

ActorBackgroundColor<< Human >> Gold
}

User << Human >>
:Main Database: as MySql << Application >>
(Start) << One Shot >>
(Use the application) as (Use) << Main >>

User -> (Start)
User --> (Use)

MySql --> (Use)

@enduml

Полноценный пример

Complete example

@startuml
left to right direction
skinparam packageStyle rectangle
actor Заказчик
actor Менеджер
rectangle Заказ {
  Заказчик -- (заказ)
  (заказ) .> (оплата) : включает
  (консультация) .> (заказ) : дополняет
  (заказ) -- Менеджер
}
@enduml

@startuml
left to right direction
skinparam packageStyle rectangle
actor customer
actor clerk
rectangle checkout {
  customer -- (checkout)
  (checkout) .> (payment) : include
  (help) .> (checkout) : extends
  (checkout) -- clerk
}
@enduml

Бизнес прецеденты и акторы

Business Use Case

Вы можете добавить символ / для того, чтобы создать Бизнес прецеденты или акторов.

Бизнес прецедент

@startuml

(Один прецедент)/
(Другой прецедент)/ as (UC2)
usecase/ Пр3
usecase/ (Последний\nпрецедент) as UC4

@enduml

Бизнес актор

@startuml

:Один Участник:/
:Другой\nучастник:/ as Man2
actor/ Участник
actor/ :Последний участник: as Person1

@enduml

[Ref. QA-12179]

You can add / to make Business Use Case.

Business Usecase

@startuml

(First usecase)/
(Another usecase)/ as (UC2)
usecase/ UC3
usecase/ (Last\nusecase) as UC4

@enduml

Business Actor

@startuml

:First Actor:/
:Another\nactor:/ as Man2
actor/ Woman3
actor/ :Last actor: as Person1

@enduml

[Ref. QA-12179]

Изменение цвета и стиля стрелок (встраиваемый синтаксис)

Change arrow color and style (inline style)

Вы можете изменить цвет или стиль индивидуально для каждой стрелочки используя следующий встраиваемый синтаксис:

#color;line.[bold|dashed|dotted];text:color

где:

  • # - начало режима конфигурирования,
  • color - цвет стрелки,
  • ; - разделитель между конфигурационными параметрами,
  • line.type - тип линии. type может принимать значения: bold - жирная, dashed - штриховая, dotted - пунктирная,
  • text:color - цвет текста заметки на линии.

@startuml
actor foo
foo --> (bar) : обычная
foo --> (bar1) #line:red;line.bold;text:red  : красная, жирный
foo --> (bar2) #green;line.dashed;text:green : зеленая, штриховой
foo --> (bar3) #blue;line.dotted;text:blue   : синяя, пунктирный
@enduml

[Ref. QA-3770 and QA-3816] [See similar feature on deployment-diagram or class diagram]

You can change the color or style of individual arrows using the inline following notation:

  • #color;line.[bold|dashed|dotted];text:color

@startuml
actor foo
foo --> (bar) : normal
foo --> (bar1) #line:red;line.bold;text:red  : red bold
foo --> (bar2) #green;line.dashed;text:green : green dashed 
foo --> (bar3) #blue;line.dotted;text:blue   : blue dotted
@enduml

[Ref. QA-3770 and QA-3816] [See similar feature on deployment-diagram or class diagram]

Изменение цвета и стиля элементов (встраиваемый синтаксис)

Change element color and style (inline style)

Вы можете изменить цвет или стиль индивидуально для каждого элемента используя следующий встраиваемый синтаксис:

#[color|back:color];line:color;line.[bold|dashed|dotted];text:color

где:

  • # - начало режима конфигурирования,
  • color или back:color - цвет фона элемента,
  • ; - разделитель между конфигурационными параметрами,
  • line.color - цвет контура элемента,
  • line.type - тип линии. type может принимать значения: bold - жирная, dashed - штрихоавя, dotted - пунктирная,
  • text:color - цвет текста элемента.

@startuml
actor a
actor b #pink;line:red;line.bold;text:red
usecase c #palegreen;line:green;line.dashed;text:green
usecase d #aliceblue;line:blue;line.dotted;text:blue
@enduml

[Ref. QA-5340 and adapted from QA-6852]

You can change the color or style of individual element using the following notation:
  • #[color|back:color];line:color;line.[bold|dashed|dotted];text:color

@startuml
actor a
actor b #pink;line:red;line.bold;text:red
usecase c #palegreen;line:green;line.dashed;text:green
usecase d #aliceblue;line:blue;line.dotted;text:blue
@enduml

[Ref. QA-5340 and adapted from QA-6852]


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.