Skip to content

Commit a4a71d4

Browse files
authored
Update ADR template to emphasize design level decisions.
Clarify ADR guidelines to avoid implementation details.
1 parent a41c928 commit a4a71d4

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

docs/adr/0001-use-adr.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,22 @@ Accepted
1313
## Context
1414

1515
We need to record the architectural decisions made on this project.
16+
ADR should stay at design/decision level,
17+
without specific implementation details, code snippets
18+
or step by step procedures.
1619

1720
This ADR is the template to use for all the others ADR:
1821
customize this file to ensure it fits your needs and
1922
ensure that all the ADRs follow the same format.
2023

24+
The context provides the basic information that leads
25+
to decision, and may include the considered alternatives.
26+
2127
## Decision
2228

2329
- [ ] We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
2430
- [ ] Decision is a list of checkboxes, to be marked as the decision is implemented.
31+
- [ ] Avoid adding specific implementation details, code snippets or step-by-step procedures.
2532
- [ ] Consequences section contain Pros and Cons of decision,
2633
in the form of bullet list.
2734

0 commit comments

Comments
 (0)