Architecture Decision Record

Active theme: Light

← dokumenty

Tipy pro psaní dobrých ADR

Vlastnosti dobrého ADR:

  • Odůvodnění: Vysvětlete důvody pro dané architektonické rozhodnutí. Může zahrnovat kontext (viz níže), výhody a nevýhody různých možných voleb, srovnání funkcí, diskuse o nákladech a přínosech a další.

  • Konkrétnost: Každé ADR by mělo být o jednom architektonickém rozhodnutí, ne o více.

  • Časová razítka: Uveďte, kdy byla napsána každá položka ADR. Je to zvlášť důležité u aspektů, které se mohou v čase měnit, jako jsou náklady, harmonogramy, škálování a podobně.

  • Neměnnost: Neměňte existující informace v ADR. Místo toho ADR doplňte přidáním nových informací nebo ho nahraďte vytvořením nového ADR.

Vlastnosti dobré sekce „Kontext“ v ADR:

  • Vysvětlete situaci své organizace a obchodní priority.

  • Zahrňte zdůvodnění a úvahy vycházející ze sociálního složení a dovedností vašich týmů.

  • Zahrňte relevantní výhody a nevýhody a popište je pojmy, které odpovídají vašim potřebám a cílům.

Vlastnosti dobré sekce „Důsledky“ v ADR:

  • Vysvětlete, co z učinění rozhodnutí vyplývá. Může zahrnovat dopady, výsledky, výstupy, navazující kroky a další.

  • Zahrňte informace o případných následných ADR. Je poměrně běžné, že jedno ADR vyvolá potřebu dalších ADR, například když jedno ADR učiní velkou zastřešující volbu, která zase vytváří potřebu dalších menších rozhodnutí.

  • Zahrňte případné procesy zpětného hodnocení. Je typické, že týmy každé ADR přezkoumají po měsíci, aby porovnaly informace v ADR s tím, co se stalo v praxi, a mohly se poučit a růst.

Nové ADR může nahradit předchozí ADR:

  • Když se učiní architektonické rozhodnutí, které nahrazuje nebo ruší předchozí ADR, měl by se vytvořit nové ADR