Architecture Decision Record

Active theme: Light

← dokumenty

Wskazówki, jak pisać dobre ADR

Cechy dobrego ADR:

  • Uzasadnienie: Wyjaśnij powody podjęcia danej decyzji architektonicznej. Może to obejmować kontekst (patrz niżej), zalety i wady różnych możliwych wyborów, porównania funkcji, dyskusje o kosztach i korzyściach i inne.

  • Konkretność: Każdy ADR powinien dotyczyć jednej decyzji architektonicznej, a nie kilku.

  • Znaczniki czasu: Zaznacz, kiedy powstał każdy element ADR. Jest to szczególnie ważne w przypadku aspektów, które mogą się z czasem zmieniać, takich jak koszty, harmonogramy, skalowanie i tym podobne.

  • Niezmienność: Nie zmieniaj istniejących informacji w ADR. Zamiast tego uzupełnij ADR o nowe informacje albo zastąp go, tworząc nowy ADR.

Cechy dobrej sekcji „Kontekst” w ADR:

  • Wyjaśnij sytuację swojej organizacji i priorytety biznesowe.

  • Uwzględnij uzasadnienia i względy wynikające ze struktury społecznej i umiejętności w Twoich zespołach.

  • Uwzględnij istotne zalety i wady oraz opisz je w kategoriach zgodnych z Twoimi potrzebami i celami.

Cechy dobrej sekcji „Konsekwencje” w ADR:

  • Wyjaśnij, co wynika z podjęcia decyzji. Mogą to być skutki, wyniki, rezultaty, działania następcze i inne.

  • Uwzględnij informacje o kolejnych ADR. Dość często jeden ADR rodzi potrzebę kolejnych, na przykład gdy jeden ADR zawiera duży, nadrzędny wybór, który z kolei wymaga wielu mniejszych decyzji.

  • Uwzględnij procesy przeglądu po wdrożeniu. Zespoły zwykle przeglądają każdy ADR po miesiącu, porównując jego treść z tym, co wydarzyło się w praktyce, aby się uczyć i rozwijać.

Nowy ADR może zastąpić poprzedni ADR:

  • Gdy zostaje podjęta decyzja architektoniczna, która zastępuje lub unieważnia poprzedni ADR, należy utworzyć nowy ADR