superkit-mcp-server 1.2.1 → 1.2.3
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/ARCHITECTURE.md +102 -102
- package/README.md +71 -71
- package/SUPERKIT.md +168 -168
- package/agents/code-archaeologist.md +106 -106
- package/agents/coder.md +90 -90
- package/agents/data-engineer.md +28 -28
- package/agents/devops-engineer.md +242 -242
- package/agents/git-manager.md +203 -203
- package/agents/orchestrator.md +420 -420
- package/agents/penetration-tester.md +188 -188
- package/agents/performance-optimizer.md +187 -187
- package/agents/planner.md +270 -270
- package/agents/qa-automation-engineer.md +103 -103
- package/agents/quant-developer.md +32 -32
- package/agents/reviewer.md +100 -100
- package/agents/scout.md +222 -222
- package/agents/security-auditor.md +3 -2
- package/agents/tester.md +274 -274
- package/agents/ui-designer.md +208 -208
- package/build/index.js +21 -2
- package/build/tools/__tests__/loggerTools.test.js +5 -5
- package/build/tools/archTools.js +2 -19
- package/build/tools/autoPreview.js +2 -2
- package/build/tools/compoundTools.js +4 -4
- package/build/tools/docsTools.js +5 -10
- package/build/tools/loggerTools.js +1 -1
- package/build/tools/todoTools.js +39 -39
- package/build/tools/validators/__tests__/apiSchema.test.js +23 -23
- package/build/tools/validators/__tests__/convertRules.test.js +5 -5
- package/build/tools/validators/__tests__/frontendDesign.test.js +12 -12
- package/build/tools/validators/__tests__/geoChecker.test.js +19 -19
- package/build/tools/validators/__tests__/mobileAudit.test.js +12 -12
- package/build/tools/validators/__tests__/reactPerformanceChecker.test.js +17 -17
- package/build/tools/validators/__tests__/securityScan.test.js +6 -6
- package/build/tools/validators/__tests__/seoChecker.test.js +16 -16
- package/build/tools/validators/__tests__/typeCoverage.test.js +14 -14
- package/build/tools/validators/convertRules.js +2 -2
- package/commands/README.md +122 -122
- package/commands/ask.toml +72 -72
- package/commands/brainstorm.toml +119 -119
- package/commands/chat.toml +77 -77
- package/commands/code-preview.toml +37 -37
- package/commands/code.toml +28 -28
- package/commands/content.toml +200 -200
- package/commands/cook.toml +77 -77
- package/commands/copywrite.toml +131 -131
- package/commands/db.toml +192 -192
- package/commands/debug.toml +166 -166
- package/commands/design.toml +158 -158
- package/commands/dev-rules.toml +14 -14
- package/commands/do.toml +117 -117
- package/commands/doc-rules.toml +14 -14
- package/commands/docs.toml +148 -148
- package/commands/fix.toml +440 -440
- package/commands/fullstack.toml +175 -175
- package/commands/git.toml +235 -235
- package/commands/help.toml +84 -84
- package/commands/integrate.toml +127 -127
- package/commands/journal.toml +136 -136
- package/commands/kit-setup.toml +40 -40
- package/commands/mcp.toml +183 -183
- package/commands/orchestration.toml +15 -15
- package/commands/plan.toml +171 -171
- package/commands/pm.toml +148 -148
- package/commands/pr.toml +50 -50
- package/commands/project.toml +32 -32
- package/commands/research.toml +117 -117
- package/commands/review-pr.toml +63 -63
- package/commands/review.toml +190 -190
- package/commands/scout-ext.toml +97 -97
- package/commands/scout.toml +79 -79
- package/commands/screenshot.toml +65 -65
- package/commands/session.toml +102 -102
- package/commands/skill.toml +384 -384
- package/commands/status.toml +22 -22
- package/commands/team.toml +56 -56
- package/commands/test.toml +164 -164
- package/commands/ticket.toml +70 -70
- package/commands/use.toml +106 -106
- package/commands/video.toml +83 -83
- package/commands/watzup.toml +71 -71
- package/commands/workflow.toml +14 -14
- package/package.json +35 -35
- package/skills/meta/README.md +30 -30
- package/skills/meta/api-design/SKILL.md +134 -134
- package/skills/meta/code-review/SKILL.md +44 -44
- package/skills/meta/code-review/checklists/pre-merge.md +25 -25
- package/skills/meta/code-review/workflows/architecture-pass.md +26 -26
- package/skills/meta/code-review/workflows/performance-pass.md +27 -27
- package/skills/meta/code-review/workflows/security-pass.md +29 -29
- package/skills/meta/compound-docs/SKILL.md +133 -133
- package/skills/meta/debug/SKILL.md +40 -40
- package/skills/meta/debug/templates/bug-report.template.md +31 -31
- package/skills/meta/debug/workflows/reproduce-issue.md +20 -20
- package/skills/meta/docker/SKILL.md +126 -126
- package/skills/meta/examples/supabase/SKILL.md +46 -46
- package/skills/meta/examples/supabase/references/best-practices.md +319 -319
- package/skills/meta/examples/supabase/references/common-patterns.md +373 -373
- package/skills/meta/examples/supabase/templates/migration-template.sql +49 -49
- package/skills/meta/examples/supabase/templates/rls-policy-template.sql +77 -77
- package/skills/meta/examples/supabase/workflows/debugging.md +260 -260
- package/skills/meta/examples/supabase/workflows/migration-workflow.md +211 -211
- package/skills/meta/examples/supabase/workflows/rls-policies.md +244 -244
- package/skills/meta/examples/supabase/workflows/schema-design.md +321 -321
- package/skills/meta/file-todos/SKILL.md +88 -88
- package/skills/meta/mobile/SKILL.md +140 -140
- package/skills/meta/nextjs/SKILL.md +101 -101
- package/skills/meta/performance/SKILL.md +130 -130
- package/skills/meta/react-patterns/SKILL.md +83 -83
- package/skills/meta/security/SKILL.md +114 -114
- package/skills/meta/session-resume/SKILL.md +96 -96
- package/skills/meta/tailwind/SKILL.md +139 -139
- package/skills/meta/testing/SKILL.md +43 -43
- package/skills/meta/testing/references/vitest-patterns.md +45 -45
- package/skills/meta/testing/templates/component-test.template.tsx +37 -37
- package/skills/tech/alpha-vantage/SKILL.md +142 -142
- package/skills/tech/alpha-vantage/references/commodities.md +153 -153
- package/skills/tech/alpha-vantage/references/economic-indicators.md +158 -158
- package/skills/tech/alpha-vantage/references/forex-crypto.md +154 -154
- package/skills/tech/alpha-vantage/references/fundamentals.md +223 -223
- package/skills/tech/alpha-vantage/references/intelligence.md +138 -138
- package/skills/tech/alpha-vantage/references/options.md +93 -93
- package/skills/tech/alpha-vantage/references/technical-indicators.md +374 -374
- package/skills/tech/alpha-vantage/references/time-series.md +157 -157
- package/skills/tech/doc.md +6 -6
- package/skills/tech/financial-modeling/SKILL.md +18 -18
- package/skills/tech/financial-modeling/skills/3-statements/SKILL.md +368 -368
- package/skills/tech/financial-modeling/skills/3-statements/references/formatting.md +118 -118
- package/skills/tech/financial-modeling/skills/3-statements/references/formulas.md +292 -292
- package/skills/tech/financial-modeling/skills/3-statements/references/sec-filings.md +125 -125
- package/skills/tech/financial-modeling/skills/dcf-model/SKILL.md +1210 -1210
- package/skills/tech/financial-modeling/skills/dcf-model/TROUBLESHOOTING.md +40 -40
- package/skills/tech/financial-modeling/skills/dcf-model/requirements.txt +8 -8
- package/skills/tech/financial-modeling/skills/dcf-model/scripts/validate_dcf.py +292 -292
- package/skills/tech/financial-modeling/skills/lbo-model/SKILL.md +236 -236
- package/skills/tech/financial-modeling/skills/merger-model/SKILL.md +108 -108
- package/skills/workflows/README.md +203 -203
- package/skills/workflows/adr.md +174 -174
- package/skills/workflows/changelog.md +74 -74
- package/skills/workflows/compound.md +323 -323
- package/skills/workflows/compound_health.md +74 -74
- package/skills/workflows/create-agent-skill.md +138 -139
- package/skills/workflows/cycle.md +144 -144
- package/skills/workflows/deploy-docs.md +84 -84
- package/skills/workflows/development-rules.md +42 -42
- package/skills/workflows/doc.md +95 -95
- package/skills/workflows/documentation-management.md +34 -34
- package/skills/workflows/explore.md +146 -146
- package/skills/workflows/generate_command.md +106 -106
- package/skills/workflows/heal-skill.md +97 -97
- package/skills/workflows/housekeeping.md +229 -229
- package/skills/workflows/kit-setup.md +102 -102
- package/skills/workflows/map-codebase.md +78 -78
- package/skills/workflows/orchestration-protocol.md +43 -43
- package/skills/workflows/plan-compound.md +439 -439
- package/skills/workflows/plan_review.md +269 -269
- package/skills/workflows/primary-workflow.md +37 -37
- package/skills/workflows/promote_pattern.md +86 -86
- package/skills/workflows/release-docs.md +82 -82
- package/skills/workflows/report-bug.md +135 -135
- package/skills/workflows/reproduce-bug.md +118 -118
- package/skills/workflows/resolve_pr.md +133 -133
- package/skills/workflows/resolve_todo.md +128 -128
- package/skills/workflows/review-compound.md +376 -376
- package/skills/workflows/skill-review.md +127 -127
- package/skills/workflows/specs.md +257 -257
- package/skills/workflows/triage-sprint.md +102 -102
- package/skills/workflows/triage.md +152 -152
- package/skills/workflows/work.md +399 -399
- package/skills/workflows/xcode-test.md +93 -93
|
@@ -1,257 +1,257 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Create and manage specifications for multi-session initiatives. Use before /plan for major work.
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# /specs - Multi-Session Initiative Management
|
|
6
|
-
|
|
7
|
-
Create and manage structured specifications for large, multi-session initiatives like refactors, new features, and rebranding.
|
|
8
|
-
|
|
9
|
-
> **Why specs?** Large work spans multiple agent sessions. Specs preserve context, track phases, and capture decisions so each session can resume effectively.
|
|
10
|
-
|
|
11
|
-
## When To Use
|
|
12
|
-
|
|
13
|
-
**Use /specs when:**
|
|
14
|
-
- Work spans multiple weeks
|
|
15
|
-
- Multiple phases with distinct deliverables
|
|
16
|
-
- Need to preserve context across agent sessions
|
|
17
|
-
- Large refactors, new features, or rebranding
|
|
18
|
-
|
|
19
|
-
**Use /plan instead when:**
|
|
20
|
-
- Work completes in a single session
|
|
21
|
-
- Scope is well-defined and bounded
|
|
22
|
-
- No phased rollout needed
|
|
23
|
-
|
|
24
|
-
---
|
|
25
|
-
|
|
26
|
-
## Workflow
|
|
27
|
-
|
|
28
|
-
### Step 0: Search Existing Solutions (MANDATORY)
|
|
29
|
-
|
|
30
|
-
> [!CAUTION]
|
|
31
|
-
> **BLOCKING STEP.** Before defining a new specification, verify we're not reinventing a solution that already exists in the knowledge base.
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
// turbo
|
|
35
|
-
Call MCP `call_tool_logger_manager` { action: "logWorkflow", name: "/specs", outcome: "success" }
|
|
36
|
-
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "{initiative keywords}"] }
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
**Output required:**
|
|
40
|
-
Copy the search output table into your spec's "01-requirements.md" or "02-design.md".
|
|
41
|
-
|
|
42
|
-
---
|
|
43
|
-
|
|
44
|
-
### Step 0.5: Check Existing Specs
|
|
45
|
-
|
|
46
|
-
Before creating a new spec, check if one already exists:
|
|
47
|
-
|
|
48
|
-
```bash
|
|
49
|
-
ls docs/specs/*/README.md 2>/dev/null
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
**If joining an active spec:**
|
|
53
|
-
1. Read `docs/specs/{name}/00-START-HERE.md` for context
|
|
54
|
-
2. Review current phase in `03-tasks.md`
|
|
55
|
-
3. Resume work from where it left off
|
|
56
|
-
|
|
57
|
-
**Only proceed to Step 1 if creating a NEW spec.**
|
|
58
|
-
|
|
59
|
-
### Step 1: Create Spec Directory
|
|
60
|
-
|
|
61
|
-
```bash
|
|
62
|
-
mkdir -p docs/specs/{name}/{VERIFICATION,plans}
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
Use lowercase-hyphenated names: `multi-tenant`, `auth-refactor`, `brand-update`
|
|
66
|
-
|
|
67
|
-
### Step 2: Copy and Customize Templates
|
|
68
|
-
|
|
69
|
-
Copy from `docs/specs/templates/`:
|
|
70
|
-
|
|
71
|
-
```bash
|
|
72
|
-
cp docs/specs/templates/README-template.md docs/specs/{name}/README.md
|
|
73
|
-
cp docs/specs/templates/00-START-HERE-template.md docs/specs/{name}/00-START-HERE.md
|
|
74
|
-
cp docs/specs/templates/01-requirements-template.md docs/specs/{name}/01-requirements.md
|
|
75
|
-
cp docs/specs/templates/02-design-template.md docs/specs/{name}/02-design.md # Optional for simple specs
|
|
76
|
-
cp docs/specs/templates/03-tasks-template.md docs/specs/{name}/03-tasks.md
|
|
77
|
-
cp docs/specs/templates/04-decisions-template.md docs/specs/{name}/04-decisions.md
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
### Step 3: Fill Core Documents
|
|
81
|
-
|
|
82
|
-
**Priority order:**
|
|
83
|
-
|
|
84
|
-
1. **README.md** - Fill status dashboard with current phase and progress
|
|
85
|
-
2. **01-requirements.md** - Define acceptance criteria for the initiative
|
|
86
|
-
3. **03-tasks.md** - Break work into phases with:
|
|
87
|
-
- Clear scope boundaries
|
|
88
|
-
- Exit criteria (how to know it's done)
|
|
89
|
-
- Estimated duration
|
|
90
|
-
- Dependencies on other phases
|
|
91
|
-
4. **00-START-HERE.md** - Summarize current state for future sessions
|
|
92
|
-
5. **04-decisions.md** - Initialize empty (populate as decisions are made)
|
|
93
|
-
|
|
94
|
-
### Step 3.5: Deep Analysis (Think Hard)
|
|
95
|
-
|
|
96
|
-
> [!IMPORTANT]
|
|
97
|
-
> Specs guide multi-week work. Invest heavily in upfront analysis to avoid costly mid-initiative pivots.
|
|
98
|
-
|
|
99
|
-
**Multi-Order Thinking:**
|
|
100
|
-
- [ ] **1st order:** What does this initiative directly change?
|
|
101
|
-
- [ ] **2nd order:** What systems/processes depend on those changes?
|
|
102
|
-
- [ ] **3rd order:** What cascading effects ripple outward?
|
|
103
|
-
- [ ] **4th order:** Could this affect unrelated areas through shared dependencies?
|
|
104
|
-
|
|
105
|
-
**Long-Term Implications:**
|
|
106
|
-
- [ ] How will this age in 6 months? 1 year?
|
|
107
|
-
- [ ] Does this reduce or create technical debt?
|
|
108
|
-
- [ ] Is this reversible if assumptions prove wrong?
|
|
109
|
-
|
|
110
|
-
**Edge Cases (Leave No Stone Unturned):**
|
|
111
|
-
- [ ] Boundary conditions and failure modes
|
|
112
|
-
- [ ] Concurrent access / race conditions
|
|
113
|
-
- [ ] Migration and rollback scenarios
|
|
114
|
-
|
|
115
|
-
**Stakeholder Impact Analysis:**
|
|
116
|
-
- [ ] **End Users:** Behavior changes? Learning curve?
|
|
117
|
-
- [ ] **Other Developers:** Breaking changes? Documentation?
|
|
118
|
-
- [ ] **Operations/Support:** New failure modes? Runbooks?
|
|
119
|
-
- [ ] **Downstream Systems:** Integration impacts?
|
|
120
|
-
- [ ] **Business Stakeholders:** Timeline/resource implications?
|
|
121
|
-
|
|
122
|
-
### Step 4: Create Decision Records
|
|
123
|
-
|
|
124
|
-
**For spec-scoped decisions:** Add to `04-decisions.md` (temporary during spec)
|
|
125
|
-
|
|
126
|
-
**For project-wide decisions:** Create in `docs/decisions/`
|
|
127
|
-
- Technology choices that outlive the spec
|
|
128
|
-
- Patterns that become project standards
|
|
129
|
-
- Decisions other specs should follow
|
|
130
|
-
|
|
131
|
-
**Migration:** When spec completes, promote relevant decisions from `04-decisions.md`
|
|
132
|
-
to `docs/decisions/` if they have project-wide applicability.
|
|
133
|
-
|
|
134
|
-
### Step 5: Create Phase 1 Plan
|
|
135
|
-
|
|
136
|
-
Run `/plan` for the first phase:
|
|
137
|
-
|
|
138
|
-
- Create plan in `docs/specs/{name}/plans/phase1-{description}.md`
|
|
139
|
-
- Link back to parent spec in plan header
|
|
140
|
-
- Reference phase from `03-tasks.md`
|
|
141
|
-
|
|
142
|
-
### Step 6: Offer Next Steps
|
|
143
|
-
|
|
144
|
-
```
|
|
145
|
-
✓ Spec created: docs/specs/{name}/
|
|
146
|
-
|
|
147
|
-
What's next?
|
|
148
|
-
1. Start Phase 1 - Run /plan for first phase
|
|
149
|
-
2. Review spec - Ask for feedback on structure
|
|
150
|
-
3. Share spec - Let team know about the initiative
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
---
|
|
154
|
-
|
|
155
|
-
## Phase Transitions
|
|
156
|
-
|
|
157
|
-
When completing a phase:
|
|
158
|
-
|
|
159
|
-
1. **Update 03-tasks.md** - Mark phase tasks complete
|
|
160
|
-
2. **Automate Summary Updates** (MANDATORY):
|
|
161
|
-
```bash
|
|
162
|
-
// turbo
|
|
163
|
-
Call MCP `call_tool_arch_manager` { action: "updatePhase", specName: "{spec_name}", phaseNum: "{phase_num}", status: "complete" }
|
|
164
|
-
```
|
|
165
|
-
*This atomically updates README.md, START-HERE.md, and 03-tasks.md summary table.*
|
|
166
|
-
3. **Run /plan** for next phase
|
|
167
|
-
```bash
|
|
168
|
-
// turbo
|
|
169
|
-
Call MCP `call_tool_arch_manager` { action: "updatePhase", specName: "{spec_name}", phaseNum: "{next_phase_num}", status: "started" }
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
---
|
|
173
|
-
|
|
174
|
-
## Decision Logging
|
|
175
|
-
|
|
176
|
-
When making architectural decisions during implementation:
|
|
177
|
-
|
|
178
|
-
1. **Add to 04-decisions.md** using ADR format
|
|
179
|
-
2. **Scope strictly:**
|
|
180
|
-
- ✅ Technology choices (GraphQL vs REST)
|
|
181
|
-
- ✅ Patterns (Strangler Fig for migration)
|
|
182
|
-
- ✅ Trade-offs (speed vs completeness)
|
|
183
|
-
- ❌ Bug fixes
|
|
184
|
-
- ❌ Implementation details
|
|
185
|
-
- ❌ Routine choices
|
|
186
|
-
|
|
187
|
-
3. **Consider pattern promotion:**
|
|
188
|
-
```bash
|
|
189
|
-
# If similar decisions made 3+ times
|
|
190
|
-
grep -l "{pattern}" docs/specs/*/04-decisions.md | wc -l
|
|
191
|
-
```
|
|
192
|
-
If count ≥ 3, run `/compound` to promote to critical pattern.
|
|
193
|
-
|
|
194
|
-
---
|
|
195
|
-
|
|
196
|
-
## Context Restoration Protocol
|
|
197
|
-
|
|
198
|
-
Every new session should check for active specs:
|
|
199
|
-
|
|
200
|
-
```bash
|
|
201
|
-
# Check for active specs
|
|
202
|
-
active_spec=$(ls -d docs/specs/*/ 2>/dev/null | grep -v templates | head -1)
|
|
203
|
-
if [ -n "$active_spec" ]; then
|
|
204
|
-
echo "Active spec: $active_spec"
|
|
205
|
-
cat "${active_spec}00-START-HERE.md"
|
|
206
|
-
fi
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
This is built into `/plan` Step 0.5 and main AGENT.md (GEMINI.md, CLAUDE.md) agent behavior.
|
|
210
|
-
|
|
211
|
-
---
|
|
212
|
-
|
|
213
|
-
## Quality Guidelines
|
|
214
|
-
|
|
215
|
-
**Good specs have:**
|
|
216
|
-
- ✅ Clear phase boundaries with exit criteria
|
|
217
|
-
- ✅ Acceptance criteria for each requirement
|
|
218
|
-
- ✅ Decisions documented with alternatives
|
|
219
|
-
- ✅ START-HERE that restores context in 2 minutes
|
|
220
|
-
|
|
221
|
-
**Avoid:**
|
|
222
|
-
- ❌ Phases without exit criteria
|
|
223
|
-
- ❌ Vague requirements without acceptance criteria
|
|
224
|
-
- ❌ Decisions without alternatives considered
|
|
225
|
-
- ❌ Stale START-HERE that doesn't reflect current state
|
|
226
|
-
|
|
227
|
-
### Phase 5: Completion & Handoff
|
|
228
|
-
|
|
229
|
-
#### Step 1: Establish Terminal UI State
|
|
230
|
-
|
|
231
|
-
```javascript
|
|
232
|
-
await task_boundary({
|
|
233
|
-
TaskName: "[COMPLETED] Spec Management",
|
|
234
|
-
TaskStatus: "Spec updated. Offering next steps.",
|
|
235
|
-
Mode: "VERIFICATION",
|
|
236
|
-
TaskSummary: "Managed spec {name}. Current phase: {phase}. Status: {status}."
|
|
237
|
-
});
|
|
238
|
-
```
|
|
239
|
-
|
|
240
|
-
#### Step 2: Mandatory Handoff
|
|
241
|
-
|
|
242
|
-
```bash
|
|
243
|
-
✓ Spec managed: docs/specs/{name}/
|
|
244
|
-
|
|
245
|
-
Next steps:
|
|
246
|
-
1. /plan - Create plan for next phase
|
|
247
|
-
2. /work - Execute current phase items
|
|
248
|
-
```
|
|
249
|
-
|
|
250
|
-
---
|
|
251
|
-
|
|
252
|
-
## References
|
|
253
|
-
|
|
254
|
-
- Templates: `docs/specs/templates/`
|
|
255
|
-
- Create phase plans: `/plan`
|
|
256
|
-
- Execute phase work: `/work`
|
|
257
|
-
- Record solutions: `/compound`
|
|
1
|
+
---
|
|
2
|
+
description: Create and manage specifications for multi-session initiatives. Use before /plan for major work.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# /specs - Multi-Session Initiative Management
|
|
6
|
+
|
|
7
|
+
Create and manage structured specifications for large, multi-session initiatives like refactors, new features, and rebranding.
|
|
8
|
+
|
|
9
|
+
> **Why specs?** Large work spans multiple agent sessions. Specs preserve context, track phases, and capture decisions so each session can resume effectively.
|
|
10
|
+
|
|
11
|
+
## When To Use
|
|
12
|
+
|
|
13
|
+
**Use /specs when:**
|
|
14
|
+
- Work spans multiple weeks
|
|
15
|
+
- Multiple phases with distinct deliverables
|
|
16
|
+
- Need to preserve context across agent sessions
|
|
17
|
+
- Large refactors, new features, or rebranding
|
|
18
|
+
|
|
19
|
+
**Use /plan instead when:**
|
|
20
|
+
- Work completes in a single session
|
|
21
|
+
- Scope is well-defined and bounded
|
|
22
|
+
- No phased rollout needed
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Workflow
|
|
27
|
+
|
|
28
|
+
### Step 0: Search Existing Solutions (MANDATORY)
|
|
29
|
+
|
|
30
|
+
> [!CAUTION]
|
|
31
|
+
> **BLOCKING STEP.** Before defining a new specification, verify we're not reinventing a solution that already exists in the knowledge base.
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
// turbo
|
|
35
|
+
Call MCP `call_tool_logger_manager` { action: "logWorkflow", name: "/specs", outcome: "success" }
|
|
36
|
+
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "{initiative keywords}"] }
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Output required:**
|
|
40
|
+
Copy the search output table into your spec's "01-requirements.md" or "02-design.md".
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
### Step 0.5: Check Existing Specs
|
|
45
|
+
|
|
46
|
+
Before creating a new spec, check if one already exists:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
ls docs/specs/*/README.md 2>/dev/null
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
**If joining an active spec:**
|
|
53
|
+
1. Read `docs/specs/{name}/00-START-HERE.md` for context
|
|
54
|
+
2. Review current phase in `03-tasks.md`
|
|
55
|
+
3. Resume work from where it left off
|
|
56
|
+
|
|
57
|
+
**Only proceed to Step 1 if creating a NEW spec.**
|
|
58
|
+
|
|
59
|
+
### Step 1: Create Spec Directory
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
mkdir -p docs/specs/{name}/{VERIFICATION,plans}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Use lowercase-hyphenated names: `multi-tenant`, `auth-refactor`, `brand-update`
|
|
66
|
+
|
|
67
|
+
### Step 2: Copy and Customize Templates
|
|
68
|
+
|
|
69
|
+
Copy from `docs/specs/templates/`:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
cp docs/specs/templates/README-template.md docs/specs/{name}/README.md
|
|
73
|
+
cp docs/specs/templates/00-START-HERE-template.md docs/specs/{name}/00-START-HERE.md
|
|
74
|
+
cp docs/specs/templates/01-requirements-template.md docs/specs/{name}/01-requirements.md
|
|
75
|
+
cp docs/specs/templates/02-design-template.md docs/specs/{name}/02-design.md # Optional for simple specs
|
|
76
|
+
cp docs/specs/templates/03-tasks-template.md docs/specs/{name}/03-tasks.md
|
|
77
|
+
cp docs/specs/templates/04-decisions-template.md docs/specs/{name}/04-decisions.md
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Step 3: Fill Core Documents
|
|
81
|
+
|
|
82
|
+
**Priority order:**
|
|
83
|
+
|
|
84
|
+
1. **README.md** - Fill status dashboard with current phase and progress
|
|
85
|
+
2. **01-requirements.md** - Define acceptance criteria for the initiative
|
|
86
|
+
3. **03-tasks.md** - Break work into phases with:
|
|
87
|
+
- Clear scope boundaries
|
|
88
|
+
- Exit criteria (how to know it's done)
|
|
89
|
+
- Estimated duration
|
|
90
|
+
- Dependencies on other phases
|
|
91
|
+
4. **00-START-HERE.md** - Summarize current state for future sessions
|
|
92
|
+
5. **04-decisions.md** - Initialize empty (populate as decisions are made)
|
|
93
|
+
|
|
94
|
+
### Step 3.5: Deep Analysis (Think Hard)
|
|
95
|
+
|
|
96
|
+
> [!IMPORTANT]
|
|
97
|
+
> Specs guide multi-week work. Invest heavily in upfront analysis to avoid costly mid-initiative pivots.
|
|
98
|
+
|
|
99
|
+
**Multi-Order Thinking:**
|
|
100
|
+
- [ ] **1st order:** What does this initiative directly change?
|
|
101
|
+
- [ ] **2nd order:** What systems/processes depend on those changes?
|
|
102
|
+
- [ ] **3rd order:** What cascading effects ripple outward?
|
|
103
|
+
- [ ] **4th order:** Could this affect unrelated areas through shared dependencies?
|
|
104
|
+
|
|
105
|
+
**Long-Term Implications:**
|
|
106
|
+
- [ ] How will this age in 6 months? 1 year?
|
|
107
|
+
- [ ] Does this reduce or create technical debt?
|
|
108
|
+
- [ ] Is this reversible if assumptions prove wrong?
|
|
109
|
+
|
|
110
|
+
**Edge Cases (Leave No Stone Unturned):**
|
|
111
|
+
- [ ] Boundary conditions and failure modes
|
|
112
|
+
- [ ] Concurrent access / race conditions
|
|
113
|
+
- [ ] Migration and rollback scenarios
|
|
114
|
+
|
|
115
|
+
**Stakeholder Impact Analysis:**
|
|
116
|
+
- [ ] **End Users:** Behavior changes? Learning curve?
|
|
117
|
+
- [ ] **Other Developers:** Breaking changes? Documentation?
|
|
118
|
+
- [ ] **Operations/Support:** New failure modes? Runbooks?
|
|
119
|
+
- [ ] **Downstream Systems:** Integration impacts?
|
|
120
|
+
- [ ] **Business Stakeholders:** Timeline/resource implications?
|
|
121
|
+
|
|
122
|
+
### Step 4: Create Decision Records
|
|
123
|
+
|
|
124
|
+
**For spec-scoped decisions:** Add to `04-decisions.md` (temporary during spec)
|
|
125
|
+
|
|
126
|
+
**For project-wide decisions:** Create in `docs/decisions/`
|
|
127
|
+
- Technology choices that outlive the spec
|
|
128
|
+
- Patterns that become project standards
|
|
129
|
+
- Decisions other specs should follow
|
|
130
|
+
|
|
131
|
+
**Migration:** When spec completes, promote relevant decisions from `04-decisions.md`
|
|
132
|
+
to `docs/decisions/` if they have project-wide applicability.
|
|
133
|
+
|
|
134
|
+
### Step 5: Create Phase 1 Plan
|
|
135
|
+
|
|
136
|
+
Run `/plan` for the first phase:
|
|
137
|
+
|
|
138
|
+
- Create plan in `docs/specs/{name}/plans/phase1-{description}.md`
|
|
139
|
+
- Link back to parent spec in plan header
|
|
140
|
+
- Reference phase from `03-tasks.md`
|
|
141
|
+
|
|
142
|
+
### Step 6: Offer Next Steps
|
|
143
|
+
|
|
144
|
+
```
|
|
145
|
+
✓ Spec created: docs/specs/{name}/
|
|
146
|
+
|
|
147
|
+
What's next?
|
|
148
|
+
1. Start Phase 1 - Run /plan for first phase
|
|
149
|
+
2. Review spec - Ask for feedback on structure
|
|
150
|
+
3. Share spec - Let team know about the initiative
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
## Phase Transitions
|
|
156
|
+
|
|
157
|
+
When completing a phase:
|
|
158
|
+
|
|
159
|
+
1. **Update 03-tasks.md** - Mark phase tasks complete
|
|
160
|
+
2. **Automate Summary Updates** (MANDATORY):
|
|
161
|
+
```bash
|
|
162
|
+
// turbo
|
|
163
|
+
Call MCP `call_tool_arch_manager` { action: "updatePhase", specName: "{spec_name}", phaseNum: "{phase_num}", status: "complete" }
|
|
164
|
+
```
|
|
165
|
+
*This atomically updates README.md, START-HERE.md, and 03-tasks.md summary table.*
|
|
166
|
+
3. **Run /plan** for next phase
|
|
167
|
+
```bash
|
|
168
|
+
// turbo
|
|
169
|
+
Call MCP `call_tool_arch_manager` { action: "updatePhase", specName: "{spec_name}", phaseNum: "{next_phase_num}", status: "started" }
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## Decision Logging
|
|
175
|
+
|
|
176
|
+
When making architectural decisions during implementation:
|
|
177
|
+
|
|
178
|
+
1. **Add to 04-decisions.md** using ADR format
|
|
179
|
+
2. **Scope strictly:**
|
|
180
|
+
- ✅ Technology choices (GraphQL vs REST)
|
|
181
|
+
- ✅ Patterns (Strangler Fig for migration)
|
|
182
|
+
- ✅ Trade-offs (speed vs completeness)
|
|
183
|
+
- ❌ Bug fixes
|
|
184
|
+
- ❌ Implementation details
|
|
185
|
+
- ❌ Routine choices
|
|
186
|
+
|
|
187
|
+
3. **Consider pattern promotion:**
|
|
188
|
+
```bash
|
|
189
|
+
# If similar decisions made 3+ times
|
|
190
|
+
grep -l "{pattern}" docs/specs/*/04-decisions.md | wc -l
|
|
191
|
+
```
|
|
192
|
+
If count ≥ 3, run `/compound` to promote to critical pattern.
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
## Context Restoration Protocol
|
|
197
|
+
|
|
198
|
+
Every new session should check for active specs:
|
|
199
|
+
|
|
200
|
+
```bash
|
|
201
|
+
# Check for active specs
|
|
202
|
+
active_spec=$(ls -d docs/specs/*/ 2>/dev/null | grep -v templates | head -1)
|
|
203
|
+
if [ -n "$active_spec" ]; then
|
|
204
|
+
echo "Active spec: $active_spec"
|
|
205
|
+
cat "${active_spec}00-START-HERE.md"
|
|
206
|
+
fi
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
This is built into `/plan` Step 0.5 and main AGENT.md (GEMINI.md, CLAUDE.md) agent behavior.
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## Quality Guidelines
|
|
214
|
+
|
|
215
|
+
**Good specs have:**
|
|
216
|
+
- ✅ Clear phase boundaries with exit criteria
|
|
217
|
+
- ✅ Acceptance criteria for each requirement
|
|
218
|
+
- ✅ Decisions documented with alternatives
|
|
219
|
+
- ✅ START-HERE that restores context in 2 minutes
|
|
220
|
+
|
|
221
|
+
**Avoid:**
|
|
222
|
+
- ❌ Phases without exit criteria
|
|
223
|
+
- ❌ Vague requirements without acceptance criteria
|
|
224
|
+
- ❌ Decisions without alternatives considered
|
|
225
|
+
- ❌ Stale START-HERE that doesn't reflect current state
|
|
226
|
+
|
|
227
|
+
### Phase 5: Completion & Handoff
|
|
228
|
+
|
|
229
|
+
#### Step 1: Establish Terminal UI State
|
|
230
|
+
|
|
231
|
+
```javascript
|
|
232
|
+
await task_boundary({
|
|
233
|
+
TaskName: "[COMPLETED] Spec Management",
|
|
234
|
+
TaskStatus: "Spec updated. Offering next steps.",
|
|
235
|
+
Mode: "VERIFICATION",
|
|
236
|
+
TaskSummary: "Managed spec {name}. Current phase: {phase}. Status: {status}."
|
|
237
|
+
});
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
#### Step 2: Mandatory Handoff
|
|
241
|
+
|
|
242
|
+
```bash
|
|
243
|
+
✓ Spec managed: docs/specs/{name}/
|
|
244
|
+
|
|
245
|
+
Next steps:
|
|
246
|
+
1. /plan - Create plan for next phase
|
|
247
|
+
2. /work - Execute current phase items
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
---
|
|
251
|
+
|
|
252
|
+
## References
|
|
253
|
+
|
|
254
|
+
- Templates: `docs/specs/templates/`
|
|
255
|
+
- Create phase plans: `/plan`
|
|
256
|
+
- Execute phase work: `/work`
|
|
257
|
+
- Record solutions: `/compound`
|