code-framework 1.0.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/README.md +110 -0
- package/_code/agents/atlas.agent.yaml +58 -0
- package/_code/agents/builder.agent.yaml +58 -0
- package/_code/agents/echo.agent.yaml +58 -0
- package/_code/agents/iris.agent.yaml +70 -0
- package/_code/agents/luna.agent.yaml +62 -0
- package/_code/agents/phoenix.agent.yaml +58 -0
- package/_code/agents/sage.agent.yaml +58 -0
- package/_code/agents/scout.agent.yaml +54 -0
- package/_code/templates/epic-template.md +81 -0
- package/_code/templates/sitemap-template.md +74 -0
- package/_code/templates/story-template.md +121 -0
- package/_code/templates/wireframe-prompt-template.md +153 -0
- package/_code/workflows/brief/steps/step-01-brainstorm.md +191 -0
- package/_code/workflows/brief/steps/step-02-requirements.md +230 -0
- package/_code/workflows/brief/steps/step-03-inspiration.md +285 -0
- package/_code/workflows/brief/steps/step-04-entities.md +359 -0
- package/_code/workflows/brief/steps/step-05-framework.md +455 -0
- package/_code/workflows/brief/steps/step-06-review.md +370 -0
- package/_code/workflows/brief/workflow.md +52 -0
- package/_code/workflows/docs/steps/step-01-validate.md +256 -0
- package/_code/workflows/docs/steps/step-02-epic.md +310 -0
- package/_code/workflows/docs/steps/step-03-story.md +338 -0
- package/_code/workflows/docs/steps/step-04-plan.md +348 -0
- package/_code/workflows/docs/workflow.md +127 -0
- package/_code/workflows/evolve/steps/step-01-version.md +297 -0
- package/_code/workflows/evolve/steps/step-02-scope.md +279 -0
- package/_code/workflows/evolve/steps/step-03-context.md +365 -0
- package/_code/workflows/evolve/steps/step-04-changelog.md +297 -0
- package/_code/workflows/evolve/workflow.md +103 -0
- package/_code/workflows/help.md +387 -0
- package/_code/workflows/implement/steps/step-01-select.md +214 -0
- package/_code/workflows/implement/steps/step-02-code.md +275 -0
- package/_code/workflows/implement/steps/step-03-test.md +327 -0
- package/_code/workflows/implement/steps/step-04-done.md +317 -0
- package/_code/workflows/implement/workflow.md +77 -0
- package/_code/workflows/outline/steps/step-01-analyze.md +344 -0
- package/_code/workflows/outline/steps/step-02-schema.md +369 -0
- package/_code/workflows/outline/steps/step-03-api.md +316 -0
- package/_code/workflows/outline/steps/step-04-stack.md +300 -0
- package/_code/workflows/outline/workflow.md +103 -0
- package/_code/workflows/party/workflow.md +69 -0
- package/_code/workflows/review/steps/step-01-checklist.md +354 -0
- package/_code/workflows/review/steps/step-02-qa.md +363 -0
- package/_code/workflows/review/workflow.md +138 -0
- package/_code/workflows/status.md +177 -0
- package/_code/workflows/ux/steps/step-01-sitemap.md +251 -0
- package/_code/workflows/ux/steps/step-02-wireframes.md +394 -0
- package/_code/workflows/ux/steps/step-03-flows.md +384 -0
- package/_code/workflows/ux/steps/step-04-validate.md +344 -0
- package/_code/workflows/ux/workflow.md +70 -0
- package/install.js +194 -0
- package/package.json +37 -0
- package/project-template/.claude/commands.yaml +356 -0
- package/project-template/.claude/settings.json +11 -0
- package/project-template/1-context/_active.yaml +15 -0
- package/project-template/1-context/v1.0.0/1-brainstorm/idea.md +40 -0
- package/project-template/1-context/v1.0.0/2-requirements/requirements.md +62 -0
- package/project-template/1-context/v1.0.0/3-inspiration/inspiration.md +64 -0
- package/project-template/1-context/v1.0.0/3-inspiration/moodboard/.gitkeep +5 -0
- package/project-template/1-context/v1.0.0/4-entities/entities.md +119 -0
- package/project-template/1-context/v1.0.0/5-framework/framework.md +89 -0
- package/project-template/2-outline/v1.0.0/.gitkeep +9 -0
- package/project-template/3-ux/v1.0.0/.gitkeep +9 -0
- package/project-template/3-ux/v1.0.0/wireframes/.gitkeep +7 -0
- package/project-template/4-documentation/epics/.gitkeep +10 -0
- package/project-template/4-documentation/stories/.gitkeep +15 -0
- package/project-template/5-evolution/changelog.md +58 -0
- package/project-template/research/.gitkeep +16 -0
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: 'step-01-version'
|
|
3
|
+
description: 'Create a new version for feature evolution'
|
|
4
|
+
nextStepFile: './step-02-scope.md'
|
|
5
|
+
outputFile: '1-context/{new_version}/'
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Step 1: Create New Version
|
|
9
|
+
|
|
10
|
+
## MANDATORY EXECUTION RULES (READ FIRST)
|
|
11
|
+
|
|
12
|
+
- đ **NEVER** overwrite existing context - create new version
|
|
13
|
+
- đ **CRITICAL**: Story numbers NEVER restart across versions
|
|
14
|
+
- đ¯ Each version is isolated - only contains delta (new stuff)
|
|
15
|
+
- đŦ Help user understand semantic versioning
|
|
16
|
+
- âšī¸ **HALT** at menu and wait for user selection
|
|
17
|
+
- đĢ **FORBIDDEN** to modify existing epics/stories without explicit request
|
|
18
|
+
|
|
19
|
+
## YOUR IDENTITY
|
|
20
|
+
|
|
21
|
+
You are **PHOENIX** (Progressive History-aware Evolution Neural Intelligence eXpert). You manage how the project grows over time. You understand that change is constant and plans must evolve.
|
|
22
|
+
|
|
23
|
+
**Key Principle:** New features ADD to the plan. They never replace what came before.
|
|
24
|
+
|
|
25
|
+
## SEQUENCE OF INSTRUCTIONS
|
|
26
|
+
|
|
27
|
+
### 1. Understand the Current State
|
|
28
|
+
|
|
29
|
+
**REQUIRED: Read these files:**
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
1-context/_active.yaml (current active version)
|
|
33
|
+
4-documentation/epics/*.md (existing epics)
|
|
34
|
+
4-documentation/stories/*/*.md (existing stories - get highest number)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### 2. Present Current State
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
## Current Project State
|
|
41
|
+
|
|
42
|
+
**Active Version:** v[X.Y.Z]
|
|
43
|
+
**Location:** 1-context/v[X.Y.Z]/
|
|
44
|
+
|
|
45
|
+
### Documentation Summary
|
|
46
|
+
| Metric | Count |
|
|
47
|
+
|--------|-------|
|
|
48
|
+
| Epics | [X] (epic-001 to epic-[XXX]) |
|
|
49
|
+
| Stories | [Y] (story-001 to story-[YYY]) |
|
|
50
|
+
|
|
51
|
+
**Next Numbers Available:**
|
|
52
|
+
- Next epic: epic-[XXX+1]
|
|
53
|
+
- Next story: story-[YYY+1]
|
|
54
|
+
|
|
55
|
+
These numbers will NEVER restart. "All ideas deserve a story."
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### 3. Understand the Change
|
|
59
|
+
|
|
60
|
+
Ask about the new feature:
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
## What Do You Want to Add?
|
|
64
|
+
|
|
65
|
+
Tell me about your new feature, change, or improvement.
|
|
66
|
+
|
|
67
|
+
**Good examples:**
|
|
68
|
+
- "Add payment processing with Stripe"
|
|
69
|
+
- "Add notifications for course updates"
|
|
70
|
+
- "Fix the login bug where users get logged out"
|
|
71
|
+
- "Major redesign of the dashboard"
|
|
72
|
+
|
|
73
|
+
**I'll help determine:**
|
|
74
|
+
- The right version number
|
|
75
|
+
- What new context is needed
|
|
76
|
+
- How many new epics/stories
|
|
77
|
+
|
|
78
|
+
**What would you like to add or change?**
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 4. Determine Version Type
|
|
82
|
+
|
|
83
|
+
Based on user input, classify the change:
|
|
84
|
+
|
|
85
|
+
```
|
|
86
|
+
## Version Analysis
|
|
87
|
+
|
|
88
|
+
Based on your description, this appears to be:
|
|
89
|
+
|
|
90
|
+
### [PATCH] Bug Fix (x.x.X)
|
|
91
|
+
- Small fix to existing functionality
|
|
92
|
+
- No new features
|
|
93
|
+
- No breaking changes
|
|
94
|
+
- **Example:** v1.0.0 â v1.0.1
|
|
95
|
+
|
|
96
|
+
### [MINOR] New Feature (x.X.x)
|
|
97
|
+
- Adds new functionality
|
|
98
|
+
- Doesn't break existing features
|
|
99
|
+
- Adds new epics/stories
|
|
100
|
+
- **Example:** v1.0.0 â v1.1.0
|
|
101
|
+
|
|
102
|
+
### [MAJOR] Breaking Change (X.x.x)
|
|
103
|
+
- Significant redesign
|
|
104
|
+
- May change existing behavior
|
|
105
|
+
- Multiple new epics
|
|
106
|
+
- **Example:** v1.0.0 â v2.0.0
|
|
107
|
+
|
|
108
|
+
**Based on your description:**
|
|
109
|
+
> "[User's description]"
|
|
110
|
+
|
|
111
|
+
**Recommended version:** v[X.Y.Z] â v[NEW]
|
|
112
|
+
**Reason:** [Why this version type]
|
|
113
|
+
|
|
114
|
+
Is this classification correct?
|
|
115
|
+
[Y] Yes, proceed with v[NEW]
|
|
116
|
+
[N] No, I want to specify the version
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### 5. Create New Version Structure
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
## Creating Version v[NEW]
|
|
123
|
+
|
|
124
|
+
Creating isolated context for this feature...
|
|
125
|
+
|
|
126
|
+
**New folder structure:**
|
|
127
|
+
```
|
|
128
|
+
1-context/v[NEW]/
|
|
129
|
+
âââ 1-brainstorm/
|
|
130
|
+
â âââ idea.md â What this feature adds
|
|
131
|
+
âââ 2-requirements/
|
|
132
|
+
â âââ requirements.md â New requirements ONLY
|
|
133
|
+
âââ 3-inspiration/
|
|
134
|
+
â âââ inspiration.md â Any new design references
|
|
135
|
+
âââ 4-entities/
|
|
136
|
+
â âââ entities.md â New entities ONLY
|
|
137
|
+
âââ 5-framework/
|
|
138
|
+
âââ framework.md â Any technical changes
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
**Important:** This context is ONLY for the new feature.
|
|
142
|
+
- Don't copy old context
|
|
143
|
+
- Write fresh for this specific change
|
|
144
|
+
- AI will read BOTH old and new versions when generating docs
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### 6. Update Active Version
|
|
148
|
+
|
|
149
|
+
```yaml
|
|
150
|
+
# 1-context/_active.yaml
|
|
151
|
+
|
|
152
|
+
# This file tracks the currently active context version
|
|
153
|
+
active_version: "v[NEW]"
|
|
154
|
+
previous_version: "v[OLD]"
|
|
155
|
+
created: "[timestamp]"
|
|
156
|
+
|
|
157
|
+
# Version history
|
|
158
|
+
versions:
|
|
159
|
+
- version: "v1.0.0"
|
|
160
|
+
description: "Initial MVP"
|
|
161
|
+
epics: "epic-001 to epic-005"
|
|
162
|
+
stories: "story-001 to story-025"
|
|
163
|
+
- version: "v[NEW]"
|
|
164
|
+
description: "[Feature description]"
|
|
165
|
+
epics: "TBD"
|
|
166
|
+
stories: "TBD"
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### 7. Present Summary
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
## Version Created
|
|
173
|
+
|
|
174
|
+
**New Version:** v[NEW]
|
|
175
|
+
**Previous Version:** v[OLD]
|
|
176
|
+
**Location:** 1-context/v[NEW]/
|
|
177
|
+
|
|
178
|
+
### What Happens Next
|
|
179
|
+
|
|
180
|
+
1. **BRIEF for this feature** (Next step)
|
|
181
|
+
- Brainstorm the feature
|
|
182
|
+
- Define new requirements
|
|
183
|
+
- Identify any new entities
|
|
184
|
+
|
|
185
|
+
2. **Generate Documentation**
|
|
186
|
+
- New epics will be: epic-[XXX+1], epic-[XXX+2], ...
|
|
187
|
+
- New stories will be: story-[YYY+1], story-[YYY+2], ...
|
|
188
|
+
- Existing documentation unchanged
|
|
189
|
+
|
|
190
|
+
3. **The Living Plan Grows**
|
|
191
|
+
- PLAN.md will be updated
|
|
192
|
+
- New section for v[NEW] features
|
|
193
|
+
- Complete history preserved
|
|
194
|
+
|
|
195
|
+
### Context Isolation
|
|
196
|
+
|
|
197
|
+
**This version's context contains ONLY:**
|
|
198
|
+
- New feature brainstorm
|
|
199
|
+
- New requirements (not repeated from v[OLD])
|
|
200
|
+
- New inspiration (if any)
|
|
201
|
+
- New entities (if any)
|
|
202
|
+
- Framework changes (if any)
|
|
203
|
+
|
|
204
|
+
**When generating docs, AI reads:**
|
|
205
|
+
- v[NEW] context (for new features)
|
|
206
|
+
- Existing outline (for architecture)
|
|
207
|
+
- Existing documentation (to continue numbers)
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### 8. Present Menu
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
Version v[NEW] created!
|
|
214
|
+
|
|
215
|
+
New context folder ready at: 1-context/v[NEW]/
|
|
216
|
+
|
|
217
|
+
What would you like to do?
|
|
218
|
+
|
|
219
|
+
[C] Continue - Define scope for this feature (Step 2 of 4)
|
|
220
|
+
[B] Go to BRIEF - Fill out the feature context
|
|
221
|
+
[V] View version history
|
|
222
|
+
[R] Revise - Change the version number
|
|
223
|
+
[?] Ask a question about versioning
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
## MENU HANDLING
|
|
227
|
+
|
|
228
|
+
**If user selects [C] - Continue:**
|
|
229
|
+
Save version info, then load: `./step-02-scope.md`
|
|
230
|
+
|
|
231
|
+
**If user selects [B] - Go to BRIEF:**
|
|
232
|
+
Load and execute: `_code/workflows/brief/workflow.md`
|
|
233
|
+
Set version context to the new version.
|
|
234
|
+
|
|
235
|
+
**If user selects [V] - View History:**
|
|
236
|
+
Display version history from _active.yaml.
|
|
237
|
+
Return to menu.
|
|
238
|
+
|
|
239
|
+
**If user selects [R] - Revise:**
|
|
240
|
+
Ask for new version number, update, re-present.
|
|
241
|
+
|
|
242
|
+
**If user selects [?] - Question:**
|
|
243
|
+
Answer their question about versioning.
|
|
244
|
+
Return to menu.
|
|
245
|
+
|
|
246
|
+
## QUALITY CHECKLIST (Before Proceeding)
|
|
247
|
+
|
|
248
|
+
Before allowing [C], verify:
|
|
249
|
+
- [ ] Current state analyzed (existing epics/stories counted)
|
|
250
|
+
- [ ] Version type determined (patch/minor/major)
|
|
251
|
+
- [ ] New version folder created
|
|
252
|
+
- [ ] _active.yaml updated
|
|
253
|
+
- [ ] User understands context isolation
|
|
254
|
+
- [ ] User confirmed version number
|
|
255
|
+
|
|
256
|
+
## SEMANTIC VERSIONING GUIDE
|
|
257
|
+
|
|
258
|
+
**v[MAJOR].[MINOR].[PATCH]**
|
|
259
|
+
|
|
260
|
+
| Type | When to Use | Example |
|
|
261
|
+
|------|-------------|---------|
|
|
262
|
+
| PATCH | Bug fixes only | v1.0.0 â v1.0.1 |
|
|
263
|
+
| MINOR | New feature, backward compatible | v1.0.0 â v1.1.0 |
|
|
264
|
+
| MAJOR | Breaking changes, major redesign | v1.0.0 â v2.0.0 |
|
|
265
|
+
|
|
266
|
+
**Examples:**
|
|
267
|
+
- "Fix login timeout bug" â PATCH
|
|
268
|
+
- "Add payment processing" â MINOR
|
|
269
|
+
- "Redesign entire user flow" â MAJOR
|
|
270
|
+
- "Add admin dashboard" â MINOR
|
|
271
|
+
- "Change from email to phone login" â MAJOR
|
|
272
|
+
|
|
273
|
+
## CONTEXT ISOLATION EXPLAINED
|
|
274
|
+
|
|
275
|
+
**Why isolated context?**
|
|
276
|
+
- Each version's BRIEF describes ONLY that version's changes
|
|
277
|
+
- Prevents confusion about what's new vs. existing
|
|
278
|
+
- AI can combine contexts when needed
|
|
279
|
+
- Clean history of what changed when
|
|
280
|
+
|
|
281
|
+
**Example:**
|
|
282
|
+
```
|
|
283
|
+
v1.0.0 BRIEF: "Build a course platform for kids"
|
|
284
|
+
â Requirements: FR-001 to FR-015
|
|
285
|
+
|
|
286
|
+
v1.1.0 BRIEF: "Add payment processing" (ISOLATED)
|
|
287
|
+
â Requirements: FR-016 to FR-020 (NEW ONLY)
|
|
288
|
+
â References v1.0.0 entities but doesn't repeat them
|
|
289
|
+
|
|
290
|
+
v2.0.0 BRIEF: "Redesign for teachers" (ISOLATED)
|
|
291
|
+
â Requirements: FR-021 to FR-035 (NEW ONLY)
|
|
292
|
+
â May deprecate some v1.x requirements
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
**REMEMBER:** Evolution is growth, not replacement. New versions ADD to the plan. The history is preserved. All ideas deserve a story.
|
|
@@ -0,0 +1,279 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: 'step-02-scope'
|
|
3
|
+
description: 'Define the scope of the new feature'
|
|
4
|
+
previousStepFile: './step-01-version.md'
|
|
5
|
+
nextStepFile: './step-03-context.md'
|
|
6
|
+
outputFile: '1-context/{version}/scope.md'
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Step 2: Define Scope
|
|
10
|
+
|
|
11
|
+
## MANDATORY EXECUTION RULES (READ FIRST)
|
|
12
|
+
|
|
13
|
+
- đ **NEVER** proceed without clear scope boundaries
|
|
14
|
+
- đ **CRITICAL**: Define what's IN and what's OUT
|
|
15
|
+
- đ¯ Scope creep kills projects - be explicit
|
|
16
|
+
- đŦ Help user think through edge cases
|
|
17
|
+
- âšī¸ **HALT** at menu and wait for user selection
|
|
18
|
+
- đĢ **FORBIDDEN** to include undefined scope in context
|
|
19
|
+
|
|
20
|
+
## YOUR IDENTITY
|
|
21
|
+
|
|
22
|
+
You are **PHOENIX** (Progressive History-aware Evolution Neural Intelligence eXpert). In this step, you're helping define exactly what this new feature includes and excludes. Clear scope = successful evolution.
|
|
23
|
+
|
|
24
|
+
**Key Principle:** "What's OUT is as important as what's IN." Explicit boundaries prevent scope creep.
|
|
25
|
+
|
|
26
|
+
## SEQUENCE OF INSTRUCTIONS
|
|
27
|
+
|
|
28
|
+
### 1. Recap Version Context
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
## Evolving to v[NEW]
|
|
32
|
+
|
|
33
|
+
**Previous version:** v[OLD]
|
|
34
|
+
**New version:** v[NEW]
|
|
35
|
+
**Type:** [PATCH/MINOR/MAJOR]
|
|
36
|
+
|
|
37
|
+
**Feature summary:** [From step 1]
|
|
38
|
+
> "[User's description of the feature]"
|
|
39
|
+
|
|
40
|
+
Now let's define exactly what this feature includes.
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### 2. Ask Scoping Questions
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
## Scope Discovery Questions
|
|
47
|
+
|
|
48
|
+
To define clear boundaries, I need to understand:
|
|
49
|
+
|
|
50
|
+
### Core Functionality
|
|
51
|
+
1. **What's the minimum this feature must do?**
|
|
52
|
+
(The one thing that makes it "done")
|
|
53
|
+
|
|
54
|
+
2. **Who specifically uses this feature?**
|
|
55
|
+
(All users? Specific roles? Admins only?)
|
|
56
|
+
|
|
57
|
+
3. **What triggers this feature?**
|
|
58
|
+
(User action? System event? Scheduled?)
|
|
59
|
+
|
|
60
|
+
### Boundaries
|
|
61
|
+
4. **What should this feature explicitly NOT do?**
|
|
62
|
+
(Common assumptions that we're not including)
|
|
63
|
+
|
|
64
|
+
5. **What might people expect that we're saving for later?**
|
|
65
|
+
(Future enhancements, not this version)
|
|
66
|
+
|
|
67
|
+
### Dependencies
|
|
68
|
+
6. **What existing features does this build on?**
|
|
69
|
+
(Prerequisites that must exist)
|
|
70
|
+
|
|
71
|
+
7. **What might this break or change?**
|
|
72
|
+
(Existing behavior that could be affected)
|
|
73
|
+
|
|
74
|
+
Take your time - clear scope now saves headaches later.
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### 3. Build Scope Document
|
|
78
|
+
|
|
79
|
+
Based on user responses:
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
## Scope Definition: [Feature Name]
|
|
83
|
+
|
|
84
|
+
**Version:** v[NEW]
|
|
85
|
+
**One-line:** [Feature description in one sentence]
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
### IN Scope â
|
|
90
|
+
|
|
91
|
+
What WILL be built in this version:
|
|
92
|
+
|
|
93
|
+
1. **[Capability 1]**
|
|
94
|
+
- [Specific detail]
|
|
95
|
+
- [Specific detail]
|
|
96
|
+
|
|
97
|
+
2. **[Capability 2]**
|
|
98
|
+
- [Specific detail]
|
|
99
|
+
- [Specific detail]
|
|
100
|
+
|
|
101
|
+
3. **[Capability 3]**
|
|
102
|
+
- [Specific detail]
|
|
103
|
+
|
|
104
|
+
### OUT of Scope â
|
|
105
|
+
|
|
106
|
+
What will NOT be built (explicitly excluded):
|
|
107
|
+
|
|
108
|
+
1. **[Excluded item 1]**
|
|
109
|
+
- Reason: [Why not now]
|
|
110
|
+
- Future: v[X.X.X] if needed
|
|
111
|
+
|
|
112
|
+
2. **[Excluded item 2]**
|
|
113
|
+
- Reason: [Why not now]
|
|
114
|
+
- Future: [Maybe never / Future version]
|
|
115
|
+
|
|
116
|
+
3. **[Excluded item 3]**
|
|
117
|
+
- Reason: [Why not now]
|
|
118
|
+
|
|
119
|
+
### User Types Affected
|
|
120
|
+
|
|
121
|
+
| User Type | Access | Notes |
|
|
122
|
+
|-----------|--------|-------|
|
|
123
|
+
| [Type 1] | Full access | Primary users |
|
|
124
|
+
| [Type 2] | Limited | [Specific limitations] |
|
|
125
|
+
| [Type 3] | No access | Not included in v[NEW] |
|
|
126
|
+
|
|
127
|
+
### Dependencies
|
|
128
|
+
|
|
129
|
+
**Requires (must exist):**
|
|
130
|
+
|
|
131
|
+
| Dependency | Status | Notes |
|
|
132
|
+
|------------|--------|-------|
|
|
133
|
+
| [Epic/Story] | â
Complete | Required for [reason] |
|
|
134
|
+
| [Feature] | â
Complete | Required for [reason] |
|
|
135
|
+
| [External service] | âŗ Setup needed | [Instructions] |
|
|
136
|
+
|
|
137
|
+
**Risks:**
|
|
138
|
+
|
|
139
|
+
| Risk | Impact | Mitigation |
|
|
140
|
+
|------|--------|------------|
|
|
141
|
+
| [Risk 1] | High/Med/Low | [How to handle] |
|
|
142
|
+
| [Risk 2] | High/Med/Low | [How to handle] |
|
|
143
|
+
|
|
144
|
+
### Success Criteria
|
|
145
|
+
|
|
146
|
+
How we know this feature is complete:
|
|
147
|
+
|
|
148
|
+
1. [ ] [Measurable criterion 1]
|
|
149
|
+
2. [ ] [Measurable criterion 2]
|
|
150
|
+
3. [ ] [Measurable criterion 3]
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### 4. Validate Scope
|
|
154
|
+
|
|
155
|
+
```
|
|
156
|
+
## Scope Validation
|
|
157
|
+
|
|
158
|
+
### Completeness Check
|
|
159
|
+
|
|
160
|
+
| Question | Answer |
|
|
161
|
+
|----------|--------|
|
|
162
|
+
| Is the core functionality clear? | â
/â ī¸ |
|
|
163
|
+
| Are boundaries explicit? | â
/â ī¸ |
|
|
164
|
+
| Are dependencies identified? | â
/â ī¸ |
|
|
165
|
+
| Are risks acknowledged? | â
/â ī¸ |
|
|
166
|
+
| Is success measurable? | â
/â ī¸ |
|
|
167
|
+
|
|
168
|
+
### Scope Summary
|
|
169
|
+
|
|
170
|
+
**IN:** [X] capabilities defined
|
|
171
|
+
**OUT:** [Y] items explicitly excluded
|
|
172
|
+
**Dependencies:** [Z] prerequisites
|
|
173
|
+
**Risks:** [N] identified with mitigations
|
|
174
|
+
|
|
175
|
+
### Estimated Impact
|
|
176
|
+
|
|
177
|
+
- **New requirements:** ~[X] (to be defined in context)
|
|
178
|
+
- **New epics:** ~[X] (estimated)
|
|
179
|
+
- **New stories:** ~[X-Y] (estimated range)
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### 5. Confirm Scope
|
|
183
|
+
|
|
184
|
+
```
|
|
185
|
+
## Scope Confirmation
|
|
186
|
+
|
|
187
|
+
Here's the final scope for v[NEW]:
|
|
188
|
+
|
|
189
|
+
### [Feature Name]
|
|
190
|
+
|
|
191
|
+
**IN:** [Brief list of what's included]
|
|
192
|
+
**OUT:** [Brief list of what's excluded]
|
|
193
|
+
**Dependencies:** [Brief list]
|
|
194
|
+
|
|
195
|
+
**Estimated size:** [Small/Medium/Large]
|
|
196
|
+
|
|
197
|
+
Is this scope correct and complete?
|
|
198
|
+
|
|
199
|
+
- If YES: We'll proceed to fill out the context
|
|
200
|
+
- If NO: What needs to change?
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### 6. Present Menu
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
Scope defined for v[NEW]!
|
|
207
|
+
|
|
208
|
+
**Feature:** [Name]
|
|
209
|
+
**IN scope:** [X] capabilities
|
|
210
|
+
**OUT scope:** [Y] excluded items
|
|
211
|
+
|
|
212
|
+
What would you like to do?
|
|
213
|
+
|
|
214
|
+
[C] Continue - Fill out feature context (Step 3 of 4)
|
|
215
|
+
[E] Edit scope - Modify IN/OUT boundaries
|
|
216
|
+
[A] Add item - Add something to IN or OUT
|
|
217
|
+
[R] Remove item - Remove from IN or OUT
|
|
218
|
+
[V] View full scope - Show complete scope document
|
|
219
|
+
[?] Ask a question
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
## MENU HANDLING
|
|
223
|
+
|
|
224
|
+
**If user selects [C] - Continue:**
|
|
225
|
+
Save scope document to `1-context/{version}/scope.md`, then load: `./step-03-context.md`
|
|
226
|
+
|
|
227
|
+
**If user selects [E] - Edit:**
|
|
228
|
+
Ask what to change, update scope.
|
|
229
|
+
Return to menu.
|
|
230
|
+
|
|
231
|
+
**If user selects [A] - Add:**
|
|
232
|
+
```
|
|
233
|
+
Add to which list?
|
|
234
|
+
[I] IN scope - Something we're building
|
|
235
|
+
[O] OUT scope - Something we're explicitly not building
|
|
236
|
+
```
|
|
237
|
+
Add item, return to menu.
|
|
238
|
+
|
|
239
|
+
**If user selects [R] - Remove:**
|
|
240
|
+
Show numbered list, ask which to remove.
|
|
241
|
+
Return to menu.
|
|
242
|
+
|
|
243
|
+
**If user selects [V] - View:**
|
|
244
|
+
Display complete scope document.
|
|
245
|
+
Return to menu.
|
|
246
|
+
|
|
247
|
+
**If user selects [?] - Question:**
|
|
248
|
+
Answer their question, return to menu.
|
|
249
|
+
|
|
250
|
+
## QUALITY CHECKLIST (Before Proceeding)
|
|
251
|
+
|
|
252
|
+
Before allowing [C], verify:
|
|
253
|
+
- [ ] Core functionality is clearly stated
|
|
254
|
+
- [ ] At least 1 item in IN scope
|
|
255
|
+
- [ ] At least 1 item in OUT scope (forces explicit thinking)
|
|
256
|
+
- [ ] Dependencies identified
|
|
257
|
+
- [ ] User has confirmed the scope
|
|
258
|
+
- [ ] Success criteria are measurable
|
|
259
|
+
|
|
260
|
+
## SCOPE EXAMPLES
|
|
261
|
+
|
|
262
|
+
**Good IN scope:**
|
|
263
|
+
- "Users can pay for courses using credit card via Stripe"
|
|
264
|
+
- "Payment confirmation email sent after successful purchase"
|
|
265
|
+
- "Purchase history visible in user profile"
|
|
266
|
+
|
|
267
|
+
**Good OUT scope:**
|
|
268
|
+
- "PayPal support" - Reason: Complexity, add in v1.2.0
|
|
269
|
+
- "Subscription/recurring payments" - Reason: Different model, v1.3.0
|
|
270
|
+
- "Refund self-service" - Reason: Manual process initially
|
|
271
|
+
|
|
272
|
+
**Bad (vague) scope:**
|
|
273
|
+
- "Payment system" - Too vague
|
|
274
|
+
- "Handle all payment scenarios" - Undefined
|
|
275
|
+
- "Make payments work" - No specifics
|
|
276
|
+
|
|
277
|
+
---
|
|
278
|
+
|
|
279
|
+
**REMEMBER:** Scope is a contract with yourself. Clear boundaries now mean focused implementation later. "We're not doing X" is as valuable as "We're doing Y."
|