I have been looking for a decent template to document CQRS ES.
I think I have found one: https://github.com/tmorin/plantuml-libs
The following diagram:
This was generated using plantuml from the following source:
@startuml
' configures the library
' loads the library's bootstrap
!include https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution/bootstrap.puml
!include https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution/eventstorming/bootstrap.puml
' loads the package bootstrap
' include elements
include('eventstorming/Element/FacadeCommand')
include('eventstorming/Element/Command')
include('eventstorming/Element/Result')
include('eventstorming/Element/Event')
include('eventstorming/Element/DomainEvent')
include('eventstorming/Element/IntegrationEvent')
include('eventstorming/Element/Query')
include('eventstorming/Element/ReadModel')
include('eventstorming/Element/UserInterface')
include('eventstorming/Element/Aggregate')
include('eventstorming/Element/Service')
include('eventstorming/Element/Policy')
include('eventstorming/Element/Saga')
include('eventstorming/Element/Process')
include('eventstorming/Element/Timer')
include('eventstorming/Element/Person')
include('eventstorming/Element/System')
include('eventstorming/Element/Comment')
' display elements
FacadeCommand('FacadeCommand')
Command('Command')
Result('Result')
Event('Event')
DomainEvent('DomainEvent')
IntegrationEvent('IntegrationEvent')
Query('Query')
ReadModel('ReadModel')
UserInterface('UserInterface')
Aggregate('Aggregate')
Service('Service')
Policy('Policy')
Saga('Saga')
Process('Process')
Timer('Timer')
Person('Person')
System('System')
Comment('Comment')
@enduml
The advantage of this is that it does not require a local copy of the project.
The downside is that it requires an internet connection, and is at risk of the project being moved.
I can see myself making use of this.
I have forked this project so that I can have a guaranteed stable location and use a single file.
This reduces the above to:
@startuml
!include https://raw.githubusercontent.com/chriseyre2000/plantuml-libs/master/distribution/eventstorming/eventstorming.puml
' display elements
FacadeCommand('FacadeCommand')
Command('Command')
Result('Result')
Event('Event')
DomainEvent('DomainEvent')
IntegrationEvent('IntegrationEvent')
Query('Query')
ReadModel('ReadModel')
UserInterface('UserInterface')
Aggregate('Aggregate')
Service('Service')
Policy('Policy')
Saga('Saga')
Process('Process')
Timer('Timer')
Person('Person')
System('System')
Comment('Comment')
@enduml
Developer Rants 