Files
TechradarDev/radar/2021-01-01/diagrams-as-code.md
2021-04-27 11:30:46 +02:00

862 B

title, ring, quadrant
title ring quadrant
Diagrams as Code adopt methods-and-patterns

Documenting concepts and software architecture as diagrams using code offers great benefit over heavier solutions. Having documentation and diagrams treated as code and checked-in into version control increases transparency, collaboration as well as productivity. The textual representation of digrams is easy to write and read. Generation of graphical representations as SVG or PNG images is also easy with associated tools.

We make heavy use of PlantUML combined with Asciidoc and tools like AsciiDoctor Diagram to include and inline PlantUML diagrams into documentations. The latter allows a variety of other diagram formats which can be easily mixed and matched.