openJIIDocs
Design Decisions

ADR template

The project's historical template for an architecture decision record.

This template is preserved from the previous documentation without changing its substance.

ADR: [Title]

Date: YYYY-MM-DD
Status: [Proposed | Accepted | Deprecated | Rejected]


Context

Provide the background and problem statement. Include:

  • The overall situation and requirements.
  • Key objectives and constraints.
  • Any relevant technical or business context.

Decision

Describe the chosen solution and the rationale behind it. Include:

  • A summary of the selected architecture/design/approach.
  • Key components or modules involved.
  • Technologies or methodologies chosen.
  • How the decision addresses the requirements outlined in the Context section.

Consequences

Benefits:

  • List the advantages and improvements expected from this decision.

Trade-offs / Risks:

  • Outline potential downsides, complexities, or risks introduced.
  • Mention any expected increases in costs, administrative overhead, or performance impacts.

Alternatives Considered

  • Alternative 1: Brief description and rationale for rejection.
  • Alternative 2: Brief description and rationale for rejection.
  • (Add additional alternatives as needed)

Conclusion

Summarize the decision and its overall impact on the system or project. Mention any next steps or actions required to implement the decision.


On this page