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

Add Diagrams as Code

Browse Source
This commit is contained in:
Brian Hoffmann
2021-04-27 11:30:46 +02:00
committed by GitHub
parent 7e43208057
commit 09a339440a
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 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](/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.