@codemcp/workflows-core 3.5.0 → 3.6.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.
- package/package.json +1 -1
- package/resources/workflows/adr.yaml +139 -0
package/package.json
CHANGED
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
name: adr
|
|
2
|
+
description: 'Architecture Decision Records workflow: Context → Research → Decide → Commit - structured process for documenting architectural decisions'
|
|
3
|
+
initial_state: context
|
|
4
|
+
|
|
5
|
+
metadata:
|
|
6
|
+
domain: 'architecture'
|
|
7
|
+
complexity: 'medium'
|
|
8
|
+
bestFor:
|
|
9
|
+
- 'Documenting architectural decisions'
|
|
10
|
+
- 'Recording design choices'
|
|
11
|
+
- 'Technology selection decisions'
|
|
12
|
+
- 'System design decisions'
|
|
13
|
+
useCases:
|
|
14
|
+
- 'Choosing between architectural patterns'
|
|
15
|
+
- 'Selecting technology stack components'
|
|
16
|
+
- 'Documenting design trade-offs'
|
|
17
|
+
examples:
|
|
18
|
+
- 'Document database selection decision'
|
|
19
|
+
- 'Record API design approach'
|
|
20
|
+
- 'Document deployment strategy choice'
|
|
21
|
+
|
|
22
|
+
states:
|
|
23
|
+
context:
|
|
24
|
+
description: 'Define the architectural problem or decision that needs to be made'
|
|
25
|
+
default_instructions: |
|
|
26
|
+
You are starting an Architecture Decision Record (ADR) workflow.
|
|
27
|
+
|
|
28
|
+
**Your tasks:**
|
|
29
|
+
1. Check if $ARCHITECTURE_DOC exists to determine ADR storage location
|
|
30
|
+
2. Look for existing ADRs to understand current format/numbering
|
|
31
|
+
3. Help user clearly define the architectural problem or decision needed
|
|
32
|
+
4. Identify key stakeholders who should be involved
|
|
33
|
+
5. Document the context and problem statement
|
|
34
|
+
6. Create initial ADR structure using existing format or template above
|
|
35
|
+
|
|
36
|
+
Focus on understanding WHAT decision needs to be made and WHY it's important.
|
|
37
|
+
Don't evaluate technical options or make the decision yet - that happens in the decide phase.
|
|
38
|
+
|
|
39
|
+
additional_instructions: |
|
|
40
|
+
**ADR Template (use if no existing ADRs found):**
|
|
41
|
+
```
|
|
42
|
+
# ADR-XXX: [Decision Title]
|
|
43
|
+
|
|
44
|
+
## Status
|
|
45
|
+
Proposed
|
|
46
|
+
|
|
47
|
+
## Context
|
|
48
|
+
[Describe the architectural problem or decision that needs to be made]
|
|
49
|
+
|
|
50
|
+
## Decision
|
|
51
|
+
[The decision that was made - to be filled in decide phase]
|
|
52
|
+
|
|
53
|
+
## Consequences
|
|
54
|
+
### Positive
|
|
55
|
+
- [Benefits of this decision]
|
|
56
|
+
|
|
57
|
+
### Negative
|
|
58
|
+
- [Drawbacks or risks of this decision]
|
|
59
|
+
|
|
60
|
+
## Alternatives Considered
|
|
61
|
+
- [Other options that were evaluated]
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
transitions:
|
|
65
|
+
- trigger: context_complete
|
|
66
|
+
to: research
|
|
67
|
+
transition_reason: 'Architectural problem clearly defined, ready to research options'
|
|
68
|
+
|
|
69
|
+
research:
|
|
70
|
+
description: 'Investigate options, gather information, and analyze alternatives'
|
|
71
|
+
default_instructions: |
|
|
72
|
+
You are in the research phase for the ADR.
|
|
73
|
+
|
|
74
|
+
**Your tasks:**
|
|
75
|
+
1. Research available options and alternatives for the decision
|
|
76
|
+
2. Gather technical information, constraints, and requirements
|
|
77
|
+
3. Analyze trade-offs between different approaches
|
|
78
|
+
4. Consider non-functional requirements (performance, security, maintainability)
|
|
79
|
+
5. Document findings in the "Alternatives Considered" section
|
|
80
|
+
6. Identify pros and cons for each option
|
|
81
|
+
|
|
82
|
+
Work with the user to thoroughly understand all viable options before making a decision.
|
|
83
|
+
Update the ADR with research findings but don't make the final decision yet.
|
|
84
|
+
|
|
85
|
+
transitions:
|
|
86
|
+
- trigger: research_complete
|
|
87
|
+
to: decide
|
|
88
|
+
transition_reason: 'Research completed, ready to make architectural decision'
|
|
89
|
+
|
|
90
|
+
decide:
|
|
91
|
+
description: 'Make the architectural decision and document the rationale'
|
|
92
|
+
default_instructions: |
|
|
93
|
+
You are in the decide phase for the ADR.
|
|
94
|
+
|
|
95
|
+
**Your tasks:**
|
|
96
|
+
1. Help user make the final architectural decision based on research
|
|
97
|
+
2. Document the chosen option in the "Decision" section
|
|
98
|
+
3. Provide clear rationale for why this option was selected
|
|
99
|
+
4. Document positive consequences (benefits) of the decision
|
|
100
|
+
5. Document negative consequences (drawbacks/risks) of the decision
|
|
101
|
+
6. Ensure the decision is specific and actionable
|
|
102
|
+
7. Update ADR status to "Accepted" (or "Proposed" if needs approval)
|
|
103
|
+
|
|
104
|
+
Focus on making a clear, well-reasoned decision with documented rationale.
|
|
105
|
+
The decision should be based on the research conducted in the previous phase.
|
|
106
|
+
|
|
107
|
+
transitions:
|
|
108
|
+
- trigger: decision_complete
|
|
109
|
+
to: commit
|
|
110
|
+
transition_reason: 'Decision made and documented, ready for finalization'
|
|
111
|
+
review_perspectives:
|
|
112
|
+
- perspective: 'architect'
|
|
113
|
+
prompt: 'Review the ADR for architectural soundness, completeness, and alignment with system design principles. Ensure the decision is well-reasoned and consequences are thoroughly documented.'
|
|
114
|
+
- perspective: 'stakeholder'
|
|
115
|
+
prompt: 'Review the ADR from a business/project perspective. Ensure the decision addresses stakeholder needs, considers business impact, and is clearly communicated.'
|
|
116
|
+
- perspective: 'implementer'
|
|
117
|
+
prompt: 'Review the ADR from an implementation perspective. Ensure the decision is practical, actionable, and considers development/operational implications.'
|
|
118
|
+
|
|
119
|
+
commit:
|
|
120
|
+
description: 'Finalize the ADR with validation and cleanup'
|
|
121
|
+
default_instructions: |
|
|
122
|
+
You are in the commit phase for the ADR.
|
|
123
|
+
|
|
124
|
+
**Your tasks:**
|
|
125
|
+
1. Review ADR completeness and quality
|
|
126
|
+
2. Ensure proper formatting and structure
|
|
127
|
+
3. Verify all sections are filled appropriately
|
|
128
|
+
4. Check that consequences (positive and negative) are documented
|
|
129
|
+
5. Ensure alternatives considered are listed
|
|
130
|
+
6. Finalize ADR numbering if needed
|
|
131
|
+
7. Update ADR status to final state (Accepted/Approved)
|
|
132
|
+
8. Save/integrate ADR into $ARCHITECTURE_DOC or appropriate location
|
|
133
|
+
|
|
134
|
+
This is the final validation and cleanup phase before the ADR is complete.
|
|
135
|
+
|
|
136
|
+
transitions:
|
|
137
|
+
- trigger: need_decision_changes
|
|
138
|
+
to: decide
|
|
139
|
+
transition_reason: 'Final review found problems with the decision documentation'
|