Javaslatok jó ADR-ek íráshoz
Egy jó ADR jellemzői:
Indoklás: Magyarázza el az adott architekturális döntés meghozatalának okait. Ez magában foglalhatja a hátteret (lásd lent), a különböző lehetséges választások előnyeit és hátrányait, funkcióösszehasonlításokat, költség–haszon megbeszéléseket és egyebeket.
Konkrét: Minden ADR egy architekturális döntésről szóljon, ne többről.
Időbélyegek: Jelölje meg, mikor íródott az ADR egyes elemei. Ez különösen fontos azoknál a szempontoknál, amelyek idővel változhatnak, például költségek, ütemtervek, skálázás és hasonlók.
Megváltoztathatatlan: Ne módosítsa az ADR meglévő információit. Ehelyett egészítse ki az ADR-t új információkkal, vagy váltsa le egy új ADR létrehozásával.
Egy jó „Háttér” szakasz jellemzői egy ADR-ben:
Magyarázza el a szervezet helyzetét és az üzleti prioritásokat.
Foglaljon bele a csapatai társas és készségbeli összetételén alapuló indoklást és szempontokat.
Foglaljon bele releváns előnyöket és hátrányokat, és írja le őket az igényeivel és céljaival összhangban lévő módon.
Egy jó „Következmények” szakasz jellemzői egy ADR-ben:
Magyarázza el, mi következik a döntés meghozatalából. Ez magában foglalhatja a hatásokat, eredményeket, kimeneteket, utókövetést és egyebeket.
Foglaljon bele információt az esetleges későbbi ADR-ekről. Viszonylag gyakori, hogy egy ADR további ADR-ek szükségességét váltja ki, például amikor egy ADR nagy, átfogó választást tesz, ami viszont több kisebb döntés igényét hozza létre.
Foglaljon bele minden utólagos értékelési folyamatot. Jellemző, hogy a csapatok egy hónappal később áttekintik az egyes ADR-eket, hogy összevessék az ADR információit a gyakorlatban történtekkel, hogy tanuljanak és fejlődjenek.
Egy új ADR átveheti egy korábbi ADR helyét:
- Amikor olyan architekturális döntés születik, amely felváltja vagy érvényteleníti egy korábbi ADR-t, új ADR-t kell létrehozni