Architecture Decision Record

Thema: Light

← Templedi cofnodion penderfyniadau

Templed cofnod penderfyniad saernïaeth (ADR)

Templed yw hwn ar gyfer ADR EdgeX Foundry.

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

Cyflwynwyr

Rhestrwch gyflwynwyr yr ADR.

Fformat:

  • Enw (Sefydliad)

Log newidiadau

Rhestrwch y newidiadau i'r ddogfen, gan gynnwys y cyflwr, y dyddiad ac URL y cais tynnu (PR).

Mae'r cyflwr yn un o: yn aros, wedi'i gymeradwyo, wedi'i ddiwygio, anghymeradwy.

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

Y PR yw'r cais tynnu (pull request) a gyflwynodd y newid, gan gynnwys gwybodaeth fel y gwahaniaethau, y cyfranwyr a'r adolygwyr.

Fformat:

  • [Statws yr ADR e.e. wedi'i gymeradwyo, wedi'i ddiwygio, ac ati](URL y cais tynnu) BBBB-MM-DD

Achos(ion) defnydd y cyfeirir atynt

Rhestrwch yr holl ddogfennau achosion defnydd / gofynion perthnasol.

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

Fformat:

  • [Enw'r achos defnydd](URL)

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

Cyd-destun

Disgrifiwch:

  • sut mae'r dyluniad yn arwyddocaol o ran saernïaeth - gan gyfiawnhau ADR (yn hytrach na mater a PR syml i ddatrys problem)

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

Dyluniad arfaethedig

Manylion y dyluniad (heb fynd i fanylion gweithredu lle bo modd).

Amlinelliad:

  • gwasanaethau/modiwlau yr effeithir arnynt (a newidir)

  • gwasanaethau/modiwlau newydd i'w hychwanegu

  • effaith ar fodelau a DTO (newidiadau/ychwanegiadau/dileadau)

  • effaith ar APIau (newidiadau/ychwanegiadau/dileadau)

  • effaith ar ffurfweddiad cyffredinol (sefydlu adrannau newydd, newidiadau/ychwanegiadau/dileadau)

  • effaith ar devops

Ystyriaethau

Dogfennwch ddewisiadau amgen, pryderon, materion ategol neu gysylltiedig, a chwestiynau a gododd yn y drafodaeth ar yr ADR.

Nodwch a gawsant eu datrys neu eu lliniaru, a sut.

Penderfyniad

Dogfennwch unrhyw fanylion gweithredu pwysig y cytunwyd arnynt, rhybuddion, ystyriaethau ar gyfer y dyfodol, a materion dylunio sy'n weddill neu wedi'u gohirio.

Dogfennwch unrhyw ran o'r gofynion nad yw'r dyluniad arfaethedig yn eu bodloni.

ADRau eraill cysylltiedig

Rhestrwch unrhyw ADRau perthnasol - fel penderfyniad dylunio ar gyfer is-gydran o nodwedd, dyluniad a ddaeth yn anghymeradwy o ganlyniad i'r dyluniad hwn, ac ati.

Fformat:

  • [Teitl yr ADR](URL) - Perthnasedd

Cyfeiriadau

Rhestrwch gyfeiriadau ychwanegol.

Fformat:

  • [Teitl](URL)