@mytechtoday/augment-extensions 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (232) hide show
  1. package/LICENSE +22 -22
  2. package/README.md +105 -6
  3. package/augment-extensions/domain-rules/software-architecture/README.md +143 -143
  4. package/augment-extensions/domain-rules/software-architecture/examples/banking-layered.md +961 -961
  5. package/augment-extensions/domain-rules/software-architecture/examples/ecommerce-microservices.md +990 -990
  6. package/augment-extensions/domain-rules/software-architecture/examples/iot-eventdriven.md +882 -882
  7. package/augment-extensions/domain-rules/software-architecture/examples/monolith-to-microservices-migration.md +703 -703
  8. package/augment-extensions/domain-rules/software-architecture/examples/serverless-imageprocessing.md +957 -957
  9. package/augment-extensions/domain-rules/software-architecture/examples/trading-eventdriven.md +747 -747
  10. package/augment-extensions/domain-rules/software-architecture/module.json +119 -119
  11. package/augment-extensions/domain-rules/software-architecture/rules/challenges-solutions.md +763 -763
  12. package/augment-extensions/domain-rules/software-architecture/rules/definitions-terminology.md +409 -409
  13. package/augment-extensions/domain-rules/software-architecture/rules/design-principles.md +684 -684
  14. package/augment-extensions/domain-rules/software-architecture/rules/evaluation-testing.md +1381 -1381
  15. package/augment-extensions/domain-rules/software-architecture/rules/event-driven-architecture.md +616 -616
  16. package/augment-extensions/domain-rules/software-architecture/rules/fundamentals.md +306 -306
  17. package/augment-extensions/domain-rules/software-architecture/rules/industry-architectures.md +554 -554
  18. package/augment-extensions/domain-rules/software-architecture/rules/layered-architecture.md +776 -776
  19. package/augment-extensions/domain-rules/software-architecture/rules/microservices-architecture.md +503 -503
  20. package/augment-extensions/domain-rules/software-architecture/rules/modeling-documentation.md +1199 -1199
  21. package/augment-extensions/domain-rules/software-architecture/rules/monolithic-architecture.md +351 -351
  22. package/augment-extensions/domain-rules/software-architecture/rules/principles.md +556 -556
  23. package/augment-extensions/domain-rules/software-architecture/rules/quality-attributes.md +797 -797
  24. package/augment-extensions/domain-rules/software-architecture/rules/scalability-performance.md +1345 -1345
  25. package/augment-extensions/domain-rules/software-architecture/rules/security-architecture.md +1039 -1039
  26. package/augment-extensions/domain-rules/software-architecture/rules/serverless-architecture.md +711 -711
  27. package/augment-extensions/domain-rules/software-architecture/rules/skills-development.md +568 -568
  28. package/augment-extensions/domain-rules/software-architecture/rules/tools-methodologies.md +961 -961
  29. package/augment-extensions/visual-design/CHANGELOG.md +132 -132
  30. package/augment-extensions/visual-design/README.md +255 -255
  31. package/augment-extensions/visual-design/__tests__/README.md +119 -119
  32. package/augment-extensions/visual-design/__tests__/style-selector.test.ts +172 -172
  33. package/augment-extensions/visual-design/__tests__/vendor-styles.test.ts +214 -214
  34. package/augment-extensions/visual-design/domains/other/ai-prompt-helper.ts +157 -157
  35. package/augment-extensions/visual-design/domains/other/dotnet-application.ts +156 -156
  36. package/augment-extensions/visual-design/domains/other/linux-platform.ts +156 -156
  37. package/augment-extensions/visual-design/domains/other/mobile-application.ts +157 -157
  38. package/augment-extensions/visual-design/domains/other/motion-picture.ts +156 -156
  39. package/augment-extensions/visual-design/domains/other/os-application.ts +156 -156
  40. package/augment-extensions/visual-design/domains/other/print-campaigns.ts +158 -158
  41. package/augment-extensions/visual-design/domains/other/web-app.ts +157 -157
  42. package/augment-extensions/visual-design/domains/other/website.ts +161 -161
  43. package/augment-extensions/visual-design/domains/other/windows-platform.ts +156 -156
  44. package/augment-extensions/visual-design/domains/web-page-styles/amazon-cloudscape.ts +506 -506
  45. package/augment-extensions/visual-design/domains/web-page-styles/google-modern.ts +615 -615
  46. package/augment-extensions/visual-design/domains/web-page-styles/microsoft-fluent.ts +531 -531
  47. package/augment-extensions/visual-design/examples/README.md +97 -97
  48. package/augment-extensions/visual-design/examples/ai-prompt-generation.md +233 -233
  49. package/augment-extensions/visual-design/examples/basic-usage.md +216 -216
  50. package/augment-extensions/visual-design/examples/domain-workflows.md +257 -257
  51. package/augment-extensions/visual-design/examples/vendor-comparison.md +247 -247
  52. package/augment-extensions/visual-design/module.json +78 -78
  53. package/augment-extensions/visual-design/style-selector.ts +177 -177
  54. package/augment-extensions/visual-design/types.ts +302 -302
  55. package/augment-extensions/visual-design/visual-design-core.ts +469 -469
  56. package/augment-extensions/workflows/adr-support/README.md +227 -227
  57. package/augment-extensions/workflows/adr-support/__tests__/adr-validator.test.ts +203 -203
  58. package/augment-extensions/workflows/adr-support/adr-validator.ts +162 -162
  59. package/augment-extensions/workflows/adr-support/examples/complete-lifecycle-example.md +449 -449
  60. package/augment-extensions/workflows/adr-support/examples/integration-example.md +580 -580
  61. package/augment-extensions/workflows/adr-support/examples/superseding-example.md +436 -436
  62. package/augment-extensions/workflows/adr-support/module.json +112 -112
  63. package/augment-extensions/workflows/adr-support/rules/adr-creation.md +372 -372
  64. package/augment-extensions/workflows/adr-support/rules/beads-integration.md +443 -443
  65. package/augment-extensions/workflows/adr-support/rules/conflict-detection.md +486 -486
  66. package/augment-extensions/workflows/adr-support/rules/decision-detection.md +362 -362
  67. package/augment-extensions/workflows/adr-support/rules/lifecycle-management.md +427 -427
  68. package/augment-extensions/workflows/adr-support/rules/openspec-integration.md +465 -465
  69. package/augment-extensions/workflows/adr-support/rules/template-selection.md +405 -405
  70. package/augment-extensions/workflows/adr-support/rules/validation-rules.md +543 -543
  71. package/augment-extensions/workflows/adr-support/schemas/adr-config.json +191 -191
  72. package/augment-extensions/workflows/adr-support/schemas/adr-metadata.json +172 -172
  73. package/augment-extensions/workflows/adr-support/templates/business-case.md +235 -235
  74. package/augment-extensions/workflows/adr-support/templates/madr-elaborate.md +197 -197
  75. package/augment-extensions/workflows/adr-support/templates/madr-simple.md +68 -68
  76. package/augment-extensions/workflows/adr-support/templates/nygard.md +84 -84
  77. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -213
  78. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -169
  79. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -165
  80. package/cli/dist/commands/agent.d.ts +37 -0
  81. package/cli/dist/commands/agent.d.ts.map +1 -0
  82. package/cli/dist/commands/agent.js +222 -0
  83. package/cli/dist/commands/agent.js.map +1 -0
  84. package/cli/dist/commands/beads.d.ts +64 -0
  85. package/cli/dist/commands/beads.d.ts.map +1 -0
  86. package/cli/dist/commands/beads.js +377 -0
  87. package/cli/dist/commands/beads.js.map +1 -0
  88. package/cli/dist/commands/change.d.ts +54 -0
  89. package/cli/dist/commands/change.d.ts.map +1 -0
  90. package/cli/dist/commands/change.js +243 -0
  91. package/cli/dist/commands/change.js.map +1 -0
  92. package/cli/dist/commands/clean.d.ts +15 -0
  93. package/cli/dist/commands/clean.d.ts.map +1 -0
  94. package/cli/dist/commands/clean.js +63 -0
  95. package/cli/dist/commands/clean.js.map +1 -0
  96. package/cli/dist/commands/clone.d.ts +15 -0
  97. package/cli/dist/commands/clone.d.ts.map +1 -0
  98. package/cli/dist/commands/clone.js +49 -0
  99. package/cli/dist/commands/clone.js.map +1 -0
  100. package/cli/dist/commands/config.d.ts +33 -0
  101. package/cli/dist/commands/config.d.ts.map +1 -0
  102. package/cli/dist/commands/config.js +166 -0
  103. package/cli/dist/commands/config.js.map +1 -0
  104. package/cli/dist/commands/context.d.ts +38 -0
  105. package/cli/dist/commands/context.d.ts.map +1 -0
  106. package/cli/dist/commands/context.js +205 -0
  107. package/cli/dist/commands/context.js.map +1 -0
  108. package/cli/dist/commands/create.d.ts +18 -0
  109. package/cli/dist/commands/create.d.ts.map +1 -0
  110. package/cli/dist/commands/create.js +178 -0
  111. package/cli/dist/commands/create.js.map +1 -0
  112. package/cli/dist/commands/diff.d.ts +19 -0
  113. package/cli/dist/commands/diff.d.ts.map +1 -0
  114. package/cli/dist/commands/diff.js +104 -0
  115. package/cli/dist/commands/diff.js.map +1 -0
  116. package/cli/dist/commands/doctor.d.ts +14 -0
  117. package/cli/dist/commands/doctor.d.ts.map +1 -0
  118. package/cli/dist/commands/doctor.js +62 -0
  119. package/cli/dist/commands/doctor.js.map +1 -0
  120. package/cli/dist/commands/export.d.ts +28 -0
  121. package/cli/dist/commands/export.d.ts.map +1 -0
  122. package/cli/dist/commands/export.js +135 -0
  123. package/cli/dist/commands/export.js.map +1 -0
  124. package/cli/dist/commands/import.d.ts +23 -0
  125. package/cli/dist/commands/import.d.ts.map +1 -0
  126. package/cli/dist/commands/import.js +118 -0
  127. package/cli/dist/commands/import.js.map +1 -0
  128. package/cli/dist/commands/prompt.d.ts +45 -0
  129. package/cli/dist/commands/prompt.d.ts.map +1 -0
  130. package/cli/dist/commands/prompt.js +223 -0
  131. package/cli/dist/commands/prompt.js.map +1 -0
  132. package/cli/dist/commands/spec.d.ts +57 -0
  133. package/cli/dist/commands/spec.d.ts.map +1 -0
  134. package/cli/dist/commands/spec.js +279 -0
  135. package/cli/dist/commands/spec.js.map +1 -0
  136. package/cli/dist/commands/stats.d.ts +18 -0
  137. package/cli/dist/commands/stats.d.ts.map +1 -0
  138. package/cli/dist/commands/stats.js +85 -0
  139. package/cli/dist/commands/stats.js.map +1 -0
  140. package/cli/dist/commands/task.d.ts +65 -0
  141. package/cli/dist/commands/task.d.ts.map +1 -0
  142. package/cli/dist/commands/task.js +282 -0
  143. package/cli/dist/commands/task.js.map +1 -0
  144. package/cli/dist/commands/template.d.ts +17 -0
  145. package/cli/dist/commands/template.d.ts.map +1 -0
  146. package/cli/dist/commands/template.js +55 -0
  147. package/cli/dist/commands/template.js.map +1 -0
  148. package/cli/dist/utils/agent-config.d.ts +129 -0
  149. package/cli/dist/utils/agent-config.d.ts.map +1 -0
  150. package/cli/dist/utils/agent-config.js +297 -0
  151. package/cli/dist/utils/agent-config.js.map +1 -0
  152. package/cli/dist/utils/auto-sync.js +19 -19
  153. package/cli/dist/utils/beads-graph.d.ts +17 -0
  154. package/cli/dist/utils/beads-graph.d.ts.map +1 -0
  155. package/cli/dist/utils/beads-graph.js +150 -0
  156. package/cli/dist/utils/beads-graph.js.map +1 -0
  157. package/cli/dist/utils/beads-integration.d.ts +112 -0
  158. package/cli/dist/utils/beads-integration.d.ts.map +1 -0
  159. package/cli/dist/utils/beads-integration.js +312 -0
  160. package/cli/dist/utils/beads-integration.js.map +1 -0
  161. package/cli/dist/utils/beads-reporter.d.ts +17 -0
  162. package/cli/dist/utils/beads-reporter.d.ts.map +1 -0
  163. package/cli/dist/utils/beads-reporter.js +160 -0
  164. package/cli/dist/utils/beads-reporter.js.map +1 -0
  165. package/cli/dist/utils/cache-manager.d.ts +55 -0
  166. package/cli/dist/utils/cache-manager.d.ts.map +1 -0
  167. package/cli/dist/utils/cache-manager.js +150 -0
  168. package/cli/dist/utils/cache-manager.js.map +1 -0
  169. package/cli/dist/utils/change-manager.d.ts +70 -0
  170. package/cli/dist/utils/change-manager.d.ts.map +1 -0
  171. package/cli/dist/utils/change-manager.js +412 -0
  172. package/cli/dist/utils/change-manager.js.map +1 -0
  173. package/cli/dist/utils/config-manager-enhanced.d.ts +66 -0
  174. package/cli/dist/utils/config-manager-enhanced.d.ts.map +1 -0
  175. package/cli/dist/utils/config-manager-enhanced.js +77 -0
  176. package/cli/dist/utils/config-manager-enhanced.js.map +1 -0
  177. package/cli/dist/utils/context-manager.d.ts +96 -0
  178. package/cli/dist/utils/context-manager.d.ts.map +1 -0
  179. package/cli/dist/utils/context-manager.js +258 -0
  180. package/cli/dist/utils/context-manager.js.map +1 -0
  181. package/cli/dist/utils/diff-engine.d.ts +78 -0
  182. package/cli/dist/utils/diff-engine.d.ts.map +1 -0
  183. package/cli/dist/utils/diff-engine.js +233 -0
  184. package/cli/dist/utils/diff-engine.js.map +1 -0
  185. package/cli/dist/utils/export-system.d.ts +101 -0
  186. package/cli/dist/utils/export-system.d.ts.map +1 -0
  187. package/cli/dist/utils/export-system.js +289 -0
  188. package/cli/dist/utils/export-system.js.map +1 -0
  189. package/cli/dist/utils/health-checker.d.ts +66 -0
  190. package/cli/dist/utils/health-checker.d.ts.map +1 -0
  191. package/cli/dist/utils/health-checker.js +285 -0
  192. package/cli/dist/utils/health-checker.js.map +1 -0
  193. package/cli/dist/utils/import-system.d.ts +74 -0
  194. package/cli/dist/utils/import-system.d.ts.map +1 -0
  195. package/cli/dist/utils/import-system.js +317 -0
  196. package/cli/dist/utils/import-system.js.map +1 -0
  197. package/cli/dist/utils/module-cloner.d.ts +40 -0
  198. package/cli/dist/utils/module-cloner.d.ts.map +1 -0
  199. package/cli/dist/utils/module-cloner.js +136 -0
  200. package/cli/dist/utils/module-cloner.js.map +1 -0
  201. package/cli/dist/utils/prompt-manager.d.ts +90 -0
  202. package/cli/dist/utils/prompt-manager.d.ts.map +1 -0
  203. package/cli/dist/utils/prompt-manager.js +302 -0
  204. package/cli/dist/utils/prompt-manager.js.map +1 -0
  205. package/cli/dist/utils/spec-manager.d.ts +65 -0
  206. package/cli/dist/utils/spec-manager.d.ts.map +1 -0
  207. package/cli/dist/utils/spec-manager.js +329 -0
  208. package/cli/dist/utils/spec-manager.js.map +1 -0
  209. package/cli/dist/utils/stats-collector.d.ts +74 -0
  210. package/cli/dist/utils/stats-collector.d.ts.map +1 -0
  211. package/cli/dist/utils/stats-collector.js +164 -0
  212. package/cli/dist/utils/stats-collector.js.map +1 -0
  213. package/cli/dist/utils/template-engine.d.ts +47 -0
  214. package/cli/dist/utils/template-engine.d.ts.map +1 -0
  215. package/cli/dist/utils/template-engine.js +204 -0
  216. package/cli/dist/utils/template-engine.js.map +1 -0
  217. package/package.json +12 -3
  218. package/augment-extensions/workflows/openspec/README.md +0 -96
  219. package/augment-extensions/workflows/openspec/examples/complete-change-example.md +0 -244
  220. package/augment-extensions/workflows/openspec/module.json +0 -54
  221. package/augment-extensions/workflows/openspec/rules/best-practices.md +0 -272
  222. package/augment-extensions/workflows/openspec/rules/manual-setup.md +0 -231
  223. package/augment-extensions/workflows/openspec/rules/spec-format.md +0 -236
  224. package/augment-extensions/workflows/openspec/rules/workflow.md +0 -214
  225. package/cli/dist/utils/__tests__/adr-validator.example.d.ts +0 -6
  226. package/cli/dist/utils/__tests__/adr-validator.example.d.ts.map +0 -1
  227. package/cli/dist/utils/__tests__/adr-validator.example.js +0 -148
  228. package/cli/dist/utils/__tests__/adr-validator.example.js.map +0 -1
  229. package/cli/dist/utils/adr-validator.d.ts +0 -65
  230. package/cli/dist/utils/adr-validator.d.ts.map +0 -1
  231. package/cli/dist/utils/adr-validator.js +0 -203
  232. package/cli/dist/utils/adr-validator.js.map +0 -1
