DEV Community

Camilo
Camilo

Posted on

Using Asciidoc for Arquitecture Decision Records

GitHub logo NinjasCL / adr-asciidoc

A simple tool for creating Architectural Decision Records.

Architectural Decision Log Tool

This log lists the architectural decisions for this project.


For new ADRs, please use docs/templates/adr.template.adoc as basis. You can easily create a new ADR with adr command based on the template:

./adr new My New ADR
Enter fullscreen mode Exit fullscreen mode

For generating a new README.adoc and index.html use the compile task:

./adr compile
Enter fullscreen mode Exit fullscreen mode

Requires NodeJS and ASCIIDoc installed.


More information on MADR is available at https://adr.github.io/madr/. General information about architectural decision records is available at https://adr.github.io/.

Made with by Ninjas.cl.



Requires https://nodejs.org/en/ and https://asciidoctor.org/ installed.


More information on MADR is available at https://adr.github.io/madr/.
General information about architectural decision records is available at https://adr.github.io/.

Discussion (0)