tools.md

Tools

ADR

We use ADR Tools.

Installation instructions

Additionally, the following helper scripts can be found in ./bin

• ./bin/adr-amends A B

  Annotates A and B records that A amends B

• ./bin/adr-supersedes A B

  Annotates A and B records that A supersedes B

• ./bin/adr-generate-toc

  Generate table of contents for architectural decision records, complete with emoji to reflect status

Images

• ./bin/images-generate

  Generate images from any source mermaid (.mmd), graphviz (.dot) or PlantUML (.puml) files

  Source files and images

  Source files are located in ./files and output to ./images

Image format guides

Mermaid files (.mmd)

• Mermaid documentation

Dot files (.dot)

• Graphviz documentation

PlantUML files (.puml)

• PlantUML Guide
• Planttext
• PlantUML Editor

Online image editors

Mermaid files (.mmd)

• Mermaid Live Editor

Dot files (.dot)

• Graphviz it

PlantUML files (.puml)

• Planttext
• PlantUML Editor

Installing CLI image tools

Mermaid files (.mmd)

• npm install -g mermaid.cli
• or see Mermaid npm page

Dot files (.dot)

• brew install graphviz
• or see Graphviz download page

PlantUML files (.puml)

• npm install -g node-plantuml
• or see node-plantuml npm page
• Requires Java SDK
• Optionally requires Graphviz for all diagram types