@@ -1,197 +1,197 @@
1
- # ADR-{number}: {Title}
2
-
3
- **Status:** {Draft | Proposed | Approved | Implemented | Superseded | Deprecated}
4
-
5
- **Date:** {YYYY-MM-DD}
6
-
7
- **Deciders:** {List of people involved in the decision}
8
-
9
- **Technical Story:** {Optional: Link to related issue, spec, or task}
10
-
11
- ---
12
-
13
- ## Context and Problem Statement
14
-
15
- {Describe the context and problem statement in detail. What is the issue that motivates this decision? What are the business and technical drivers?}
16
-
17
- ### Background
18
-
19
- {Provide additional background information that helps understand the problem domain}
20
-
21
- ### Assumptions
22
-
23
- {List key assumptions made in this decision}
24
-
25
- - {Assumption 1}
26
- - {Assumption 2}
27
- - {Assumption 3}
28
-
29
- ### Constraints
30
-
31
- {List constraints that limit the solution space}
32
-
33
- - {Constraint 1}
34
- - {Constraint 2}
35
- - {Constraint 3}
36
-
37
- ---
38
-
39
- ## Decision Drivers
40
-
41
- {List the key factors that influenced this decision, in priority order}
42
-
43
- 1. {High priority driver}
44
- 2. {Medium priority driver}
45
- 3. {Lower priority driver}
46
-
47
- ---
48
-
49
- ## Considered Options
50
-
51
- ### Option 1: {Option Name}
52
-
53
- **Description:** {Detailed description of this option}
54
-
55
- **Pros:**
56
- - {Advantage 1}
57
- - {Advantage 2}
58
- - {Advantage 3}
59
-
60
- **Cons:**
61
- - {Disadvantage 1}
62
- - {Disadvantage 2}
63
- - {Disadvantage 3}
64
-
65
- **Cost/Effort:** {Estimation of implementation cost and effort}
66
-
67
- **Risk:** {Risk assessment: Low | Medium | High}
68
-
69
- ---
70
-
71
- ### Option 2: {Option Name}
72
-
73
- **Description:** {Detailed description of this option}
74
-
75
- **Pros:**
76
- - {Advantage 1}
77
- - {Advantage 2}
78
- - {Advantage 3}
79
-
80
- **Cons:**
81
- - {Disadvantage 1}
82
- - {Disadvantage 2}
83
- - {Disadvantage 3}
84
-
85
- **Cost/Effort:** {Estimation of implementation cost and effort}
86
-
87
- **Risk:** {Risk assessment: Low | Medium | High}
88
-
89
- ---
90
-
91
- ### Option 3: {Option Name}
92
-
93
- **Description:** {Detailed description of this option}
94
-
95
- **Pros:**
96
- - {Advantage 1}
97
- - {Advantage 2}
98
- - {Advantage 3}
99
-
100
- **Cons:**
101
- - {Disadvantage 1}
102
- - {Disadvantage 2}
103
- - {Disadvantage 3}
104
-
105
- **Cost/Effort:** {Estimation of implementation cost and effort}
106
-
107
- **Risk:** {Risk assessment: Low | Medium | High}
108
-
109
- ---
110
-
111
- ## Decision Outcome
112
-
113
- **Chosen option:** "{Option X}", because:
114
-
115
- {Provide detailed justification for the chosen option. Explain how it best addresses the decision drivers and why it was preferred over the alternatives.}
116
-
117
- ### Consequences
118
-
119
- #### Positive Consequences
120
-
121
- - {Positive consequence 1 with explanation}
122
- - {Positive consequence 2 with explanation}
123
- - {Positive consequence 3 with explanation}
124
-
125
- #### Negative Consequences
126
-
127
- - {Negative consequence 1 with mitigation strategy}
128
- - {Negative consequence 2 with mitigation strategy}
129
- - {Negative consequence 3 with mitigation strategy}
130
-
131
- #### Neutral Consequences
132
-
133
- - {Neutral consequence 1}
134
- - {Neutral consequence 2}
135
-
136
- ---
137
-
138
- ## Validation
139
-
140
- {How will we know if this decision was correct? Define success criteria and metrics.}
141
-
142
- ### Success Criteria
143
-
144
- - {Measurable criterion 1}
145
- - {Measurable criterion 2}
146
- - {Measurable criterion 3}
147
-
148
- ### Metrics
149
-
150
- - {Metric 1: baseline → target}
151
- - {Metric 2: baseline → target}
152
-
153
- ### Review Schedule
154
-
155
- - {When to review this decision: e.g., "After 3 months" or "After first production deployment"}
156
-
157
- ---
158
-
159
- ## Implementation Plan
160
-
161
- {Optional: High-level implementation plan}
162
-
163
- ### Phase 1: {Phase Name}
164
- - {Task 1}
165
- - {Task 2}
166
-
167
- ### Phase 2: {Phase Name}
168
- - {Task 1}
169
- - {Task 2}
170
-
171
- ### Migration Strategy
172
-
173
- {If applicable, describe how to migrate from current state to new state}
174
-
175
- ---
176
-
177
- ## More Information
178
-
179
- ### References
180
-
181
- - {Link to research, documentation, or external resources}
182
- - {Link to proof of concept or prototype}
183
- - {Link to similar decisions in other projects}
184
-
185
- ### Related Decisions
186
-
187
- - Supersedes: [ADR-{number}]({link})
188
- - Superseded by: [ADR-{number}]({link})
189
- - Related to: [ADR-{number}]({link})
190
-
191
- ### Stakeholder Feedback
192
-
193
- {Optional: Summary of feedback from key stakeholders}
194
-
195
- - **{Stakeholder 1}:** {Feedback summary}
196
- - **{Stakeholder 2}:** {Feedback summary}
197
-
1
+ # ADR-{number}: {Title}
2
+
3
+ **Status:** {Draft | Proposed | Approved | Implemented | Superseded | Deprecated}
4
+
5
+ **Date:** {YYYY-MM-DD}
6
+
7
+ **Deciders:** {List of people involved in the decision}
8
+
9
+ **Technical Story:** {Optional: Link to related issue, spec, or task}
10
+
11
+ ---
12
+
13
+ ## Context and Problem Statement
14
+
15
+ {Describe the context and problem statement in detail. What is the issue that motivates this decision? What are the business and technical drivers?}
16
+
17
+ ### Background
18
+
19
+ {Provide additional background information that helps understand the problem domain}
20
+
21
+ ### Assumptions
22
+
23
+ {List key assumptions made in this decision}
24
+
25
+ - {Assumption 1}
26
+ - {Assumption 2}
27
+ - {Assumption 3}
28
+
29
+ ### Constraints
30
+
31
+ {List constraints that limit the solution space}
32
+
33
+ - {Constraint 1}
34
+ - {Constraint 2}
35
+ - {Constraint 3}
36
+
37
+ ---
38
+
39
+ ## Decision Drivers
40
+
41
+ {List the key factors that influenced this decision, in priority order}
42
+
43
+ 1. {High priority driver}
44
+ 2. {Medium priority driver}
45
+ 3. {Lower priority driver}
46
+
47
+ ---
48
+
49
+ ## Considered Options
50
+
51
+ ### Option 1: {Option Name}
52
+
53
+ **Description:** {Detailed description of this option}
54
+
55
+ **Pros:**
56
+ - {Advantage 1}
57
+ - {Advantage 2}
58
+ - {Advantage 3}
59
+
60
+ **Cons:**
61
+ - {Disadvantage 1}
62
+ - {Disadvantage 2}
63
+ - {Disadvantage 3}
64
+
65
+ **Cost/Effort:** {Estimation of implementation cost and effort}
66
+
67
+ **Risk:** {Risk assessment: Low | Medium | High}
68
+
69
+ ---
70
+
71
+ ### Option 2: {Option Name}
72
+
73
+ **Description:** {Detailed description of this option}
74
+
75
+ **Pros:**
76
+ - {Advantage 1}
77
+ - {Advantage 2}
78
+ - {Advantage 3}
79
+
80
+ **Cons:**
81
+ - {Disadvantage 1}
82
+ - {Disadvantage 2}
83
+ - {Disadvantage 3}
84
+
85
+ **Cost/Effort:** {Estimation of implementation cost and effort}
86
+
87
+ **Risk:** {Risk assessment: Low | Medium | High}
88
+
89
+ ---
90
+
91
+ ### Option 3: {Option Name}
92
+
93
+ **Description:** {Detailed description of this option}
94
+
95
+ **Pros:**
96
+ - {Advantage 1}
97
+ - {Advantage 2}
98
+ - {Advantage 3}
99
+
100
+ **Cons:**
101
+ - {Disadvantage 1}
102
+ - {Disadvantage 2}
103
+ - {Disadvantage 3}
104
+
105
+ **Cost/Effort:** {Estimation of implementation cost and effort}
106
+
107
+ **Risk:** {Risk assessment: Low | Medium | High}
108
+
109
+ ---
110
+
111
+ ## Decision Outcome
112
+
113
+ **Chosen option:** "{Option X}", because:
114
+
115
+ {Provide detailed justification for the chosen option. Explain how it best addresses the decision drivers and why it was preferred over the alternatives.}
116
+
117
+ ### Consequences
118
+
119
+ #### Positive Consequences
120
+
121
+ - {Positive consequence 1 with explanation}
122
+ - {Positive consequence 2 with explanation}
123
+ - {Positive consequence 3 with explanation}
124
+
125
+ #### Negative Consequences
126
+
127
+ - {Negative consequence 1 with mitigation strategy}
128
+ - {Negative consequence 2 with mitigation strategy}
129
+ - {Negative consequence 3 with mitigation strategy}
130
+
131
+ #### Neutral Consequences
132
+
133
+ - {Neutral consequence 1}
134
+ - {Neutral consequence 2}
135
+
136
+ ---
137
+
138
+ ## Validation
139
+
140
+ {How will we know if this decision was correct? Define success criteria and metrics.}
141
+
142
+ ### Success Criteria
143
+
144
+ - {Measurable criterion 1}
145
+ - {Measurable criterion 2}
146
+ - {Measurable criterion 3}
147
+
148
+ ### Metrics
149
+
150
+ - {Metric 1: baseline → target}
151
+ - {Metric 2: baseline → target}
152
+
153
+ ### Review Schedule
154
+
155
+ - {When to review this decision: e.g., "After 3 months" or "After first production deployment"}
156
+
157
+ ---
158
+
159
+ ## Implementation Plan
160
+
161
+ {Optional: High-level implementation plan}
162
+
163
+ ### Phase 1: {Phase Name}
164
+ - {Task 1}
165
+ - {Task 2}
166
+
167
+ ### Phase 2: {Phase Name}
168
+ - {Task 1}
169
+ - {Task 2}
170
+
171
+ ### Migration Strategy
172
+
173
+ {If applicable, describe how to migrate from current state to new state}
174
+
175
+ ---
176
+
177
+ ## More Information
178
+
179
+ ### References
180
+
181
+ - {Link to research, documentation, or external resources}
182
+ - {Link to proof of concept or prototype}
183
+ - {Link to similar decisions in other projects}
184
+
185
+ ### Related Decisions
186
+
187
+ - Supersedes: [ADR-{number}]({link})
188
+ - Superseded by: [ADR-{number}]({link})
189
+ - Related to: [ADR-{number}]({link})
190
+
191
+ ### Stakeholder Feedback
192
+
193
+ {Optional: Summary of feedback from key stakeholders}
194
+
195
+ - **{Stakeholder 1}:** {Feedback summary}
196
+ - **{Stakeholder 2}:** {Feedback summary}
197
+
@@ -1,68 +1,68 @@
1
- # ADR-{number}: {Title}
2
-
3
- **Status:** {Draft | Proposed | Approved | Implemented | Superseded | Deprecated}
4
-
5
- **Date:** {YYYY-MM-DD}
6
-
7
- **Deciders:** {List of people involved in the decision}
8
-
9
- **Technical Story:** {Optional: Link to related issue, spec, or task}
10
-
11
- ---
12
-
13
- ## Context and Problem Statement
14
-
15
- {Describe the context and problem statement in 2-3 sentences. What is the issue that motivates this decision?}
16
-
17
- ---
18
-
19
- ## Decision Drivers
20
-
21
- {Optional: List the key factors that influenced this decision}
22
-
23
- - {Driver 1}
24
- - {Driver 2}
25
- - {Driver 3}
26
-
27
- ---
28
-
29
- ## Considered Options
30
-
31
- - {Option 1}
32
- - {Option 2}
33
- - {Option 3}
34
-
35
- ---
36
-
37
- ## Decision Outcome
38
-
39
- **Chosen option:** "{Option X}", because {justification in 1-2 sentences}.
40
-
41
- ### Consequences
42
-
43
- - **Good:** {Positive consequence 1}
44
- - **Good:** {Positive consequence 2}
45
- - **Bad:** {Negative consequence 1}
46
- - **Bad:** {Negative consequence 2}
47
-
48
- ---
49
-
50
- ## Validation
51
-
52
- {Optional: How will we know if this decision was correct?}
53
-
54
- - {Success criterion 1}
55
- - {Success criterion 2}
56
-
57
- ---
58
-
59
- ## More Information
60
-
61
- {Optional: Additional context, references, or implementation notes}
62
-
63
- ### Links
64
-
65
- - {Link to related documentation}
66
- - {Link to implementation PR}
67
- - {Link to related ADR}
68
-
1
+ # ADR-{number}: {Title}
2
+
3
+ **Status:** {Draft | Proposed | Approved | Implemented | Superseded | Deprecated}
4
+
5
+ **Date:** {YYYY-MM-DD}
6
+
7
+ **Deciders:** {List of people involved in the decision}
8
+
9
+ **Technical Story:** {Optional: Link to related issue, spec, or task}
10
+
11
+ ---
12
+
13
+ ## Context and Problem Statement
14
+
15
+ {Describe the context and problem statement in 2-3 sentences. What is the issue that motivates this decision?}
16
+
17
+ ---
18
+
19
+ ## Decision Drivers
20
+
21
+ {Optional: List the key factors that influenced this decision}
22
+
23
+ - {Driver 1}
24
+ - {Driver 2}
25
+ - {Driver 3}
26
+
27
+ ---
28
+
29
+ ## Considered Options
30
+
31
+ - {Option 1}
32
+ - {Option 2}
33
+ - {Option 3}
34
+
35
+ ---
36
+
37
+ ## Decision Outcome
38
+
39
+ **Chosen option:** "{Option X}", because {justification in 1-2 sentences}.
40
+
41
+ ### Consequences
42
+
43
+ - **Good:** {Positive consequence 1}
44
+ - **Good:** {Positive consequence 2}
45
+ - **Bad:** {Negative consequence 1}
46
+ - **Bad:** {Negative consequence 2}
47
+
48
+ ---
49
+
50
+ ## Validation
51
+
52
+ {Optional: How will we know if this decision was correct?}
53
+
54
+ - {Success criterion 1}
55
+ - {Success criterion 2}
56
+
57
+ ---
58
+
59
+ ## More Information
60
+
61
+ {Optional: Additional context, references, or implementation notes}
62
+
63
+ ### Links
64
+
65
+ - {Link to related documentation}
66
+ - {Link to implementation PR}
67
+ - {Link to related ADR}
68
+
@@ -1,84 +1,84 @@
1
- # ADR-{number}: {Title}
2
-
3
- **Status:** {Draft | Proposed | Approved | Implemented | Superseded | Deprecated}
4
-
5
- **Date:** {YYYY-MM-DD}
6
-
7
- **Deciders:** {List of people involved in the decision}
8
-
9
- **Technical Story:** {Optional: Link to related issue, spec, or task}
10
-
11
- ---
12
-
13
- ## Context
14
-
15
- {Describe the context and problem statement. What is the issue that motivates this decision or change?}
16
-
17
- ### Forces
18
-
19
- {Optional: Describe the forces at play (technical, political, social, project-related). These are the constraints and considerations that influence the decision.}
20
-
21
- - {Force 1}
22
- - {Force 2}
23
- - {Force 3}
24
-
25
- ---
26
-
27
- ## Decision
28
-
29
- {Describe the decision that was made. Use active voice: "We will..."}
30
-
31
- ### Rationale
32
-
33
- {Explain why this decision was made. What are the key reasons?}
34
-
35
- ---
36
-
37
- ## Consequences
38
-
39
- ### Positive
40
-
41
- {What becomes easier or better as a result of this decision?}
42
-
43
- - {Positive consequence 1}
44
- - {Positive consequence 2}
45
-
46
- ### Negative
47
-
48
- {What becomes harder or worse as a result of this decision?}
49
-
50
- - {Negative consequence 1}
51
- - {Negative consequence 2}
52
-
53
- ### Neutral
54
-
55
- {What are the neutral consequences or trade-offs?}
56
-
57
- - {Neutral consequence 1}
58
- - {Neutral consequence 2}
59
-
60
- ---
61
-
62
- ## Related Decisions
63
-
64
- {Optional: List related ADRs}
65
-
66
- - Supersedes: [ADR-{number}]({link})
67
- - Superseded by: [ADR-{number}]({link})
68
- - Related to: [ADR-{number}]({link})
69
-
70
- ---
71
-
72
- ## Notes
73
-
74
- {Optional: Any additional notes, references, or links}
75
-
76
- ### References
77
-
78
- - {Reference 1}
79
- - {Reference 2}
80
-
81
- ### Implementation Notes
82
-
83
- {Optional: Notes about implementation, migration path, or timeline}
84
-
1
+ # ADR-{number}: {Title}
2
+
3
+ **Status:** {Draft | Proposed | Approved | Implemented | Superseded | Deprecated}
4
+
5
+ **Date:** {YYYY-MM-DD}
6
+
7
+ **Deciders:** {List of people involved in the decision}
8
+
9
+ **Technical Story:** {Optional: Link to related issue, spec, or task}
10
+
11
+ ---
12
+
13
+ ## Context
14
+
15
+ {Describe the context and problem statement. What is the issue that motivates this decision or change?}
16
+
17
+ ### Forces
18
+
19
+ {Optional: Describe the forces at play (technical, political, social, project-related). These are the constraints and considerations that influence the decision.}
20
+
21
+ - {Force 1}
22
+ - {Force 2}
23
+ - {Force 3}
24
+
25
+ ---
26
+
27
+ ## Decision
28
+
29
+ {Describe the decision that was made. Use active voice: "We will..."}
30
+
31
+ ### Rationale
32
+
33
+ {Explain why this decision was made. What are the key reasons?}
34
+
35
+ ---
36
+
37
+ ## Consequences
38
+
39
+ ### Positive
40
+
41
+ {What becomes easier or better as a result of this decision?}
42
+
43
+ - {Positive consequence 1}
44
+ - {Positive consequence 2}
45
+
46
+ ### Negative
47
+
48
+ {What becomes harder or worse as a result of this decision?}
49
+
50
+ - {Negative consequence 1}
51
+ - {Negative consequence 2}
52
+
53
+ ### Neutral
54
+
55
+ {What are the neutral consequences or trade-offs?}
56
+
57
+ - {Neutral consequence 1}
58
+ - {Neutral consequence 2}
59
+
60
+ ---
61
+
62
+ ## Related Decisions
63
+
64
+ {Optional: List related ADRs}
65
+
66
+ - Supersedes: [ADR-{number}]({link})
67
+ - Superseded by: [ADR-{number}]({link})
68
+ - Related to: [ADR-{number}]({link})
69
+
70
+ ---
71
+
72
+ ## Notes
73
+
74
+ {Optional: Any additional notes, references, or links}
75
+
76
+ ### References
77
+
78
+ - {Reference 1}
79
+ - {Reference 2}
80
+
81
+ ### Implementation Notes
82
+
83
+ {Optional: Notes about implementation, migration path, or timeline}
84
+