1
1
<!--
2
2
browser: architecture-decision-record
3
3
tracker: 2bd6622ec3beeeddd8ff55cf0ccf2efc
4
- version: 2 .0.0
5
- updated: 2021-05-19T18:56:40Z
4
+ version: 3 .0.0
5
+ updated: 2023-11-07T20:42:12Z
6
6
contact: Joel Parker Henderson (http://joelparkerhenderson.com)
7
7
options: commentable
8
8
-->
@@ -17,10 +17,10 @@ Contents:
17
17
- [ How to start using ADRs] ( #how-to-start-using-adrs )
18
18
- [ How to start using ADRs with tools] ( #how-to-start-using-adrs-with-tools )
19
19
- [ How to start using ADRs with git] ( #how-to-start-using-adrs-with-git )
20
- - [ ADR file name conventions] ( #adr- file-name-conventions )
20
+ - [ File name conventions for ADRs ] ( #file-name-conventions-for-adrs )
21
21
- [ Suggestions for writing good ADRs] ( #suggestions-for-writing-good-adrs )
22
22
- [ ADR example templates] ( #adr-example-templates )
23
- - [ Teamwork advice] ( #teamwork-advice )
23
+ - [ Teamwork advice for ADRs ] ( #teamwork-advice-for-adrs )
24
24
- [ For more information] ( #for-more-information )
25
25
26
26
Templates:
@@ -34,7 +34,7 @@ Templates:
34
34
* [ Decision record template using Planguage] ( locales/en/templates/decision-record-template-using-planguage/ )
35
35
* [ Decision record template by Paulo Merson] ( https://github.com/pmerson/ADR-template )
36
36
* [ Decision record template by Olaf Zimmermann] ( https://medium.com/olzzio/y-statements-10eb07b5a177 )
37
- * Translations: [ cymraeg ] ( locales/cy ) • [ español ] ( locales/es ) • [ français ] ( locales/fr ) • [ 한국어 ] ( locales/ko )
37
+ * [ Translations into more languages ] ( locales/ )
38
38
39
39
Examples:
40
40
@@ -48,6 +48,10 @@ Examples:
48
48
* [ Timestamp format] ( locales/en/examples/timestamp-format/ )
49
49
* [ Many more...] ( locales/en/examples/ )
50
50
51
+ [ Translations into more languages] ( locales/ )
52
+
53
+
54
+ <div class =" include " data-path =" locales/en/what-is-an-architecture-decision-record " >
51
55
52
56
## What is an architecture decision record?
53
57
@@ -75,6 +79,9 @@ Abbreviations:
75
79
76
80
* ** ASR** : architecturally-significant requirement
77
81
82
+ </div >
83
+
84
+ <div class =" include " data-path =" locales/en/how-to-start-using-adrs " >
78
85
79
86
## How to start using ADRs
80
87
@@ -122,6 +129,9 @@ For more:
122
129
123
130
* The steps above are adopted from the Wikipedia entry on [ Architectural Decision] ( https://en.wikipedia.org/wiki/Architectural_decision )
124
131
132
+ </div >
133
+
134
+ <div class =" include " data-path =" locales/en/how-to-start-using-adrs-with-tools " >
125
135
126
136
## How to start using ADRs with tools
127
137
@@ -137,6 +147,9 @@ For example:
137
147
138
148
* If you like using wikis, such as MediaWiki, then you can create an ADR wiki.
139
149
150
+ </div >
151
+
152
+ <div class =" include " data-path =" locales/en/how-to-start-using-ADRs-with-git " >
140
153
141
154
## How to start using ADRs with git
142
155
@@ -158,8 +171,11 @@ Write anything you want in the ADR. See the templates in this repository for ide
158
171
159
172
Commit the ADR to your git repo.
160
173
174
+ </div >
175
+
176
+ <div class =" include " data-path =" locales/en/file-name-conventions-for-adrs " >
161
177
162
- ## ADR file name conventions
178
+ ## File name conventions for ADRs
163
179
164
180
If you choose to create your ADRs using typical text files, then you may want to come up with your own ADR file name convention.
165
181
@@ -183,6 +199,9 @@ Our file name convention:
183
199
184
200
* The extension is markdown. This can be useful for easy formatting.
185
201
202
+ </div >
203
+
204
+ <div class =" import " data-path =" locales/en/suggestions-for-writing-good-adrs " >
186
205
187
206
## Suggestions for writing good ADRs
188
207
@@ -216,6 +235,7 @@ A new ADR may take the place of a previous ADR:
216
235
217
236
* When an AD is made that replaces or invalidates a previous ADR, then a new ADR should be created
218
237
238
+ </div >
219
239
220
240
## ADR example templates
221
241
@@ -233,8 +253,9 @@ ADR example templates that we have collected on the net:
233
253
234
254
* [ ADR template using Planguage] ( locales/en/templates/decision-record-template-using-planguage/ ) (more quality assurance oriented)
235
255
256
+ <div class =" import " data-path =" locales/en/teamwork-advice-for-adrs " >
236
257
237
- ## Teamwork advice
258
+ ## Teamwork advice for ADRs
238
259
239
260
If you're considering using decision records with your team, then here's some advice that we've learned by working with many teams.
240
261
@@ -244,6 +265,7 @@ Some teams much prefer the name "decisions" over the abbreviation "ADRs". When s
244
265
245
266
In theory, immutability is ideal. In practice, mutability has worked better for our teams. We insert the new info the existing ADR, with a date stamp, and a note that the info arrived after the decision. This kind of approach leads to a "living document" that we all can update. Typical updates are when we get information thanks to new teammates, or new offerings, or real-world results of our usages, or after-the-fact third-party changes such as vendor capabilties, pricing plans, license agreements, etc.
246
267
268
+ </div >
247
269
248
270
## For more information
249
271
0 commit comments