Architecture Decision Record
← Templedi cofnodion penderfyniadau

Templed Cofnod Penderfyniad Pensaernïaeth (ADR) yn ei le

Mae hwn yn dempled ar gyfer EdgeX Foundry ADR.

Ffynhonnell: https://docs.edgexfoundry.org/2.3/design/adr/template/

Cyflwynwyr

Rhestrwch y rhai sy'n cyflwyno ADR.

Fformat:

  • Enw (Sefydliad)

Log Newid

Rhestrwch y newidiadau i'r ddogfen, gan gynnwys. cyflwr, dyddiad, a PR URL.

Mae'r wladwriaeth yn un o: arfaeth, cymeradwy, diwygio, anghymeradwy.

Mae'r dyddiad yn llinyn ISO 8601 (BBBB-MM-DD).

PR yw’r cais tynnu a gyflwynodd y newid, gan gynnwys gwybodaeth fel y diffynnydd, cyfranwyr, ac adolygwyr.

Fformat:

  • [ Statws ADR e.e. cymeradwyo, diwygio, ac ati](URL cais tynnu) BBBB-MM-DD

Achos(ion) Defnydd Cyfeiriedig

Rhestrwch yr holl ddogfennau achos defnydd / gofynion perthnasol.

Mae ADR yn gofyn am o leiaf un achos defnydd cymeradwy perthnasol.

Fformat:

  • [Defnyddiwch Enw'r Achos](URL)

Ychwanegu esboniadau os nad yw'r ADR yn mynd i'r afael â holl ofynion achos defnydd.

Cyd-destun

Disgrifiwch:

  • sut mae'r dyluniad yn arwyddocaol yn bensaernïol - gwarantu ADR (yn erbyn mater syml a chysylltiadau cyhoeddus i ddatrys problem)

  • y dull dylunio lefel uchel (manylion a ddisgrifir yn y dyluniad arfaethedig isod)

Dyluniad Arfaethedig

Manylion y dyluniad (heb ddechrau gweithredu lle bo modd).

Amlinelliad:

  • gwasanaethau/modiwlau i gael eu heffeithio (newid)

  • gwasanaethau/modiwlau newydd i'w hychwanegu

  • effaith model ac DTO (newidiadau/ychwanegiadau/dileu)

  • Effaith API (newidiadau / ychwanegiadau / dileu)

  • effaith cyfluniad cyffredinol (sefydlu adrannau newydd, newidiadau / ychwanegiadau / dileu)

  • devops effaith

Ystyriaethau

Dogfennu dewisiadau eraill, pryderon, materion ategol neu gysylltiedig, cwestiynau a gododd wrth drafod yr ADR.

Nodwch os/sut y cawsant eu datrys neu eu moli.

Penderfyniad

Dogfennu unrhyw fanylion gweithredu pwysig y cytunwyd arnynt, rhybuddion, ystyriaethau yn y dyfodol, materion dylunio sy'n weddill neu'n cael eu gohirio.

Dogfennu unrhyw ran o'r gofynion nad ydynt yn cael eu bodloni gan y dyluniad arfaethedig.

ADRs Cysylltiedig Eraill

Rhestrwch unrhyw ADRs perthnasol - megis penderfyniad dylunio ar gyfer is-gydran o nodwedd, dyluniad sydd wedi'i anghymeradwyo o ganlyniad i'r dyluniad hwn, ac ati.

Fformat:

  • [ADR Title](URL) - Perthnasedd

Cyfeiriadau

Rhestrwch gyfeiriadau ychwanegol.

Fformat:

  • [Teitl](URL)