Skip to content

Instantly share code, notes, and snippets.

@ambersariya
Forked from FaKleiser/AD-XX-template.md
Created October 3, 2017 10:27
Show Gist options
  • Save ambersariya/800641b8300f85b102a29221f5895090 to your computer and use it in GitHub Desktop.
Save ambersariya/800641b8300f85b102a29221f5895090 to your computer and use it in GitHub Desktop.
Architecture Decision Template

AD-XX: <TOPIC - short, concise summary>

  • Date: <DATE - when the decision was made>
  • Deciders: <DECIDERS - list everyone involved in the decision>
  • Status: [PROPOSED | ACCEPTED | SUPERSEDED | DEPRECATED]
  • Category: <CATEGORY - use a simple grouping to help organize the set of decisions (e.g. backend, payment, user management, ...)>

Related

If you have related decisions, requirements, documents or guidelines that affect this decision, link them here. When linking another document, also add one sentence describing why the linked document influences this decision. If there are no related documents, remove this section.

Context

Briefly describe the background information required to understand the problem of the decision being made. Try to answer:

  • Are there any assumptions for this decision? (think about: cost, schedule, technology, other projects ...)
  • Are there any constraints for this decision? (think about: accepted technology standards, common patterns, ...)

Alternatives

Alternative X

Briefly describe alternative 1 and then list arguments in favor for and against alternative X. You may also list harsh numbers, figures, charts, or anything that helps your future self to understand the decision's motivation.

Decision

The decision was made in favor for alternative X.

After stating the decision, briefly explain the motivation that led to choosing the alternative (e.g., by stating which arguments were most important to the team).

Consequences

Mention the consequences the decision has on the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment