Jak sporządzić ADR na podstawie nagrania dyskusji architektonicznej
ADR opisuje jedną istotną decyzję architektoniczną: kontekst, opcje, wybór, konsekwencje i status. Transkrypcja pomaga odtworzyć argumenty. Poprawność techniczną potwierdzają uczestnicy.
Jak opracować Architecture Decision Record na podstawie nagranej dyskusji
ADR opisuje jedną istotną decyzję architektoniczną: kontekst, opcje, wybór, konsekwencje i status. Transkrypcja pomaga odtworzyć argumenty. Poprawność techniczną potwierdzają uczestnicy.
Transkrypcja pozwala sprawdzić sformułowania. Zachowuje kontekst, zastrzeżenia i kolejność argumentów. Autor ustala ostateczne brzmienie i prosi uczestników o sprawdzenie.
Opracuj ADR krok po kroku
Wybierz jedną decyzję
Każdą niezależną decyzję architektoniczną udokumentuj osobno.
Opisz kontekst
Zapisz czynniki i ograniczenia, które wymusiły decyzję.
Porównaj opcje
Zachowaj główne zalety, wady i powody odrzucenia każdej opcji.
Wymień konsekwencje
Określ korzyści, koszty, nowe ograniczenia, ryzyka i warunek ponownego rozpatrzenia.
Przykład: wybór sposobu przechowywania plików audio
Poniższy przykład szkoleniowy jest fikcyjny. Nazwy, warunki i rezultaty służą wyłącznie wyjaśnieniu metody.
„Pamięć obiektowa jest tańsza dla archiwum, ale potrzebujemy osobnego mechanizmu tymczasowych linków”.
Kontekst: nagrania są duże, dostęp ma wygasać, a udostępnianie linków trzeba kontrolować. Wybór pada na pamięć obiektową. Oprócz ceny liczą się skalowalność i model dostępu.
W konsekwencjach uwzględnij pracę i ryzyko: tymczasowe linki, kontrolę ważności, rejestrowanie zdarzeń i testy awarii. Jeśli zmieni się założenie kosztowe, nowy ADR może zastąpić poprzedni z zachowaniem historii.
| Sekcja | Użyteczny wpis | Przykład do unikania |
|---|---|---|
| Kontekst | Duże pliki i ograniczony dostęp | Potrzeba nowej pamięci |
| Opcje | Pamięć obiektowa / plikowa | Wybraliśmy najlepsze rozwiązanie |
| Decyzja | Pamięć obiektowa z powodów A i B | Tak zdecydował architekt |
| Konsekwencje | Tymczasowe linki i monitorowanie | Brak wad |
Szablon ADR
Skopiuj szablon i uzupełnij go na podstawie konkretnego nagrania. Oznacz przypuszczenia jako hipotezy.
Tytuł i status: Data i uczestnicy: Kontekst i ograniczenia: Rozpatrzone opcje: Decyzja i uzasadnienie: Konsekwencje, ryzyka i warunek przeglądu:
Cztery sprawdzenia przed wysłaniem
- Wpis opisuje jedną decyzję.
- Kontekst zawiera rzeczywiste ograniczenia.
- Zapisano alternatywy i powody ich odrzucenia.
- Podano wady i warunek przeglądu.
Przyjrzyjmy się szczegółom
Czy można edytować zaakceptowany ADR?
Można poprawić literówki. Zmianę decyzji zapisz w nowym ADR z odsyłaczem do poprzedniego.
Czy transkrypcja musi być obok?
Zwykle do sprawdzenia spornej wypowiedzi wystarczą odsyłacz do wewnętrznego źródła i znacznik czasu.