Notice: Function WP_Scripts::add was called incorrectly. The script with the handle "markdown-renderer" was enqueued with dependencies that are not registered: mermaid-js, prism-core. Please see Debugging in WordPress for more information. (This message was added in version 6.9.1.) in /home/dataadl/www/wp-includes/functions.php on line 6131

Architecture Decision Records (ADRs): Documenting the Why

Code comments explain *what*, but not *why* a particular architectural decision was made. **ADRs** are lightweight Markdown documents capturing context, options considered, and the decision chosen.

ADR Template

# ADR-001: Use PostgreSQL over SQL Server

## Status
Accepted

## Context
We need a relational database for application X. 
Options: SQL Server, PostgreSQL, MySQL.

## Decision
Use PostgreSQL because of licensing costs and JSON support.

## Consequences
Team needs training on pgAdmin. 
ARM templates change.

Key Takeaways

  • Store ADRs in the repo (`docs/adr/`).
  • ADRs are immutable. If a decision changes, write a new ADR superseding the old one.

Discover more from C4: Container, Code, Cloud & Context

Subscribe to get the latest posts sent to your email.

Leave a comment

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.