mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-12 10:55:20 +02:00
37 lines
2.0 KiB
Markdown
37 lines
2.0 KiB
Markdown
<!-- This file is the homepage of your Log4brains knowledge base. You are free to edit it as you want -->
|
|
|
|
# Architecture knowledge base
|
|
|
|
Welcome 👋 to the architecture knowledge base of Piper library.
|
|
You will find here all the Architecture Decision Records (ADR) of the project.
|
|
|
|
## Definition and purpose
|
|
|
|
> An Architectural Decision (AD) is a software design choice that addresses a functional or non-functional requirement that is architecturally significant.
|
|
> An Architectural Decision Record (ADR) captures a single AD, such as often done when writing personal notes or meeting minutes; the collection of ADRs created and maintained in a project constitutes its decision log.
|
|
|
|
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.
|
|
Moreover, maintaining this documentation aims at:
|
|
|
|
- 🚀 Improving and speeding up the onboarding of a new team member
|
|
- 🔭 Avoiding blind acceptance/reversal of a past decision (cf [Michael Nygard's famous article on ADRs](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions.html))
|
|
- 🤝 Formalizing the decision process of the team
|
|
|
|
## Usage
|
|
|
|
This website is automatically updated after a change on the `master` branch of the project's Git repository.
|
|
In fact, the developers manage this documentation directly with markdown files located next to their code, so it is more convenient for them to keep it up-to-date.
|
|
You can browse the ADRs by using the left menu or the search bar.
|
|
|
|
The typical workflow of an ADR is the following:
|
|
|
|
|
|
|
|
The decision process is entirely collaborative and backed by pull requests.
|
|
|
|
## More information
|
|
|
|
- [Log4brains documentation](https://github.com/thomvaill/log4brains/tree/master#readme)
|
|
- [What is an ADR and why should you use them](https://github.com/thomvaill/log4brains/tree/master#-what-is-an-adr-and-why-should-you-use-them)
|
|
- [ADR GitHub organization](https://adr.github.io/)
|