Table of Contents
ADR-0001: Record architecture decisions¶
- Status: Accepted
- Date: 2026-06-26
- Deciders: nabin747
- Tags: process, documentation
Context¶
As projects in this repo grow (especially the Month-5 microservice and Month-6 capstone), I make non-obvious choices — which router, how to layer the code, manual DI vs wire, REST vs gRPC. Six months later (and to a reader/recruiter), the why is easy to lose. Capturing decisions also demonstrates professional engineering practice.
Decision¶
We will record significant architectural and tooling decisions as Architecture Decision Records (ADRs) in docs/adr/, using the lightweight Michael Nygard template (0000-template.md), numbered sequentially and immutable once accepted (superseded, never edited).
Options Considered¶
- ADRs in-repo (chosen) — versioned with code, reviewable in PRs, visible to readers.
- A wiki page — easy to edit but detached from code history and PR review.
- No formal record — lowest effort, but loses rationale and the learning/portfolio signal.
Consequences¶
- Positive: durable rationale; great interview material; demonstrates architecture maturity.
- Negative / trade-offs: small per-decision writing overhead.
- Follow-ups: add an ADR whenever a project makes a structural choice; link ADRs from project READMEs.