speccrew 0.3.9 → 0.3.11
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.
|
@@ -463,9 +463,12 @@ Phase 0 → Phase 1 → Phase 2 → Phase 3 → Phase 4 (if complex) → Phase 5
|
|
|
463
463
|
|
|
464
464
|
### MANDATORY TEMPLATE PATH
|
|
465
465
|
|
|
466
|
-
- **PRD Template**:
|
|
467
|
-
- **BIZS Modeling Template**:
|
|
468
|
-
- **
|
|
466
|
+
- **PRD Template**: Search with glob `**/speccrew-pm-requirement-analysis/templates/PRD-TEMPLATE.md`
|
|
467
|
+
- **BIZS Modeling Template**: Search with glob `**/speccrew-pm-requirement-analysis/templates/BIZS-MODELING-TEMPLATE.md`
|
|
468
|
+
- **Sub-PRD Template**: The Sub-PRD worker skill (`speccrew-pm-sub-prd-generate/SKILL.md`) receives template_path as parameter — pass the found PRD template path to the worker
|
|
469
|
+
- **DO NOT search for templates in bizs/, knowledges/, project source, or other unrelated directories**
|
|
470
|
+
- **DO NOT try to find templates by listing all .md files in the project**
|
|
471
|
+
- **Templates are ALWAYS in the skill's own `templates/` subfolder**, accessed via glob pattern
|
|
469
472
|
|
|
470
473
|
### Must do
|
|
471
474
|
- Read business module list to confirm boundaries between requirements and existing features
|
|
@@ -76,32 +76,122 @@ Use progressive questioning to clarify requirements. Do NOT ask all questions at
|
|
|
76
76
|
> - **Domain Glossary**: Unify key business terms to eliminate ambiguity across stakeholders.
|
|
77
77
|
> These elements should naturally flow into the clarification summary, NOT as a separate document.
|
|
78
78
|
|
|
79
|
-
###
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
79
|
+
### File-Based Clarification Workflow
|
|
80
|
+
|
|
81
|
+
> ⚠️ **All clarification rounds use file-based interaction, NOT chat-based.**
|
|
82
|
+
> This prevents users from having to copy-paste large amounts of content in chat.
|
|
83
|
+
|
|
84
|
+
**Round 1: Core Understanding**
|
|
85
|
+
|
|
86
|
+
1. **Create** `.clarification-summary.md` in the iteration's `01.product-requirement/` directory:
|
|
87
|
+
```
|
|
88
|
+
speccrew-workspace/iterations/{iteration}/01.product-requirement/.clarification-summary.md
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
2. **Write** Round 1 questions to the file using this format:
|
|
92
|
+
|
|
93
|
+
```markdown
|
|
94
|
+
# Requirements Clarification
|
|
95
|
+
|
|
96
|
+
## Round 1: Core Understanding
|
|
97
|
+
|
|
98
|
+
> **Instructions**: Please fill in your answers directly after each "**Answer:**" marker below, then save the file and notify me that you have completed your responses.
|
|
99
|
+
|
|
100
|
+
### 1. Business Background & Goals
|
|
101
|
+
|
|
102
|
+
Based on the requirement document, the system aims to solve:
|
|
103
|
+
- [PM's understanding point 1]
|
|
104
|
+
- [PM's understanding point 2]
|
|
105
|
+
- ...
|
|
106
|
+
|
|
107
|
+
**Answer:** <!-- Fill your confirmation or corrections here -->
|
|
108
|
+
|
|
109
|
+
### 2. Target Users & Scenarios
|
|
110
|
+
|
|
111
|
+
The document identifies the following user roles:
|
|
112
|
+
- Role 1: description
|
|
113
|
+
- Role 2: description
|
|
114
|
+
|
|
115
|
+
Questions:
|
|
116
|
+
- Are there additional roles not mentioned?
|
|
117
|
+
- [Other specific questions]
|
|
118
|
+
|
|
119
|
+
**Answer:** <!-- Fill your answers here -->
|
|
120
|
+
|
|
121
|
+
### 3. System Scope & Boundaries
|
|
122
|
+
|
|
123
|
+
The functional scope includes:
|
|
124
|
+
- Module 1
|
|
125
|
+
- Module 2
|
|
126
|
+
- ...
|
|
127
|
+
|
|
128
|
+
Questions:
|
|
129
|
+
- Are all modules required for Phase 1?
|
|
130
|
+
- [Other scope questions]
|
|
131
|
+
|
|
132
|
+
**Answer:** <!-- Fill your answers here -->
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
3. **Notify user** with a brief message:
|
|
136
|
+
```
|
|
137
|
+
📝 Clarification questions written to:
|
|
138
|
+
`01.product-requirement/.clarification-summary.md`
|
|
139
|
+
|
|
140
|
+
Please open the file, fill in your answers after each "**Answer:**" marker, save, and let me know when done.
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
4. **HARD STOP** — Wait for user to confirm they have answered.
|
|
144
|
+
|
|
145
|
+
5. **Read** the updated `.clarification-summary.md` file.
|
|
146
|
+
|
|
147
|
+
6. **Evaluate** if answers are sufficient for Sufficiency Checks.
|
|
148
|
+
|
|
149
|
+
**Round 2 (if needed): Scope & Boundaries**
|
|
150
|
+
|
|
151
|
+
7. **Append** Round 2 questions to the SAME file:
|
|
152
|
+
|
|
153
|
+
```markdown
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## Round 2: Scope & Boundaries
|
|
157
|
+
|
|
158
|
+
> Based on your Round 1 answers, I need to clarify the following details.
|
|
159
|
+
> Please fill in your answers after each "**Answer:**" marker.
|
|
160
|
+
|
|
161
|
+
### 1. Out-of-Scope Items
|
|
162
|
+
|
|
163
|
+
Based on the requirement, the following appear to be out of scope:
|
|
164
|
+
- [Item 1]
|
|
165
|
+
- [Item 2]
|
|
166
|
+
|
|
167
|
+
Questions:
|
|
168
|
+
- Are there any explicit exclusions?
|
|
169
|
+
- [Other boundary questions]
|
|
170
|
+
|
|
171
|
+
**Answer:** <!-- Fill your answers here -->
|
|
172
|
+
|
|
173
|
+
### 2. Existing System Relationship
|
|
174
|
+
|
|
175
|
+
Questions:
|
|
176
|
+
- Does this overlap with any existing system capabilities?
|
|
177
|
+
- Should this reuse or replace existing functionality?
|
|
178
|
+
|
|
179
|
+
**Answer:** <!-- Fill your answers here -->
|
|
180
|
+
|
|
181
|
+
### 3. Constraints
|
|
182
|
+
|
|
183
|
+
Questions:
|
|
184
|
+
- Are there timeline constraints?
|
|
185
|
+
- Technology or budget constraints?
|
|
186
|
+
|
|
187
|
+
**Answer:** <!-- Fill your answers here -->
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
8. **Notify user** again and wait for response.
|
|
191
|
+
|
|
192
|
+
9. **Read** the updated file and evaluate Sufficiency Checks.
|
|
193
|
+
|
|
194
|
+
**Round 3 (if still needed): Detail & Acceptance** — Same pattern: append to the file, notify, wait, read.
|
|
105
195
|
|
|
106
196
|
### Sufficiency Check
|
|
107
197
|
|
|
@@ -114,41 +204,35 @@ Sufficient to proceed when ALL of:
|
|
|
114
204
|
- [ ] Scope boundaries (in/out) are defined
|
|
115
205
|
- [ ] Relationship to existing system is understood
|
|
116
206
|
|
|
117
|
-
If ANY is unclear →
|
|
118
|
-
If ALL are clear → proceed to
|
|
207
|
+
If ANY is unclear → append follow-up questions to the clarification file
|
|
208
|
+
If ALL are clear → proceed to Finalize Clarification File
|
|
119
209
|
```
|
|
120
210
|
|
|
121
|
-
###
|
|
122
|
-
|
|
123
|
-
After Sufficiency Check passes, generate a clarification summary file:
|
|
211
|
+
### Finalize Clarification File
|
|
124
212
|
|
|
125
|
-
|
|
126
|
-
Path: speccrew-workspace/iterations/{iteration}/01.product-requirement/.clarification-summary.md
|
|
127
|
-
```
|
|
213
|
+
After all clarification rounds complete, append the Sufficiency Check results and Key Decisions to the file:
|
|
128
214
|
|
|
129
|
-
**Content template:**
|
|
130
215
|
```markdown
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
## Input Type
|
|
134
|
-
- [ ] Complete requirement document provided
|
|
135
|
-
- [ ] Incomplete input (progressive clarification performed)
|
|
216
|
+
---
|
|
136
217
|
|
|
137
|
-
##
|
|
138
|
-
- Round 1 (Core Understanding): [Summary of Q&A]
|
|
139
|
-
- Round 2 (Scope & Boundaries): [Summary of Q&A]
|
|
140
|
-
- Round 3 (Detail & Acceptance): [If applicable, Summary of Q&A]
|
|
218
|
+
## Sufficiency Check
|
|
141
219
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
220
|
+
| Check Item | Status |
|
|
221
|
+
|-----------|--------|
|
|
222
|
+
| Core business problem clearly defined | ✅ |
|
|
223
|
+
| Target user roles and permissions identified | ✅ |
|
|
224
|
+
| System scope and boundaries confirmed | ✅ |
|
|
225
|
+
| Key business rules clarified | ✅ |
|
|
147
226
|
|
|
148
227
|
## Key Decisions
|
|
149
|
-
|
|
228
|
+
|
|
229
|
+
| # | Decision | Rationale |
|
|
230
|
+
|---|----------|----------|
|
|
231
|
+
| 1 | [Decision] | [From user's answer in Round X] |
|
|
232
|
+
| 2 | [Decision] | [From user's answer in Round X] |
|
|
150
233
|
|
|
151
234
|
## Proceed Gate
|
|
235
|
+
|
|
152
236
|
✅ All checks passed. Ready for Step 2.
|
|
153
237
|
```
|
|
154
238
|
|
|
@@ -371,12 +455,24 @@ Phase 3 (Extension): Remaining modules
|
|
|
371
455
|
|
|
372
456
|
## Step 7: Read PRD Template
|
|
373
457
|
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
```
|
|
378
|
-
|
|
379
|
-
|
|
458
|
+
**Locate and read the PRD template file using this search strategy:**
|
|
459
|
+
|
|
460
|
+
1. **Search** for the template using glob pattern:
|
|
461
|
+
```
|
|
462
|
+
**/speccrew-pm-requirement-analysis/templates/PRD-TEMPLATE.md
|
|
463
|
+
```
|
|
464
|
+
This will find the template regardless of IDE adapter path (.qoder/, .claude/, .cursor/, .speccrew/).
|
|
465
|
+
|
|
466
|
+
2. **Read** the found template file.
|
|
467
|
+
|
|
468
|
+
3. **If BIZS modeling template is needed** (for complex systems with 3+ modules):
|
|
469
|
+
```
|
|
470
|
+
**/speccrew-pm-requirement-analysis/templates/BIZS-MODELING-TEMPLATE.md
|
|
471
|
+
```
|
|
472
|
+
|
|
473
|
+
> ⚠️ **DO NOT manually search in these directories:** bizs/, knowledges/, workspace docs, project src/
|
|
474
|
+
> The template is ALWAYS located in the skill's own `templates/` subfolder.
|
|
475
|
+
> If glob returns no results, check if speccrew was properly initialized (`speccrew init`).
|
|
380
476
|
|
|
381
477
|
After reading the template, check if any required information is missing based on:
|
|
382
478
|
- Template structure requirements
|
|
@@ -37,7 +37,19 @@ This skill applies ISA-95 Stages 1-3 in lightweight mode:
|
|
|
37
37
|
|
|
38
38
|
### Step 1: Quick Clarification
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
**For simple requirements with 1-3 questions:**
|
|
41
|
+
- Ask directly in chat (acceptable for very short clarifications)
|
|
42
|
+
|
|
43
|
+
**For requirements needing 4+ questions:**
|
|
44
|
+
- Use file-based clarification (same as complex skill):
|
|
45
|
+
1. Write questions to `.clarification-summary.md` in the iteration's `01.product-requirement/` directory
|
|
46
|
+
2. User fills answers in file after each "**Answer:**" marker
|
|
47
|
+
3. User notifies PM
|
|
48
|
+
4. PM reads and proceeds
|
|
49
|
+
|
|
50
|
+
> **Default to chat-based** for simple requirements unless the clarification content is lengthy.
|
|
51
|
+
|
|
52
|
+
Clarification topics:
|
|
41
53
|
|
|
42
54
|
1. **What to change**: Which page/function/module is affected?
|
|
43
55
|
2. **What the change is**: Add field? Modify logic? New sub-feature?
|
|
@@ -80,20 +92,19 @@ node speccrew-workspace/scripts/update-progress.js update-workflow \
|
|
|
80
92
|
|
|
81
93
|
### Step 3: Read PRD Template
|
|
82
94
|
|
|
83
|
-
|
|
84
|
-
```
|
|
85
|
-
{skill-root}/../speccrew-pm-requirement-analysis/templates/PRD-TEMPLATE.md
|
|
86
|
-
```
|
|
95
|
+
**Locate and read the PRD template:**
|
|
87
96
|
|
|
88
|
-
|
|
97
|
+
1. **Search** for the template using glob pattern:
|
|
98
|
+
```
|
|
99
|
+
**/speccrew-pm-requirement-analysis/templates/PRD-TEMPLATE.md
|
|
100
|
+
```
|
|
101
|
+
> Note: Simple requirement skill shares the PRD template with the complex requirement skill.
|
|
89
102
|
|
|
90
|
-
|
|
91
|
-
```
|
|
92
|
-
speccrew-workspace/docs/templates/PRD-TEMPLATE.md
|
|
93
|
-
```
|
|
103
|
+
2. **Read** the found template file.
|
|
94
104
|
|
|
95
|
-
> **
|
|
96
|
-
>
|
|
105
|
+
> ⚠️ **DO NOT search in bizs/, knowledges/, or project source directories.**
|
|
106
|
+
> The template is ALWAYS located in the skill's own `templates/` subfolder.
|
|
107
|
+
> If glob returns no results, check if speccrew was properly initialized (`speccrew init`).
|
|
97
108
|
|
|
98
109
|
### Step 4: Generate Single PRD
|
|
99
110
|
|