Architecture Decision Record
← Decisioun record templats

Architectur Decisioun Record (ADR) templat

This is a templat for EdgeX Foundry ADR.

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

Submitters

List ADR submitters.

Format:

  • Name (Organization)

Chynge Log

List the chynges tae the document, incl. state, date, an PR URL.

State is ane o: pendin, approved, amended, deprecated.

Date is an ISO 8601 (YYYY-MM-DD) string.

PR is the pull request that submittit the chynge, includin information sic as the diff, contributors, an reviewers.

Format:

  • [Status of ADR e.g. approved, amended, etc.](URL of pull request) YYYY-MM-DD

Referenced Uise Case(s)

List aw relevant uise case / requirements documents.

ADR requires at least ane relevant, approved uise case.

Format:

  • [Use Case Name](URL)

Add explanatiouns if the ADR isna addressin aw the requirements o a uise case.

Context

Describe:

  • hoo the design is architecturally significant - warrantin an ADR (versus simple issue an PR tae fix a problem)

  • the heich level design approach (details described in the proposed design ablow)

Proposed Design

Details o the design (athoot gaein intae implementation whaur possible).

Outline:

  • services/modules tae be impactit (chynged)

  • new services/modules tae be addit

  • model an DTO impact (chynges/additiouns/removals)

  • API impact (chynges/additiouns/removals)

  • general configuration impact (establishment o new sections, chynges/additiouns/removals)

  • devops impact

Considerations

Document alternatives, concerns, ancillary or relatit issues, questions that arose in debate o the ADR.

Indicate if/hoo they were resolved or mollified.

Decision

Document onie agreed upon important implementation detail, caveats, future considerations, remainin or deferrit design issues.

Document onie pairt o the requirements no satisfied bi the proposed design.

Ither Relatit ADRs

List onie relevant ADRs - sic as a design decisioun for a sub-component o a feature, a design deprecatit as a result o this design, etc..

Format:

  • [ADR Title](URL) - Relevance

References

List additional references.

Format:

  • [Title](URL)