Architecture Decision Record
← Decision record templet dem

Architecture Decision Record (ADR) templet

Dis na templet for EdgeX Foundry ADR.

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

Submitters

List di ADR submitters.

Format:

  • Name (Organization)

Change Log

List di changes to di document, incl. state, date, and PR URL.

State na one of: pending, approved, amended, deprecated.

Date na ISO 8601 (YYYY-MM-DD) string.

PR na di pull request wey submit di change, including information like di diff, contributors, and reviewers.

Format:

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

Referenced Use Case(s)

List all relevant use case / requirements documents.

ADR need at least one relevant, approved use case.

Format:

  • [Use Case Name](URL)

Add explanations if di ADR no dey address all di requirements of use case.

Context

Describe:

  • how di design dey architecturally significant - wey justify ADR (versus simple issue and PR to fix problem)

  • di high level design approach (details dey described for di proposed design below)

Proposed Design

Details of di design (without to enter implementation where e possible).

Outline:

  • services/modules wey go get impact (change)

  • new services/modules wey dem go add

  • model and DTO impact (changes/additions/removals)

  • API impact (changes/additions/removals)

  • general configuration impact (establishment of new sections, changes/additions/removals)

  • devops impact

Considerations

Document alternatives, concerns, ancillary or related issues, questions wey rise during debate of di ADR.

Show if/how dem resolve or mollify dem.

Decision

Document any agreed upon important implementation detail, caveats, future considerations, remaining or deferred design issues.

Document any part of di requirements wey di proposed design no satisfy.

List any relevant ADR - like design decision for sub-component of feature, design wey dem deprecate as result of dis design, etc..

Format:

  • [ADR Title](URL) - Relevance

References

List additional references.

Format:

  • [Title](URL)