2. Architecture decision repository

Date: 2024-11-24

Status

Accepted

Context

We need to record Architecture Decisions (AD) as defined in Record architecture decisions and share these records in an accessible repository.

Decision

To capture these records in a lean way, the Markdown Architectural Decision Records MADR have been invented: MADR is a streamlined template for recording architectural significant decisions in a structured manner.

We will use Markdown Architectural Decision Record 4.0.0 minimal template as described by Oliver Kopp and Olaf Zimmermann.

For more details, see Olaf Zimmermann (ZIO) blog.

Consequences

See MADR toolset, a command-line (CLI) tool to work with log of ADR in Markdown format (MADR) and Hugo, a popular open-source static site generators that natively support Markdown format.