febus982/mkdocs-macros-adr-summary

View on GitHub
docs/adr_nygard_example/0001-record-architecture-decisions.md

Summary

Maintainability
Test Coverage
# 1. Record architecture decisions

Date: 2024-01-20

## Status

Superceded by [2. Supersedes 1](0002-supercedes-1.md)

Superceded by [3. Supersedes 1-b](0003-supercedes-1-b.md)

## Context

We need to record the architectural decisions made on this project.

## Decision

We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).

## Consequences

See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).