Architecture Knowledge Base
Welcome :wave: to the architecture knowledge base of cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance. Here you will find the Architecture Decision Records (ADRs) of the project.
Definition and purpose¶
An Architecture Decision (AD) is a software design choice that addresses an architecturally significant functional or non-functional requirement.
An Architecture Decision Record (ADR) captures a single AD along with its context and consequence.
An Architecture Decision Log (ADL) is the collection of ADRs created and maintained for a project or organization.
An ADR is immutable: only its status can change (i.e., become deprecated or superseded). That way, you can become familiar with the whole project history just by reading its decision log in chronological order.
Maintaining this documentation aims at:
- :rocket: Improving and accelerating the onboarding of a new team member
- :telescope: Avoiding blind acceptance or reversal of a past decision
- :handshake: Formalizing the decision process of the team
Usage¶
The typical workflow of an ADR:
The decision process is entirely collaborative and backed by pull requests.
:information_source: Technical Details
The architecture knowledge base is updated automatically on each push to the project'smasterbranch; the developers manage this documentation directly with in-project markdown files for seamless integration, reducing documentation and source code drift throughout the software development lifecycle and downstream CI/CD pipelines.
:fire: Tip
You can browse the ADRs via the left menu or the search bar of the ADL.