diff --git a/adr/001-architecture-decision-records.md b/adr/001-architecture-decision-records.md index 2e38687b3..7bb2e9323 100644 --- a/adr/001-architecture-decision-records.md +++ b/adr/001-architecture-decision-records.md @@ -12,9 +12,7 @@ Accepted. ## Context -ADRs are originally described by -[Michael Nygard in an article](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) -and more robustly detailed and demonstrated [on GitHub](https://adr.github.io). +ADRs are originally described by [Michael Nygard in an article](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) and more robustly detailed and demonstrated [on GitHub](https://adr.github.io). We want to record our architectural decisions so that... @@ -25,18 +23,24 @@ We want to record our architectural decisions so that... _The outcomes of the decision, both positive and negative. This section explains the impact of the decision, such as trade-offs, risks, and what needs to be done to implement it._ -**Positive:** -- Allows us to show scope of considerations at the time of the decision +### Positive -**Negative:** -- Time consumption? +- **Transparency**: ADRs make decision-making more transparent, helping current and future team members understand the rationale behind decisions. +- **Historical Context**: They provide valuable historical context, aiding in future decision-making and avoiding repeated mistakes. +- **Onboarding**: ADRs speed up the onboarding process by quickly familiarizing new team members with architectural decisions. +- **Consistency**: A standardized format ensures consistent documentation, making records easier to maintain and reference. -**Risk(s)?:** -- None +### Negative -## Resources +- **Overhead**: Maintaining ADRs requires time and effort. +- **Outdated Records**: If not regularly updated, ADRs can become outdated and misleading. -### Related Issues +### Risks + +- **Incomplete Documentation**: Not all decisions may be documented, leading to gaps in the record. +- **Misalignment**: ADRs may not always match the actual implementation, causing confusion. + +## Related Issues - #1 - #13 diff --git a/adr/020-azure-alerts.md b/adr/020-azure-alerts.md index 8e4084d19..a6f37a4dc 100644 --- a/adr/020-azure-alerts.md +++ b/adr/020-azure-alerts.md @@ -27,18 +27,20 @@ To ensure rapid response to application failures within our CI/CD infrastructure - **Notification:** Alerts sent to a Slack channel via email until PagerDuty is operational. -## Consequences: -**Positive:** +## Impact + +### Positive + - Immediate awareness of critical issues, reducing downtime -**Negative:** +### Negative + - Possible alert fatigue if not fine-tuned -**Risk(s)?:** -- None +### Risks +- None -## Resources -### Related Issues +## Related Issues - #1001