From 09a339440a0ccb453a7539b8f979bf043ef6bc3b Mon Sep 17 00:00:00 2001 From: Brian Hoffmann Date: Tue, 27 Apr 2021 11:30:46 +0200 Subject: [PATCH] Add Diagrams as Code --- radar/2021-01-01/diagrams-as-code.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 radar/2021-01-01/diagrams-as-code.md diff --git a/radar/2021-01-01/diagrams-as-code.md b/radar/2021-01-01/diagrams-as-code.md new file mode 100644 index 0000000..1042e30 --- /dev/null +++ b/radar/2021-01-01/diagrams-as-code.md @@ -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.