Architektúradöntések rögzítése: ADR
Célok
A lecke végére el tudod magyarázni, mire való az ADR (architecture decision record, azaz architektúradöntési feljegyzés), és fel tudod ismerni, milyen elemekből áll egy használható döntésleírás.
Miért kell dokumentálni a döntést?
Egy ábra azt mutatja, milyen a rendszer, de nem azt, miért ilyen. Fél évvel később az indok elveszik, és vagy újra megvitatják, vagy tudatlanul visszabontják. Az ADR egy konkrét döntés indoklását rögzíti röviden, a döntés idején ismert kényszerekkel együtt.
Egy ADR szerkezete
Nincs kötelező formátum; a hasznos leírás ezeket a kérdéseket válaszolja meg:
- Helyzet: milyen követelmény és korlát mellett születik a döntés?
- Alternatívák: mely megoldásokat vizsgáltuk?
- Döntés: mit választottak, milyen határok között?
- Következmények: mi az előny, mi a vállalt költség, mit kell ellenőrizni?
- Felülvizsgálat: milyen változás indokolhat új döntést?
A „mikroszervizek skálázhatók” általános állítás. Egy ADR ennél konkrétabb: megnevezi a terhelési profilt, az elfogadott késleltetést és a vállalt működtetési költséget.
Hogyan viszonyul a döntés az ábrához?
Az ábra a szerkezetet, az ADR az indoklást adja; együtt értelmesek. Ha az egyik változik, a másikat is frissíteni kell. Az ADR nem helyettesíti a követelményeket és a minőségi jellemzőket (1.2); azokra hivatkozik.
A döntés összehasonlító értékelése
Ugyanazt a követelményt több tervvel is érdemes megvizsgálni, és mindegyiknél ugyanazokat a kérdéseket feltenni: ki módosítja az adatot, mi történik egy rész kiesésekor, melyik változtatáshoz kell két kiadás, hol ellenőrizhető a kompatibilitás. Ha az egyik tervnél csak az előnyöket, a másiknál csak a hibákat sorolják fel, nincs valódi összehasonlítás.
flowchart LR
K["Követelmény és korlát"] --> A["Alternatívák"]
A --> D["Döntés"]
D --> F["Következmények"]
F --> R["Felülvizsgálati feltétel"]
R -.-> K
Gyakori tévhitek
| Állítás |
Pontosítás |
| „Az ADR hosszú terv.” |
Egy konkrét döntés rövid indoklása. |
| „Az ADR a döntés utáni utólagos igazolás.” |
A döntés idején ismert alternatívákat és kényszereket rögzíti. |
| „A döntés véglegesen rögzített.” |
A felülvizsgálati feltétel kifejezetten új döntést indokolhat. |
Röviden
- Az ADR egy konkrét döntés indoklását rögzíti.
- Tartalma: helyzet, alternatívák, döntés, következmények, felülvizsgálat.
- Az ábra a szerkezetet, az ADR az indokot mutatja.
- A felülvizsgálati feltételnek ellenőrizhetőnek kell lennie.
Ellenőrző kérdések
- Miért nem elég egy architektúraábra a döntés megőrzéséhez?
- Milyen elemei vannak egy használható ADR-nek?
- Fogalmazz meg ellenőrizhető felülvizsgálati feltételt egy kiválasztott szétválasztási döntéshez.
Források
Architektúradöntések rögzítése: ADR
Célok
A lecke végére el tudod magyarázni, mire való az ADR (architecture decision record, azaz architektúradöntési feljegyzés), és fel tudod ismerni, milyen elemekből áll egy használható döntésleírás.
Miért kell dokumentálni a döntést?
Egy ábra azt mutatja, milyen a rendszer, de nem azt, miért ilyen. Fél évvel később az indok elveszik, és vagy újra megvitatják, vagy tudatlanul visszabontják. Az ADR egy konkrét döntés indoklását rögzíti röviden, a döntés idején ismert kényszerekkel együtt.
Egy ADR szerkezete
Nincs kötelező formátum; a hasznos leírás ezeket a kérdéseket válaszolja meg:
A „mikroszervizek skálázhatók” általános állítás. Egy ADR ennél konkrétabb: megnevezi a terhelési profilt, az elfogadott késleltetést és a vállalt működtetési költséget.
Hogyan viszonyul a döntés az ábrához?
Az ábra a szerkezetet, az ADR az indoklást adja; együtt értelmesek. Ha az egyik változik, a másikat is frissíteni kell. Az ADR nem helyettesíti a követelményeket és a minőségi jellemzőket (1.2); azokra hivatkozik.
A döntés összehasonlító értékelése
Ugyanazt a követelményt több tervvel is érdemes megvizsgálni, és mindegyiknél ugyanazokat a kérdéseket feltenni: ki módosítja az adatot, mi történik egy rész kiesésekor, melyik változtatáshoz kell két kiadás, hol ellenőrizhető a kompatibilitás. Ha az egyik tervnél csak az előnyöket, a másiknál csak a hibákat sorolják fel, nincs valódi összehasonlítás.
Gyakori tévhitek
Röviden
Ellenőrző kérdések
Források