-
check if you have jq, plantuml and asiidoctor installed
$ make check
-
install if needed
$ brew install plantuml jq $ gem install asciidoctor
-
create architecture documentation
$ make build-arc-42
We use PlantUML for simple diagrams. This allows us to put the plain text
diagram sources under the source control. PlantUML diagrams are put into the diagrams folder and
are named *.puml.
More complex diagrams (like the diagram in Deployment View) are created with https://draw.io, which is now completely free and even offers a desktop app. draw.io diagrams are saved as XML, also put in the images folder.