Architecture Decision Record

Active theme: Light

← dokument

Advice fo how to write good ADR

Characteristics of good ADR:

  • Rationale: Explain di reasons for to do di particular AD. Dis fit include di context (check below), pros and cons of different potential choices, feature comparisons, cost/benefit discussions, and more.

  • Specific: Each ADR suppose be about one AD, no be many ADs.

  • Timestamps: Identify wen dem write each item for di ADR. Dis one important well well for aspects wey fit change as time dey go, like costs, schedules, scaling, and di like.

  • Immutable: No alter information wey dey inside ADR already. Instead, amend di ADR by to add new information, or supersede di ADR by to create new ADR.

Characteristics of good "Context" section for ADR:

  • Explain your organization situation and business priorities.

  • Include rationale and considerations based on social and skills makeups of your teams.

  • Include pros and cons wey relevant, and describe dem for terms wey align with your needs and goals.

Characteristics of good "Consequences" section for ADR:

  • Explain wetin follow after you make di decision. Dis fit include di effects, outcomes, outputs, follow ups, and more.

  • Include information about any subsequent ADR. E common small for one ADR to trigger need for more ADRs, like wen one ADR make big overarching choice, wey then create needs for more smaller decisions.

  • Include any after-action review processes. E typical for teams to review each ADR one month later, to compare di ADR information with wetin don happen for actual practice, so dem go learn and grow.

New ADR fit take di place of previous ADR:

  • Wen dem make AD wey replace or invalidate previous ADR, then dem suppose create new ADR