Use PlantUML to describe and document a domain story which was developed in a Domain Storytelling workshop.
Table of Contents
At the top of your domain story .puml file,
you need to include the domainStory.puml file found in the root of this repository.
The library is now part of the PlantUML Standard Library and may be included via
!include <DomainStory/domainStory>If you want to use the always up-to-date version in this repository,
use the following include definition
!include https://raw.githubusercontent.com/johthor/DomainStory-PlantUML/main/domainStory.pumlTo be independent of any internet connectivity, you can also download the file found in the root and reference it locally with
!include path/to/domainStory.pumlAfter you have included domainStory.puml you can use the predefined macros
to describe domain stories using the following pictographic language.
These macros are used to create domain story actors:
Person($name[, $label][, $note][, $shape][, $scale][, $color][, $background])Group($name[, $label][, $note][, $shape][, $scale][, $color][, $background])System($name[, $label][, $note][, $shape][, $scale][, $color][, $background])
And these are used to create work objects:
Document($name[, $label][, $note][, $shape][, $scale][, $color][, $background])Folder($name[, $label][, $note][, $shape][, $scale][, $color][, $background])Call($name[, $label][, $note][, $shape][, $scale][, $color][, $background])Email($name[, $label][, $note][, $shape][, $scale][, $color][, $background])Conversation($name[, $label][, $note][, $shape][, $scale][, $color][, $background])Info($name[, $label][, $note][, $shape][, $scale][, $color][, $background])
Activities between actors and involving work items are described via the activity macro:
activity($step, $subject, $predicate, $object[, $post][, $target][, $objectArr][, $targetArr]
[, $note][, $shape][, $scale][, $color][, $background]
[, $targetNote][, $targetShape][, $targetScale][, $targetColor][, $targetBackground])In addition to these, it is also possible to define boundaries via
Boundary($name[, $label][, $note][, $shape][, $background]) {
' Boundary Contents
}Optional parameters are shown above in square brackets.
Show EBNF diagram that describes the macro syntax in more details.
Keyword parameters are displayed as dashed terminals below.
Now let's create our first domain story:
@startuml
!include https://raw.githubusercontent.com/johthor/DomainStory-PlantUML/main/domainStory.puml
Boundary(Party) {
Person(Alice)
Conversation(weather)
Person(Bob)
}
activity(1, Alice, talks about the, weather, with, Bob)
@endumlWill be rendered as:
More information can be found here:
Some concepts or constructs will be used throughout the library.
Almost all the parameters declared above are optional and may be omitted for a simplified story description. But all of them may be specified via named parameters so that some parameters are skipped. In general, the parameters at the beginning of the parameter list are to be used as positional parameters, while parameters at the end of the parameter list are more likely to be used as keyword parameters. Keyword parameters may even be skipped as they always have sensible default handling.
Every actor, work object and boundary accepts the parameters $name and $label
where only $name is mandatory while $label is optional.
If no label was given, the name will be reused as a label.
All elements may later be referenced by their names.
With that in mind Person(Bob, $scale=42) is a totally legal way of describing a giant person named and labeled Bob.
Some elements may be positioned in relation to another reference element via a positioning indicator. Here the following symbols are used on multiple occasions as prefixes.
- no indicator symbol: the new element will be positioned inline with the default flow direction
^caret symbol: the new element will be positioned above its reference>greater-than symbol: the new element will be positioned to the right of its referencevvee symbol: the new element will be positioned below its reference<less-than symbol: the new element will be positioned to the left of its reference~tilde symbol: the new element will be positioned against the default flow direction
The positioning indicator will take the normal story flow defined via $Story_Layout into account.
Some of the features that will be used right away.
The basic orientation of your story may be configured at the top of your file via
!$Story_Layout = "landscape | left-to-right | top-to-bottom | portrait"
For single story diagrams, a landscape orientation e.g. left-to-right is preferred
and is therefore the default orientation.
If you combine multiple stories into a domain journey,
a portrait orientation might produce better results.
ℹ️ Wrangling diagram elements to an exact position or layout is not what PlantUML is for.
If the default layout does not please your inner artist, there are some possibilities to improve it.
Group elements together via together { elements... }.
The activity macro provides another feature for better layout control.
Where the step value can be combined with a positioning indicator as a prefix
(^, >, v, <, ~).
The following activity will be directed to the left of Alice.
activity(<1, Alice, talks about the, weather, with, Bob)More details and a second activity direction feature will be discussed in Advanced Story Layout.
The activities will be numbered by default and may keep track of the current step number automatically. Therefore, when describing activities, the current step label supports multiple special value specifications to control the behavior.
| Step Value | Description | Auto Increment |
|---|---|---|
_ underscore |
sequential step | yes |
+ plus |
sequential step | yes |
| bar |
parallel step | no |
. full stop / period |
hidden step counter | no |
space or '' empty |
hidden step counter | no |
n any integer |
step label will be (n) |
no |
=n equal sign prefix |
step label will be (n)and step counter will be set to that integer auto-increment will continue from there |
no |
See the following test case for more details step labels and auto increment
activity(_, Bob, talks about the, weather1) /' auto-increment will create step 1 '/
activity(+, Bob, talks about the, weather2) /' auto-increment will create step 2 '/
activity(|, Alice, talks about the, weather2) /' no increment will create step 2 '/
' will not create step, nor auto-increment, and will not display the step label
activity(<., Bob, also talks about the, weather3)
activity(42, Alice, asks about all the, talking1, again, Bob) /' will create step 42 '/
activity(|, Bob, talks about the, weather4) /' no increment will still create step 2 '/
' will create step 10 and set the step counter to 10
activity(=10, Alice, talks about, talking2, Bob)
activity(<_, Bob, is embarrassed about, talking3) /' auto-increment will create step 11 '/
' will not create step, nor auto-increment, and will not display the step label
activity( , Alice, writes, mail, to, Bob)All elements support adding notes via the keyword argument $note.
Boundary(wonderland, $note=like Oxford) {
Person(Alice, $note=fizz)
Conversation(weather, $note=buzz)
Person(Hatter)
activity(1, Alice, talks about the, weather, with, Hatter, $note=sunny)
}When adding a note on an activity,
the note will be added to the object of that activity.
With $targetNote the note will be placed on the activity's target instead.
Furthermore, the first symbol of the note text may act as a positioning indicator
where ^, >, v, < or ~ controls the direction in which it is placed from its element of reference.
Otherwise, it will be placed in the default direction from its element.
Notes may also be placed via the basic PlantUML mechanism.
Boundary(wonderland) {
Person(Alice)
Document(bottle)
}
note bottom of Alice : main character
note top of bottle : drink me
note right of wonderland : visit meSee the following test cases for more details
- Notes on actors and work objects left-to-right orientation
- Notes on actors and work objects top-to-bottom orientation
- Notes on boundaries left-to-right orientation
- Notes on boundaries top-to-bottom orientation
The appearance of a domain story may be influenced via any of the following methods.
ℹ️ You may also mix and match all the approaches to get the look you desire.
The library is compatible with PlantUML themes like
sunlust (light) crt-amber (dark) or sketchy (mixed) and others.
Choose the theme before including the library.
@startuml
!theme sketchy
!include <DomainStory/domainStory>
' domain story description
@endumlThis will result in the following appearance.
If you want to use PlantUML's dark mode, please also specify the mode via the -D commandline option e.g.
plantuml -darkmode -DPUML_MODE=dark [options] [file/dir]Which will be rendered as below.
See the following test cases for more details.
If no theme is used, a fallback design is used which is heavily inspired by Egon.io. The appearance of most of the elements may be customized via the following global style declarations. These will still work if a theme is used. Make sure that your values are compatible with the chosen theme.
| Property | Default Value | Description |
|---|---|---|
$Element_FontColor |
#0b0c10 |
Color of all text |
$Element_TextAlignment |
center |
Alignment of most text |
$Element_BackgroundColor |
none |
Background color for most elements |
$Element_BorderStyle |
none |
Border style for most elements |
$Element_BorderColor |
none |
Border color for most elements |
$Element_BorderThickness |
1 |
Border style for most elements |
$Element_RoundCorner |
0 |
Roundness of element corners |
$Element_Shadowing |
false |
Should elements throw shadows |
| Actor Styling | ||
$Actor_Shape |
Agent |
Shape of actor elements |
$Actor_IconStyle |
outline |
Use outlines instead of filled icons for actors |
$Actor_IconScale |
1 |
Size of actor icons |
$Actor_IconColor |
#1f2833 |
Color of actors icons |
| Work Object Styling | ||
$Object_Shape |
Card |
Shape of work item elements |
$Object_IconStyle |
outline |
outlines instead of filled icons for work items |
$Object_IconColor |
#1f2833 |
Color of work item icons |
$Object_IconScale |
0.8 |
Size of work item icons |
| Boundary Styling | ||
$Boundary_Shape |
Rectangle |
Shape of boundary containers |
$Boundary_BorderStyle |
dashed |
Style of boundary borders |
$Boundary_BorderColor |
#1f2833 |
Color of boundary borders |
$Boundary_BorderThickness |
2 |
Thickness of boundary borders |
$Boundary_RoundedCorner |
15 |
Roundness of boundary corners |
| Note Styling | ||
$Note_TextAlignment |
left |
Alignment of note texts |
$Note_BackgroundColor |
#c5c6c7 |
Background color for notes |
$Note_BorderColor |
#1f2833 |
Border color for notes |
| Activity Styling | ||
$Activity_Shape |
Arrow |
The element used to style activities |
$Activity_MessageAlignment |
left |
Where the activity text should start |
$Activity_Color |
#c5c6c7 |
Color of the activity arrows |
$Step_LabelPosition |
combined |
Where the step number should be positioned. |
$Step_LabelFraming |
round |
Should the step number be put in round / square brackets or left bare. |
$Step_FontStyle |
plain |
Font style for step numbers |
$Step_FontSize |
16 |
Font size for step numbers |
$Step_BackgroundColor |
#66fcf1 |
Background color for step numbers |
To use your own styling, you need to define the relevant styling properties before including the library. The following example would combine green actor icons with red text.
@startuml
' !theme <theme name> /' optional '/
!$Element_FontColor = "red"
!$Actor_IconColor = "green"
!include <DomainStory/domainStory>
Person(Alice)
@endumlℹ️ You might want to set a matching
$Step_BackgroundColorand$Step_FontColorwhen using themes.
See the test case Global style declarations for more details.
By default, the library will use the following PlantUML shapes to represent actors, work objects, and boundaries.
- actors will use the shape
Agent - work objects will use the shape
Card - and boundaries will use the shape
Rectangle
But these shapes may be reconfigured via the global styling declarations $Actor_Shape,
$Object_Shape and $Boundary_Shape.
By default, icons from the PlantUML Standard Library - Google Material Icons will be used to represent actors and work objects. The shape and icons used by specific actors and work objects may also be reconfigured via the following properties.
| Property | Default Value | Description |
|---|---|---|
| Actor Styling | ||
$Person_Shape |
$Actor_Shape |
Shape used by actors of type person |
$Person_IconStyle |
outline |
Icon style used by actors of type person |
$Group_Shape |
$Actor_Shape |
Shape used by actors of type group |
$Group_IconStyle |
outline |
Icon style used by actors of type group |
$System_Shape |
$Actor_Shape |
Shape used by actors of type system |
| Work Object Styling | ||
$Document_Shape |
$Object_Shape |
Shape used by work objects of type document |
$Document_IconStyle |
outline |
Icon style used by work objects of type document |
$Folder_Shape |
$Object_Shape |
Shape used by work objects of type folder |
$Folder_IconStyle |
outline |
Icon style used by work objects of type folder |
$Call_Shape |
$Object_Shape |
Shape used by work objects of type call |
$Email_Shape |
$Object_Shape |
Shape used by work objects of type email |
$Email_IconStyle |
outline |
Icon style used by work objects of type email |
$Conversation_Shape |
$Object_Shape |
Shape used by work objects of type conversation |
$Conversation_IconStyle |
outline |
Icon style used by work objects of type conversation |
$Info_Shape |
$Object_Shape |
Shape used by work objects of type info |
$Info_IconStyle |
outline |
Icon style used by work objects of type info |
See the test case element style declarations for more details.
While most IconStyle properties only distinguish between filled icons and icons with outlines,
the $Person_IconStyle property supports also the following styles
stickman, stickmanAlt, hollow as well as awesome.
If the default actors and work objects are not enough to express your specific needs, see the extension sample for a way to add new actors and objects.
These features might come handy after you've used the library for quite some time.
Instead of predefining all work objects,
they can also be defined on the fly when they are used.
Prefix the work object with the kind of object you want to create
followed by a colon e.g. Conversation:.
Additionally, you can specify the shape, icon scale, icon color,
and background color of the created work object via the keyword arguments
$shape, $scale, $color and $background.
@startuml
!include https://raw.githubusercontent.com/johthor/DomainStory-PlantUML/main/domainStory.puml
Boundary(System) {
Person(Alice)
Person(Bob)
activity(1, Alice, talks about the, Conversation: weather, with, Bob, $color = red, $scale = 2)
}
@enduml
⚠️ If you want your dynamically created objects to be placed inside a boundary. You need to declare the activity inside said boundary.
See the test case for dynamic object creation for more details.
If the aforementioned lay-outing techniques described in Basic Story Layout are not enough,
the activity macro supports even more layout tricks.
In addition to the step counter specifications described above,
the step value may also specify the direction of the activity where X is one of the specifications above.
| Step Value | Description | Step Label |
|---|---|---|
>X greater-than sign prefix |
direction of activity will be to the right | depends on X |
<X less-than sign prefix |
direction of activity will be to the left | depends on X |
vX vee prefix |
direction of activity will be downwards | depends on X |
^X caret prefix |
direction of activity will be upwards | depends on X |
~X tilde prefix |
direction of activity will be against the default flow direction | depends on X |
See the test cases for more details
- activity directions for left-to-right layout
- activity directions for top-to-bottom layout
- activity directions for both layouts
Furthermore, the activity macro also provides two optional parameters,
which allow you to specify the arrow orientation in full details.
$objectArrwill define the arrow direction between the subject and the object- and
$targetArrwill define the arrow direction between the object and the target.
Some possible arrow specifications are -->, ->, <-, <--, and -up->.
For more details,
see The Hitchhiker's Guide to PlantUML.
activity(1, Alice, talks about the, weather, with, Bob, -->, ->)You can use underscores _ in cases where you don't have a post action,
or target but want to specify the arrow orientation directly.
When you specify only the arrow between subject and object,
the specification will also be used for the arrow between object and target.
So the following lines describe all more or less the same activity.
activity(1, Alice, talks about the, weather, , Bob, <--, <--)
activity(1, Alice, talks about the, weather, Bob, _, <--)
activity(1, Alice, talks about the, weather, _, _, <--)If all of that does not help your layout problems, there's always the possibility to introduce hidden connections only for layout purposes. Remember that every element of your story may be referenced by its name later.
Bob ---[hidden]-> AliceSee the test cases again for more details
- activity directions for left-to-right layout
- activity directions for top-to-bottom layout
- activity directions for both layouts
In addition to the styling methods described in Basic styling, there are more advanced methods.
In addition to the style declarations,
already mentioned in Method 2 and Method 3
every actor and work object declares its own style declarations as an extension of the already known declarations $Actor_XYZ or $Object_XYZ.
Therefore, the background of all "person actors" may be controlled via $Person_BackgroundColor
and the icon scale of all "document work object" may be changed via $Document_IconScale
The following diagram shows the hierarchy of style declarations.
See the test case element style declarations for more details.
Tag-based style declarations form another layer of styling on top of the element-specific style declarations and follow the same inheritance hierarchy but for tagged style declarations.
This level of styling is controlled via the $tag parameters on most elements.
To use tagged style customization, you first need to configure the new style declarations via
customizeStyleProperty($value, $property, $context, [$kind], [$tag], [$skinParam])$valueis the desired new value$propertyis the name of the style property to be customized$contextis one of (Element,Actor,Object,Note,Boundary,Activity,Step)$kindis the kind of actor or work object to be customized, it might also be""to style all$contextelements tagged with$tag$tagis the tag name you want to customize$skinParamisTRUEby default and controls if the property is a PlantUML skin paramter too
After that, the newly defined tag may be used to customize the appearance of matching elements via the $tag parameter.
Person(Alice, $tag="FairyTale")Show diagram that explains how the names of all supported style declarations are constructed.
See the test case tag style declarations for more details.
Every element allows some control over its individual appearance via the $shape,
$scale, $color and $background parameters.
The following example code shows a "Little Red Riding Hood."
Person(hood, Riding Hood, $color=red, $scale=0.5)The boundary macro accepts the parameters $shape and $background to control its appearance directly.
The activity macro also provides $shape, $scale, $color
and $background parameters to control the appearance of the newly
created $object work object.
While $targetShape, $targetScale, $targetColor,
and $targetBackground control the appearance of the newly created $target work
object.
See the test case individual style customization for more details.
Some example domain stories collected from different sources.
The following example is taken from the Domain Storytelling website.
Source: cinema.puml
The following example is taken from Collaborative Modelling -- Wie die Kommunikation mit den Fachexperten gelingt JavaSPEKTRUM 2/2020.
Source: airportBus.puml
This project is licensed under the MIT License
- see the LICENSE file for details
- C4-PlantUML an inspiration to implement a collection of domain story macros
- @dirx improved domain story macros a more refined implementation of the first version