Jak vytvořit ADR ze záznamu architektonické diskuse
ADR zachycuje jedno významné architektonické rozhodnutí: kontext, varianty, výběr, důsledky a stav. Přepis pomůže dohledat argumenty. Technickou správnost potvrdí účastníci.
Jak vytvořit Architecture Decision Record ze záznamu diskuse
ADR zachycuje jedno významné architektonické rozhodnutí: kontext, varianty, výběr, důsledky a stav. Přepis pomůže dohledat argumenty. Technickou správnost potvrdí účastníci.
Přepis umožňuje ověřit formulace a zachovává kontext, výhrady i sled argumentů. Konečnou podobu určí autor a nechá ji zkontrolovat účastníky.
Sestavte ADR krok za krokem
Zvolte jedno rozhodnutí
Každé samostatné architektonické rozhodnutí zaznamenejte zvlášť.
Popište kontext
Zapište faktory a omezení, kvůli kterým bylo rozhodnutí potřeba.
Porovnejte varianty
U každé varianty uchovejte hlavní výhody, nevýhody a důvody zamítnutí.
Uveďte důsledky
Sepište přínosy, náklady, nová omezení, rizika a podmínku přezkumu.
Výukový příklad: úložiště zvukových souborů
Následuje smyšlený výukový příklad. Názvy, podmínky a výsledky slouží jen k vysvětlení metody.
„Objektové úložiště vyjde pro archiv levněji, ale budeme potřebovat samostatný mechanismus dočasných odkazů.“
Kontext: nahrávky jsou velké, přístup má vypršet a vydávání odkazů je potřeba řídit. Volba padla na objektové úložiště. Vedle ceny záleží na škálovatelnosti a modelu přístupu.
Mezi důsledky uveďte práci a rizika: dočasné odkazy, kontrolu platnosti, protokolování a zkoušky selhání. Pokud se změní předpoklad o ceně, nové ADR může nahradit předchozí a zachovat historii.
| Část | Užitečný zápis | Nevhodný příklad |
|---|---|---|
| Kontext | Velké soubory a omezený přístup | Potřebujeme nové úložiště |
| Varianty | Objektové / souborové úložiště | Vybrali jsme to nejlepší |
| Rozhodnutí | Objektové z důvodů A a B | Rozhodl architekt |
| Důsledky | Dočasné odkazy a monitoring | Žádné nevýhody |
Šablona ADR
Zkopírujte šablonu a vyplňte ji podle konkrétní nahrávky. Domněnky označujte jako hypotézy.
Název a stav: Datum a účastníci: Kontext a omezení: Zvažované varianty: Rozhodnutí a důvody: Důsledky, rizika a podmínka přezkumu:
Čtyři kontroly před odesláním
- Záznam se týká jednoho rozhodnutí.
- Kontext obsahuje skutečná omezení.
- Varianty a důvody zamítnutí jsou uvedené.
- Je uvedena nevýhoda i podmínka přezkumu.
Podívejme se na podrobnosti
Lze upravit přijaté ADR?
Překlepy lze opravit. Změněné rozhodnutí zapište do nového ADR s odkazem na předchozí.
Musí být přepis uložen vedle ADR?
Odkaz na interní zdroj a časová značka zpravidla stačí k ověření sporné formulace.