AJR/TechradarDev
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #17 from AOEpeople/radar-2021-01-01-diagramsascode

Browse Source 
Add Diagrams as Code
This commit is contained in:
Daniel Pötzinger
2021-05-27 14:53:57 +02:00
committed by GitHub
parent a04be03ea4 859c870e52
commit 10c2d04096
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
radar/2021-01-01/diagrams-as-code.md Normal file
View File

@@ -0,0 +1,13 @@
---
title: "Diagrams as Code"
ring: adopt
quadrant: 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 diagrams is easy to write and read. Generation of graphical representations as SVG or PNG images is also easy with the associated tools.
We make heavy use of [PlantUML](/tools/plant-uml.html) combined with [Asciidoc](/tools/asciidoc.html) and tools
like [AsciiDoctor Diagram](https://asciidoctor.org/docs/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.