Predložak zapisa arhitekturne odluke (ADR)

Ovo je predložak za ADR EdgeX Foundryja.

Navedite podnositelje ADR-a.

Format:

Dnevnik promjena

Navedite promjene dokumenta, uključujući stanje, datum i URL pull requesta.

Stanje je jedno od: pending, approved, amended, deprecated.

Datum je niz prema ISO 8601 (YYYY-MM-DD).

PR je pull request kojim je promjena podnesena, uključujući informacije poput razlika, doprinositelja i recenzenata.

Format:

Navedite sve relevantne dokumente slučajeva uporabe / zahtjeva.

ADR zahtijeva barem jedan relevantan, odobren slučaj uporabe.

Format:

Dodajte objašnjenja ako ADR ne obrađuje sve zahtjeve slučaja uporabe.

Opišite:

na koji je način dizajn arhitekturno značajan – što opravdava ADR (nasuprot jednostavnom problemu i PR-u za rješavanje problema)
pristup dizajnu na visokoj razini (pojedinosti su opisane u predloženom dizajnu u nastavku)

Pojedinosti dizajna (bez ulaska u implementaciju gdje je moguće).

Pregled:

servisi/moduli na koje će se utjecati (promijeniti)
novi servisi/moduli koje treba dodati
utjecaj na model i DTO (promjene/dodavanja/uklanjanja)
utjecaj na API (promjene/dodavanja/uklanjanja)
utjecaj na opću konfiguraciju (uspostava novih odjeljaka, promjene/dodavanja/uklanjanja)
utjecaj na devops

Dokumentirajte alternative, zabrinutosti, pomoćna ili povezana pitanja i pitanja koja su se pojavila u raspravi o ADR-u.

Navedite jesu li i kako riješena ili ublažena.

Dokumentirajte sve dogovorene važne implementacijske pojedinosti, upozorenja, buduća razmatranja, preostala ili odgođena pitanja dizajna.

Dokumentirajte sve dijelove zahtjeva koje predloženi dizajn ne zadovoljava.

Navedite sve relevantne ADR-ove – poput odluke o dizajnu podkomponente značajke, dizajna ukinutog zbog ovog dizajna itd..

Format:

Navedite dodatne reference.

Format: