gspec 1.1.1 → 1.1.2
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 +15 -3
- package/commands/gspec.epic.md +6 -4
- package/commands/gspec.feature.md +5 -3
- package/dist/antigravity/gspec-architect/SKILL.md +1 -1
- package/dist/antigravity/gspec-dor/SKILL.md +2 -2
- package/dist/antigravity/gspec-epic/SKILL.md +7 -5
- package/dist/antigravity/gspec-feature/SKILL.md +6 -4
- package/dist/antigravity/gspec-implement/SKILL.md +2 -2
- package/dist/antigravity/gspec-migrate/SKILL.md +5 -5
- package/dist/antigravity/gspec-practices/SKILL.md +1 -1
- package/dist/antigravity/gspec-profile/SKILL.md +1 -1
- package/dist/antigravity/gspec-record/SKILL.md +2 -2
- package/dist/antigravity/gspec-stack/SKILL.md +1 -1
- package/dist/antigravity/gspec-style/SKILL.md +1 -1
- package/dist/claude/gspec-architect/SKILL.md +1 -1
- package/dist/claude/gspec-dor/SKILL.md +2 -2
- package/dist/claude/gspec-epic/SKILL.md +7 -5
- package/dist/claude/gspec-feature/SKILL.md +6 -4
- package/dist/claude/gspec-implement/SKILL.md +2 -2
- package/dist/claude/gspec-migrate/SKILL.md +5 -5
- package/dist/claude/gspec-practices/SKILL.md +1 -1
- package/dist/claude/gspec-profile/SKILL.md +1 -1
- package/dist/claude/gspec-record/SKILL.md +2 -2
- package/dist/claude/gspec-stack/SKILL.md +1 -1
- package/dist/claude/gspec-style/SKILL.md +1 -1
- package/dist/cursor/gspec-architect.mdc +1 -1
- package/dist/cursor/gspec-dor.mdc +2 -2
- package/dist/cursor/gspec-epic.mdc +7 -5
- package/dist/cursor/gspec-feature.mdc +6 -4
- package/dist/cursor/gspec-implement.mdc +2 -2
- package/dist/cursor/gspec-migrate.mdc +5 -5
- package/dist/cursor/gspec-practices.mdc +1 -1
- package/dist/cursor/gspec-profile.mdc +1 -1
- package/dist/cursor/gspec-record.mdc +2 -2
- package/dist/cursor/gspec-stack.mdc +1 -1
- package/dist/cursor/gspec-style.mdc +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,7 +23,13 @@ These documents become the shared context for all subsequent AI interactions. Wh
|
|
|
23
23
|
|
|
24
24
|
### The Workflow
|
|
25
25
|
|
|
26
|
+
The only commands you *need* are the four fundamentals and `implement`. Everything else exists to help when your project calls for it.
|
|
27
|
+
|
|
28
|
+
The fundamentals give your AI tool enough context to build well — it knows what the product is, how it should look, what technologies to use, and what engineering standards to follow. From there, `implement` can take a plain-language description and start building. The remaining commands — `feature`, `epic`, `architect`, `dor`, and `record` — add structure and rigor when the scope or complexity warrants it.
|
|
29
|
+
|
|
26
30
|
```
|
|
31
|
+
Define → Build
|
|
32
|
+
Define → Specify → Build
|
|
27
33
|
Define → Specify → Architect → Build → Iterate
|
|
28
34
|
```
|
|
29
35
|
|
|
@@ -36,32 +42,38 @@ Define → Specify → Architect → Build → Iterate
|
|
|
36
42
|
| `gspec.stack` | Software Architect | Technology stack, frameworks, infrastructure, architecture |
|
|
37
43
|
| `gspec.practices` | Engineering Lead | Development standards, code quality, testing, workflows |
|
|
38
44
|
|
|
39
|
-
**2. Specify What to Build** — Define features and requirements.
|
|
45
|
+
**2. Specify What to Build** *(optional)* — Define features and requirements.
|
|
40
46
|
|
|
41
47
|
| Command | Role | What it produces |
|
|
42
48
|
|---|---|---|
|
|
43
49
|
| `gspec.feature` | Product Manager | PRD for a single feature with prioritized capabilities |
|
|
44
50
|
| `gspec.epic` | Product Manager | Breaks a large epic into multiple feature PRDs with dependency mapping |
|
|
45
51
|
|
|
46
|
-
|
|
52
|
+
Use `feature` when you want a detailed PRD with prioritized capabilities and acceptance criteria before building. Use `epic` when a body of work is large enough to need decomposition into multiple features with dependency mapping. For smaller tasks or rapid prototyping, you can skip straight to `implement` with a plain-language description.
|
|
53
|
+
|
|
54
|
+
**3. Architect** *(optional)* — Translate specs into a concrete technical blueprint.
|
|
47
55
|
|
|
48
56
|
| Command | Role | What it produces |
|
|
49
57
|
|---|---|---|
|
|
50
58
|
| `gspec.architect` | Senior Architect | Technical architecture document with data models, API design, project structure, auth flows, and Mermaid diagrams |
|
|
51
59
|
|
|
60
|
+
Use `architect` when your feature involves significant technical complexity — new data models, service boundaries, auth flows, or integration points that benefit from upfront design. For straightforward features, `implement` can make sound architectural decisions on its own using your `stack` and `practices` specs.
|
|
61
|
+
|
|
52
62
|
**4. Build** — Implement with full context.
|
|
53
63
|
|
|
54
64
|
| Command | Role | What it does |
|
|
55
65
|
|---|---|---|
|
|
56
66
|
| `gspec.implement` | Senior Engineer | Reads all specs, identifies gaps, researches competitors, plans and builds |
|
|
57
67
|
|
|
58
|
-
**5. Iterate** — Keep specs and code in sync as the project evolves.
|
|
68
|
+
**5. Iterate** *(optional)* — Keep specs and code in sync as the project evolves.
|
|
59
69
|
|
|
60
70
|
| Command | Role | What it does |
|
|
61
71
|
|---|---|---|
|
|
62
72
|
| `gspec.dor` | Engineer + Doc Lead | Makes code changes and updates specs to match |
|
|
63
73
|
| `gspec.record` | Doc Lead | Updates specs to reflect decisions or changes — no code modifications |
|
|
64
74
|
|
|
75
|
+
Use `dor` and `record` when you want your specification documents to stay accurate as the project evolves. If you're moving fast and specs are secondary, you can skip them — but as a project matures, keeping specs in sync prevents the context drift that degrades AI output over time.
|
|
76
|
+
|
|
65
77
|
**Maintenance** — Keep specs up to date with the latest gspec format.
|
|
66
78
|
|
|
67
79
|
| Command | Role | What it does |
|
package/commands/gspec.epic.md
CHANGED
|
@@ -33,7 +33,7 @@ Take the provided epic description (a large body of work) and break it down into
|
|
|
33
33
|
|
|
34
34
|
- **Read existing gspec documents first** to ground the epic and its features in established product context
|
|
35
35
|
- Identify distinct features that make up the epic
|
|
36
|
-
- Ask clarifying questions
|
|
36
|
+
- **Ask all clarifying questions in the chat before writing specs** — never embed unresolved questions in the generated documents
|
|
37
37
|
- When asking questions, offer 2-3 specific suggestions to guide the discussion
|
|
38
38
|
- Ensure features can be built incrementally and independently when possible
|
|
39
39
|
- Consider dependencies between features
|
|
@@ -71,13 +71,15 @@ If these files don't exist, proceed without them — they are optional context,
|
|
|
71
71
|
---
|
|
72
72
|
```
|
|
73
73
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
74
|
-
- **Before generating the documents
|
|
74
|
+
- **Before generating the documents, you MUST resolve ambiguities through conversation.** Ask clarifying questions in the chat if:
|
|
75
75
|
- The target users are unclear
|
|
76
76
|
- The scope or boundaries of the epic are ambiguous
|
|
77
77
|
- The breakdown into features is not obvious
|
|
78
78
|
- Success criteria cannot be determined from the description
|
|
79
79
|
- Priority or sequencing is unclear
|
|
80
|
+
- Any assumption would materially change the shape of the specs
|
|
80
81
|
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
82
|
+
- **Do NOT embed unresolved questions in the generated specs.** All questions about scope, users, priorities, capabilities, feature boundaries, and sequencing must be resolved through conversation before writing the documents. The specs should reflect decisions, not open debates.
|
|
81
83
|
- Create an epic summary document at `gspec/epics/[epic-name].md` that:
|
|
82
84
|
- Lists all features in the epic
|
|
83
85
|
- Shows dependencies between features
|
|
@@ -187,7 +189,7 @@ For each feature, create a separate file in `gspec/features/[feature-name].md` w
|
|
|
187
189
|
|
|
188
190
|
### 6. Assumptions & Risks
|
|
189
191
|
- Assumptions (what we're taking as true)
|
|
190
|
-
- Open questions
|
|
192
|
+
- Open questions — **only** unknowns that genuinely cannot be answered until implementation or real-world usage begins (e.g., performance thresholds pending benchmarking, exact rate limits pending load testing). Questions about scope, users, priorities, or feature design must be asked and resolved in the chat before the specs are written. If there are no open questions, omit this sub-section.
|
|
191
193
|
- Key risks and mitigations (brief bullet points — focus on risks that could affect implementation scope or approach)
|
|
192
194
|
|
|
193
195
|
### 7. Success Metrics
|
|
@@ -196,7 +198,7 @@ For each feature, create a separate file in `gspec/features/[feature-name].md` w
|
|
|
196
198
|
## Workflow
|
|
197
199
|
|
|
198
200
|
1. **Analyze the epic description** and identify logical feature boundaries
|
|
199
|
-
2. **Ask clarifying questions
|
|
201
|
+
2. **Ask clarifying questions in the chat** and wait for answers before proceeding — do not generate specs with embedded questions
|
|
200
202
|
3. **Break down into features** that:
|
|
201
203
|
- Can be built and shipped incrementally
|
|
202
204
|
- Deliver independent user value (when possible)
|
|
@@ -24,7 +24,7 @@ Your task is to take the provided feature description (which may be vague or det
|
|
|
24
24
|
|
|
25
25
|
You should:
|
|
26
26
|
- **Read existing gspec documents first** to ground the PRD in established product context
|
|
27
|
-
- Ask clarifying questions
|
|
27
|
+
- **Ask all clarifying questions in the chat before writing the spec** — never embed unresolved questions in the generated document
|
|
28
28
|
- When asking questions, offer 2-3 specific suggestions to guide the discussion
|
|
29
29
|
- Focus on user value, scope, and outcomes
|
|
30
30
|
- Write for automated implementation with human validation
|
|
@@ -61,12 +61,14 @@ If these files don't exist, proceed without them — they are optional context,
|
|
|
61
61
|
---
|
|
62
62
|
```
|
|
63
63
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
64
|
-
- **Before generating the document
|
|
64
|
+
- **Before generating the document, you MUST resolve ambiguities through conversation.** Ask clarifying questions in the chat if:
|
|
65
65
|
- The target users are unclear
|
|
66
66
|
- The scope or boundaries of the feature are ambiguous
|
|
67
67
|
- Success criteria cannot be determined from the description
|
|
68
68
|
- Priority or urgency is unspecified
|
|
69
|
+
- Any assumption would materially change the shape of the spec
|
|
69
70
|
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
71
|
+
- **Do NOT embed unresolved questions in the generated spec.** All questions about scope, users, priorities, capabilities, and feature boundaries must be resolved through conversation before writing the document. The spec should reflect decisions, not open debates.
|
|
70
72
|
- Avoid deep system architecture or low-level implementation
|
|
71
73
|
- Avoid detailed workflows or step-by-step descriptions of how the feature functions
|
|
72
74
|
- No code blocks except where examples add clarity
|
|
@@ -137,7 +139,7 @@ This separation allows the same feature spec to be implemented using different t
|
|
|
137
139
|
|
|
138
140
|
### 6. Assumptions & Risks
|
|
139
141
|
- Assumptions (what we're taking as true)
|
|
140
|
-
- Open questions
|
|
142
|
+
- Open questions — **only** unknowns that genuinely cannot be answered until implementation or real-world usage begins (e.g., performance thresholds pending benchmarking, exact rate limits pending load testing). Questions about scope, users, priorities, or feature design must be asked and resolved in the chat before the spec is written. If there are no open questions, omit this sub-section.
|
|
141
143
|
- Key risks and mitigations (brief bullet points — focus on risks that could affect implementation scope or approach)
|
|
142
144
|
|
|
143
145
|
### 7. Success Metrics
|
|
@@ -42,7 +42,7 @@ All of these provide essential context. If any are missing, note the gap and mak
|
|
|
42
42
|
- Begin the file with YAML frontmatter containing the gspec version:
|
|
43
43
|
```
|
|
44
44
|
---
|
|
45
|
-
gspec-version: 1.1.
|
|
45
|
+
gspec-version: 1.1.2
|
|
46
46
|
---
|
|
47
47
|
```
|
|
48
48
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
@@ -144,7 +144,7 @@ After approval, write the spec updates:
|
|
|
144
144
|
- Dependencies (on other features or external services)
|
|
145
145
|
- Assumptions & Risks (assumptions, open questions, key risks and mitigations — note in assumptions that this feature was identified during iterative development)
|
|
146
146
|
- Success Metrics
|
|
147
|
-
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.
|
|
147
|
+
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.2\n---`
|
|
148
148
|
- **Also update `gspec/architecture.md`** if the new feature introduces data entities, API endpoints, or new components — add them to the appropriate architecture sections
|
|
149
149
|
|
|
150
150
|
### Phase 7: Verify — Confirm Consistency
|
|
@@ -177,7 +177,7 @@ After writing spec updates:
|
|
|
177
177
|
|
|
178
178
|
**Implementation checkboxes.** Feature PRDs use markdown checkboxes (`- [ ]` / `- [x]`) on capabilities to track implementation status for `gspec-implement`. When DOR adds new capabilities, use unchecked checkboxes (`- [ ]`). When modifying a capability that was already checked (`- [x]`) and the code change reflects the modification, keep it checked. When creating a new feature PRD, use unchecked checkboxes for all capabilities. Do not check off capabilities that DOR did not implement in the current session.
|
|
179
179
|
|
|
180
|
-
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.
|
|
180
|
+
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.2\n---` as the very first content before the main heading.
|
|
181
181
|
|
|
182
182
|
---
|
|
183
183
|
|
|
@@ -38,7 +38,7 @@ Take the provided epic description (a large body of work) and break it down into
|
|
|
38
38
|
|
|
39
39
|
- **Read existing gspec documents first** to ground the epic and its features in established product context
|
|
40
40
|
- Identify distinct features that make up the epic
|
|
41
|
-
- Ask clarifying questions
|
|
41
|
+
- **Ask all clarifying questions in the chat before writing specs** — never embed unresolved questions in the generated documents
|
|
42
42
|
- When asking questions, offer 2-3 specific suggestions to guide the discussion
|
|
43
43
|
- Ensure features can be built incrementally and independently when possible
|
|
44
44
|
- Consider dependencies between features
|
|
@@ -72,17 +72,19 @@ If these files don't exist, proceed without them — they are optional context,
|
|
|
72
72
|
- Begin every output file (both epic summary and individual feature PRDs) with YAML frontmatter containing the gspec version:
|
|
73
73
|
```
|
|
74
74
|
---
|
|
75
|
-
gspec-version: 1.1.
|
|
75
|
+
gspec-version: 1.1.2
|
|
76
76
|
---
|
|
77
77
|
```
|
|
78
78
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
79
|
-
- **Before generating the documents
|
|
79
|
+
- **Before generating the documents, you MUST resolve ambiguities through conversation.** Ask clarifying questions in the chat if:
|
|
80
80
|
- The target users are unclear
|
|
81
81
|
- The scope or boundaries of the epic are ambiguous
|
|
82
82
|
- The breakdown into features is not obvious
|
|
83
83
|
- Success criteria cannot be determined from the description
|
|
84
84
|
- Priority or sequencing is unclear
|
|
85
|
+
- Any assumption would materially change the shape of the specs
|
|
85
86
|
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
87
|
+
- **Do NOT embed unresolved questions in the generated specs.** All questions about scope, users, priorities, capabilities, feature boundaries, and sequencing must be resolved through conversation before writing the documents. The specs should reflect decisions, not open debates.
|
|
86
88
|
- Create an epic summary document at `gspec/epics/[epic-name].md` that:
|
|
87
89
|
- Lists all features in the epic
|
|
88
90
|
- Shows dependencies between features
|
|
@@ -192,7 +194,7 @@ For each feature, create a separate file in `gspec/features/[feature-name].md` w
|
|
|
192
194
|
|
|
193
195
|
### 6. Assumptions & Risks
|
|
194
196
|
- Assumptions (what we're taking as true)
|
|
195
|
-
- Open questions
|
|
197
|
+
- Open questions — **only** unknowns that genuinely cannot be answered until implementation or real-world usage begins (e.g., performance thresholds pending benchmarking, exact rate limits pending load testing). Questions about scope, users, priorities, or feature design must be asked and resolved in the chat before the specs are written. If there are no open questions, omit this sub-section.
|
|
196
198
|
- Key risks and mitigations (brief bullet points — focus on risks that could affect implementation scope or approach)
|
|
197
199
|
|
|
198
200
|
### 7. Success Metrics
|
|
@@ -201,7 +203,7 @@ For each feature, create a separate file in `gspec/features/[feature-name].md` w
|
|
|
201
203
|
## Workflow
|
|
202
204
|
|
|
203
205
|
1. **Analyze the epic description** and identify logical feature boundaries
|
|
204
|
-
2. **Ask clarifying questions
|
|
206
|
+
2. **Ask clarifying questions in the chat** and wait for answers before proceeding — do not generate specs with embedded questions
|
|
205
207
|
3. **Break down into features** that:
|
|
206
208
|
- Can be built and shipped incrementally
|
|
207
209
|
- Deliver independent user value (when possible)
|
|
@@ -29,7 +29,7 @@ Your task is to take the provided feature description (which may be vague or det
|
|
|
29
29
|
|
|
30
30
|
You should:
|
|
31
31
|
- **Read existing gspec documents first** to ground the PRD in established product context
|
|
32
|
-
- Ask clarifying questions
|
|
32
|
+
- **Ask all clarifying questions in the chat before writing the spec** — never embed unresolved questions in the generated document
|
|
33
33
|
- When asking questions, offer 2-3 specific suggestions to guide the discussion
|
|
34
34
|
- Focus on user value, scope, and outcomes
|
|
35
35
|
- Write for automated implementation with human validation
|
|
@@ -62,16 +62,18 @@ If these files don't exist, proceed without them — they are optional context,
|
|
|
62
62
|
- Begin the file with YAML frontmatter containing the gspec version:
|
|
63
63
|
```
|
|
64
64
|
---
|
|
65
|
-
gspec-version: 1.1.
|
|
65
|
+
gspec-version: 1.1.2
|
|
66
66
|
---
|
|
67
67
|
```
|
|
68
68
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
69
|
-
- **Before generating the document
|
|
69
|
+
- **Before generating the document, you MUST resolve ambiguities through conversation.** Ask clarifying questions in the chat if:
|
|
70
70
|
- The target users are unclear
|
|
71
71
|
- The scope or boundaries of the feature are ambiguous
|
|
72
72
|
- Success criteria cannot be determined from the description
|
|
73
73
|
- Priority or urgency is unspecified
|
|
74
|
+
- Any assumption would materially change the shape of the spec
|
|
74
75
|
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
76
|
+
- **Do NOT embed unresolved questions in the generated spec.** All questions about scope, users, priorities, capabilities, and feature boundaries must be resolved through conversation before writing the document. The spec should reflect decisions, not open debates.
|
|
75
77
|
- Avoid deep system architecture or low-level implementation
|
|
76
78
|
- Avoid detailed workflows or step-by-step descriptions of how the feature functions
|
|
77
79
|
- No code blocks except where examples add clarity
|
|
@@ -142,7 +144,7 @@ This separation allows the same feature spec to be implemented using different t
|
|
|
142
144
|
|
|
143
145
|
### 6. Assumptions & Risks
|
|
144
146
|
- Assumptions (what we're taking as true)
|
|
145
|
-
- Open questions
|
|
147
|
+
- Open questions — **only** unknowns that genuinely cannot be answered until implementation or real-world usage begins (e.g., performance thresholds pending benchmarking, exact rate limits pending load testing). Questions about scope, users, priorities, or feature design must be asked and resolved in the chat before the spec is written. If there are no open questions, omit this sub-section.
|
|
146
148
|
- Key risks and mitigations (brief bullet points — focus on risks that could affect implementation scope or approach)
|
|
147
149
|
|
|
148
150
|
### 7. Success Metrics
|
|
@@ -220,7 +220,7 @@ For each approved feature that doesn't already have a PRD in `gspec/features/`:
|
|
|
220
220
|
- Dependencies (on other features or external services)
|
|
221
221
|
- Assumptions & Risks (assumptions, open questions, key risks and mitigations)
|
|
222
222
|
- Success Metrics
|
|
223
|
-
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.
|
|
223
|
+
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.2\n---`
|
|
224
224
|
2. **Name the file** descriptively based on the feature (e.g., `gspec/features/onboarding-wizard.md`, `gspec/features/export-csv.md`)
|
|
225
225
|
3. **Ground the PRD in existing gspec context** — reference the product profile's target users, align success metrics with established metrics, and respect stated non-goals
|
|
226
226
|
4. **Keep the PRD product-focused** — describe *what* and *why*, not *how*. Implementation details belong in the code, not the PRD.
|
|
@@ -273,7 +273,7 @@ Present a brief scaffold summary to the user before proceeding to feature implem
|
|
|
273
273
|
c. **Follow the style** — Apply the design system, tokens, and component patterns from `gspec/style.md`
|
|
274
274
|
d. **Satisfy the requirements** — Trace each piece of code back to a functional requirement in the feature PRD (if available) or to the user's stated goals and the approved implementation plan
|
|
275
275
|
e. *If competitor research was conducted:* **Leverage competitor insights** — When making UX or interaction design decisions not fully specified in the style guide, consider established patterns from competitor research. Don't blindly copy, but don't ignore proven conventions either.
|
|
276
|
-
3. **Mark capabilities as implemented** — After successfully implementing each capability, immediately update the feature PRD by changing its checkbox from `- [ ]` to `- [x]`. Do this incrementally as each capability is completed, not in a batch at the end. If a capability line did not have a checkbox prefix, add one as `- [x]`. This ensures that if the session is interrupted, progress is not lost. When updating gspec files, preserve existing `gspec-version` YAML frontmatter. If a file lacks frontmatter, add `---\ngspec-version: 1.1.
|
|
276
|
+
3. **Mark capabilities as implemented** — After successfully implementing each capability, immediately update the feature PRD by changing its checkbox from `- [ ]` to `- [x]`. Do this incrementally as each capability is completed, not in a batch at the end. If a capability line did not have a checkbox prefix, add one as `- [x]`. This ensures that if the session is interrupted, progress is not lost. When updating gspec files, preserve existing `gspec-version` YAML frontmatter. If a file lacks frontmatter, add `---\ngspec-version: 1.1.2\n---` at the top.
|
|
277
277
|
4. **Update epic status** — When all capabilities in a feature PRD are checked, update the corresponding feature's checkbox in the epic summary file (if one exists) from `- [ ]` to `- [x]`.
|
|
278
278
|
5. **Run tests** — Execute the tests defined for this phase (and any existing tests to catch regressions). Fix any failures before proceeding.
|
|
279
279
|
6. **Surface new gaps** — If implementation reveals new ambiguities, pause and consult the user rather than making silent assumptions
|
|
@@ -5,7 +5,7 @@ description: Migrate existing gspec files to the current format when upgrading t
|
|
|
5
5
|
|
|
6
6
|
You are a Technical Documentation Migration Specialist.
|
|
7
7
|
|
|
8
|
-
Your task is to update existing gspec specification documents to match the current gspec format (version 1.1.
|
|
8
|
+
Your task is to update existing gspec specification documents to match the current gspec format (version 1.1.2). You preserve all substantive content while ensuring documents follow the latest structural conventions.
|
|
9
9
|
|
|
10
10
|
---
|
|
11
11
|
|
|
@@ -21,14 +21,14 @@ Scan the `gspec/` directory for all Markdown files:
|
|
|
21
21
|
For each file, check the YAML frontmatter at the top of the file:
|
|
22
22
|
- If the file starts with `---` followed by YAML content and another `---`, read the `gspec-version` field
|
|
23
23
|
- If no frontmatter exists, the file predates version tracking
|
|
24
|
-
- If `gspec-version` matches `1.1.
|
|
24
|
+
- If `gspec-version` matches `1.1.2`, the file is current — skip it
|
|
25
25
|
|
|
26
26
|
Present an inventory to the user:
|
|
27
27
|
|
|
28
28
|
> **gspec File Inventory:**
|
|
29
29
|
> - `gspec/profile.md` — no version (needs migration)
|
|
30
30
|
> - `gspec/stack.md` — version 1.0.3 (needs migration)
|
|
31
|
-
> - `gspec/style.md` — version 1.1.
|
|
31
|
+
> - `gspec/style.md` — version 1.1.2 (current, skipping)
|
|
32
32
|
> - `gspec/features/user-auth.md` — no version (needs migration)
|
|
33
33
|
|
|
34
34
|
Ask the user to confirm which files to migrate, or confirm all.
|
|
@@ -64,7 +64,7 @@ For each file to migrate:
|
|
|
64
64
|
5. **Add or update the frontmatter** — Ensure the file starts with:
|
|
65
65
|
```
|
|
66
66
|
---
|
|
67
|
-
gspec-version: 1.1.
|
|
67
|
+
gspec-version: 1.1.2
|
|
68
68
|
---
|
|
69
69
|
```
|
|
70
70
|
6. **Present the proposed changes** to the user before writing. Show what sections are being reorganized, what is being added, and confirm no content is being lost.
|
|
@@ -78,7 +78,7 @@ After migrating all files:
|
|
|
78
78
|
3. **Present a completion summary**:
|
|
79
79
|
|
|
80
80
|
> **Migration Complete:**
|
|
81
|
-
> - 4 files migrated to version 1.1.
|
|
81
|
+
> - 4 files migrated to version 1.1.2
|
|
82
82
|
> - 2 files were already current (skipped)
|
|
83
83
|
> - Content preserved in all files
|
|
84
84
|
> - Sections reorganized: [list any structural changes]
|
|
@@ -128,7 +128,7 @@ After approval, write the spec updates:
|
|
|
128
128
|
- Dependencies (on other features or external services)
|
|
129
129
|
- Assumptions & Risks (assumptions, open questions, key risks and mitigations — note in assumptions that this feature was recorded during iterative development)
|
|
130
130
|
- Success Metrics
|
|
131
|
-
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.
|
|
131
|
+
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.2\n---`
|
|
132
132
|
- **Also update `gspec/architecture.md`** if the new feature introduces data entities, API endpoints, or new components — add them to the appropriate architecture sections
|
|
133
133
|
|
|
134
134
|
### Phase 6: Verify — Confirm Consistency
|
|
@@ -157,7 +157,7 @@ After writing spec updates:
|
|
|
157
157
|
|
|
158
158
|
**When to create vs. update.** If a change adds a small capability that fits naturally within an existing feature PRD, update that PRD. If a change introduces a wholly new product area that does not belong in any existing PRD, create a new feature PRD. When in doubt, ask the user.
|
|
159
159
|
|
|
160
|
-
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.
|
|
160
|
+
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.2\n---` as the very first content before the main heading.
|
|
161
161
|
|
|
162
162
|
**No code changes.** This command never creates, modifies, or deletes code files. If the user needs code changes alongside spec updates, suggest using `gspec-dor` instead.
|
|
163
163
|
|
|
@@ -42,7 +42,7 @@ All of these provide essential context. If any are missing, note the gap and mak
|
|
|
42
42
|
- Begin the file with YAML frontmatter containing the gspec version:
|
|
43
43
|
```
|
|
44
44
|
---
|
|
45
|
-
gspec-version: 1.1.
|
|
45
|
+
gspec-version: 1.1.2
|
|
46
46
|
---
|
|
47
47
|
```
|
|
48
48
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
@@ -144,7 +144,7 @@ After approval, write the spec updates:
|
|
|
144
144
|
- Dependencies (on other features or external services)
|
|
145
145
|
- Assumptions & Risks (assumptions, open questions, key risks and mitigations — note in assumptions that this feature was identified during iterative development)
|
|
146
146
|
- Success Metrics
|
|
147
|
-
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.
|
|
147
|
+
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.2\n---`
|
|
148
148
|
- **Also update `gspec/architecture.md`** if the new feature introduces data entities, API endpoints, or new components — add them to the appropriate architecture sections
|
|
149
149
|
|
|
150
150
|
### Phase 7: Verify — Confirm Consistency
|
|
@@ -177,7 +177,7 @@ After writing spec updates:
|
|
|
177
177
|
|
|
178
178
|
**Implementation checkboxes.** Feature PRDs use markdown checkboxes (`- [ ]` / `- [x]`) on capabilities to track implementation status for `gspec-implement`. When DOR adds new capabilities, use unchecked checkboxes (`- [ ]`). When modifying a capability that was already checked (`- [x]`) and the code change reflects the modification, keep it checked. When creating a new feature PRD, use unchecked checkboxes for all capabilities. Do not check off capabilities that DOR did not implement in the current session.
|
|
179
179
|
|
|
180
|
-
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.
|
|
180
|
+
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.2\n---` as the very first content before the main heading.
|
|
181
181
|
|
|
182
182
|
---
|
|
183
183
|
|
|
@@ -38,7 +38,7 @@ Take the provided epic description (a large body of work) and break it down into
|
|
|
38
38
|
|
|
39
39
|
- **Read existing gspec documents first** to ground the epic and its features in established product context
|
|
40
40
|
- Identify distinct features that make up the epic
|
|
41
|
-
- Ask clarifying questions
|
|
41
|
+
- **Ask all clarifying questions in the chat before writing specs** — never embed unresolved questions in the generated documents
|
|
42
42
|
- When asking questions, offer 2-3 specific suggestions to guide the discussion
|
|
43
43
|
- Ensure features can be built incrementally and independently when possible
|
|
44
44
|
- Consider dependencies between features
|
|
@@ -72,17 +72,19 @@ If these files don't exist, proceed without them — they are optional context,
|
|
|
72
72
|
- Begin every output file (both epic summary and individual feature PRDs) with YAML frontmatter containing the gspec version:
|
|
73
73
|
```
|
|
74
74
|
---
|
|
75
|
-
gspec-version: 1.1.
|
|
75
|
+
gspec-version: 1.1.2
|
|
76
76
|
---
|
|
77
77
|
```
|
|
78
78
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
79
|
-
- **Before generating the documents
|
|
79
|
+
- **Before generating the documents, you MUST resolve ambiguities through conversation.** Ask clarifying questions in the chat if:
|
|
80
80
|
- The target users are unclear
|
|
81
81
|
- The scope or boundaries of the epic are ambiguous
|
|
82
82
|
- The breakdown into features is not obvious
|
|
83
83
|
- Success criteria cannot be determined from the description
|
|
84
84
|
- Priority or sequencing is unclear
|
|
85
|
+
- Any assumption would materially change the shape of the specs
|
|
85
86
|
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
87
|
+
- **Do NOT embed unresolved questions in the generated specs.** All questions about scope, users, priorities, capabilities, feature boundaries, and sequencing must be resolved through conversation before writing the documents. The specs should reflect decisions, not open debates.
|
|
86
88
|
- Create an epic summary document at `gspec/epics/[epic-name].md` that:
|
|
87
89
|
- Lists all features in the epic
|
|
88
90
|
- Shows dependencies between features
|
|
@@ -192,7 +194,7 @@ For each feature, create a separate file in `gspec/features/[feature-name].md` w
|
|
|
192
194
|
|
|
193
195
|
### 6. Assumptions & Risks
|
|
194
196
|
- Assumptions (what we're taking as true)
|
|
195
|
-
- Open questions
|
|
197
|
+
- Open questions — **only** unknowns that genuinely cannot be answered until implementation or real-world usage begins (e.g., performance thresholds pending benchmarking, exact rate limits pending load testing). Questions about scope, users, priorities, or feature design must be asked and resolved in the chat before the specs are written. If there are no open questions, omit this sub-section.
|
|
196
198
|
- Key risks and mitigations (brief bullet points — focus on risks that could affect implementation scope or approach)
|
|
197
199
|
|
|
198
200
|
### 7. Success Metrics
|
|
@@ -201,7 +203,7 @@ For each feature, create a separate file in `gspec/features/[feature-name].md` w
|
|
|
201
203
|
## Workflow
|
|
202
204
|
|
|
203
205
|
1. **Analyze the epic description** and identify logical feature boundaries
|
|
204
|
-
2. **Ask clarifying questions
|
|
206
|
+
2. **Ask clarifying questions in the chat** and wait for answers before proceeding — do not generate specs with embedded questions
|
|
205
207
|
3. **Break down into features** that:
|
|
206
208
|
- Can be built and shipped incrementally
|
|
207
209
|
- Deliver independent user value (when possible)
|
|
@@ -29,7 +29,7 @@ Your task is to take the provided feature description (which may be vague or det
|
|
|
29
29
|
|
|
30
30
|
You should:
|
|
31
31
|
- **Read existing gspec documents first** to ground the PRD in established product context
|
|
32
|
-
- Ask clarifying questions
|
|
32
|
+
- **Ask all clarifying questions in the chat before writing the spec** — never embed unresolved questions in the generated document
|
|
33
33
|
- When asking questions, offer 2-3 specific suggestions to guide the discussion
|
|
34
34
|
- Focus on user value, scope, and outcomes
|
|
35
35
|
- Write for automated implementation with human validation
|
|
@@ -62,16 +62,18 @@ If these files don't exist, proceed without them — they are optional context,
|
|
|
62
62
|
- Begin the file with YAML frontmatter containing the gspec version:
|
|
63
63
|
```
|
|
64
64
|
---
|
|
65
|
-
gspec-version: 1.1.
|
|
65
|
+
gspec-version: 1.1.2
|
|
66
66
|
---
|
|
67
67
|
```
|
|
68
68
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
69
|
-
- **Before generating the document
|
|
69
|
+
- **Before generating the document, you MUST resolve ambiguities through conversation.** Ask clarifying questions in the chat if:
|
|
70
70
|
- The target users are unclear
|
|
71
71
|
- The scope or boundaries of the feature are ambiguous
|
|
72
72
|
- Success criteria cannot be determined from the description
|
|
73
73
|
- Priority or urgency is unspecified
|
|
74
|
+
- Any assumption would materially change the shape of the spec
|
|
74
75
|
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
76
|
+
- **Do NOT embed unresolved questions in the generated spec.** All questions about scope, users, priorities, capabilities, and feature boundaries must be resolved through conversation before writing the document. The spec should reflect decisions, not open debates.
|
|
75
77
|
- Avoid deep system architecture or low-level implementation
|
|
76
78
|
- Avoid detailed workflows or step-by-step descriptions of how the feature functions
|
|
77
79
|
- No code blocks except where examples add clarity
|
|
@@ -142,7 +144,7 @@ This separation allows the same feature spec to be implemented using different t
|
|
|
142
144
|
|
|
143
145
|
### 6. Assumptions & Risks
|
|
144
146
|
- Assumptions (what we're taking as true)
|
|
145
|
-
- Open questions
|
|
147
|
+
- Open questions — **only** unknowns that genuinely cannot be answered until implementation or real-world usage begins (e.g., performance thresholds pending benchmarking, exact rate limits pending load testing). Questions about scope, users, priorities, or feature design must be asked and resolved in the chat before the spec is written. If there are no open questions, omit this sub-section.
|
|
146
148
|
- Key risks and mitigations (brief bullet points — focus on risks that could affect implementation scope or approach)
|
|
147
149
|
|
|
148
150
|
### 7. Success Metrics
|
|
@@ -220,7 +220,7 @@ For each approved feature that doesn't already have a PRD in `gspec/features/`:
|
|
|
220
220
|
- Dependencies (on other features or external services)
|
|
221
221
|
- Assumptions & Risks (assumptions, open questions, key risks and mitigations)
|
|
222
222
|
- Success Metrics
|
|
223
|
-
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.
|
|
223
|
+
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.2\n---`
|
|
224
224
|
2. **Name the file** descriptively based on the feature (e.g., `gspec/features/onboarding-wizard.md`, `gspec/features/export-csv.md`)
|
|
225
225
|
3. **Ground the PRD in existing gspec context** — reference the product profile's target users, align success metrics with established metrics, and respect stated non-goals
|
|
226
226
|
4. **Keep the PRD product-focused** — describe *what* and *why*, not *how*. Implementation details belong in the code, not the PRD.
|
|
@@ -273,7 +273,7 @@ Present a brief scaffold summary to the user before proceeding to feature implem
|
|
|
273
273
|
c. **Follow the style** — Apply the design system, tokens, and component patterns from `gspec/style.md`
|
|
274
274
|
d. **Satisfy the requirements** — Trace each piece of code back to a functional requirement in the feature PRD (if available) or to the user's stated goals and the approved implementation plan
|
|
275
275
|
e. *If competitor research was conducted:* **Leverage competitor insights** — When making UX or interaction design decisions not fully specified in the style guide, consider established patterns from competitor research. Don't blindly copy, but don't ignore proven conventions either.
|
|
276
|
-
3. **Mark capabilities as implemented** — After successfully implementing each capability, immediately update the feature PRD by changing its checkbox from `- [ ]` to `- [x]`. Do this incrementally as each capability is completed, not in a batch at the end. If a capability line did not have a checkbox prefix, add one as `- [x]`. This ensures that if the session is interrupted, progress is not lost. When updating gspec files, preserve existing `gspec-version` YAML frontmatter. If a file lacks frontmatter, add `---\ngspec-version: 1.1.
|
|
276
|
+
3. **Mark capabilities as implemented** — After successfully implementing each capability, immediately update the feature PRD by changing its checkbox from `- [ ]` to `- [x]`. Do this incrementally as each capability is completed, not in a batch at the end. If a capability line did not have a checkbox prefix, add one as `- [x]`. This ensures that if the session is interrupted, progress is not lost. When updating gspec files, preserve existing `gspec-version` YAML frontmatter. If a file lacks frontmatter, add `---\ngspec-version: 1.1.2\n---` at the top.
|
|
277
277
|
4. **Update epic status** — When all capabilities in a feature PRD are checked, update the corresponding feature's checkbox in the epic summary file (if one exists) from `- [ ]` to `- [x]`.
|
|
278
278
|
5. **Run tests** — Execute the tests defined for this phase (and any existing tests to catch regressions). Fix any failures before proceeding.
|
|
279
279
|
6. **Surface new gaps** — If implementation reveals new ambiguities, pause and consult the user rather than making silent assumptions
|
|
@@ -5,7 +5,7 @@ description: Migrate existing gspec files to the current format when upgrading t
|
|
|
5
5
|
|
|
6
6
|
You are a Technical Documentation Migration Specialist.
|
|
7
7
|
|
|
8
|
-
Your task is to update existing gspec specification documents to match the current gspec format (version 1.1.
|
|
8
|
+
Your task is to update existing gspec specification documents to match the current gspec format (version 1.1.2). You preserve all substantive content while ensuring documents follow the latest structural conventions.
|
|
9
9
|
|
|
10
10
|
---
|
|
11
11
|
|
|
@@ -21,14 +21,14 @@ Scan the `gspec/` directory for all Markdown files:
|
|
|
21
21
|
For each file, check the YAML frontmatter at the top of the file:
|
|
22
22
|
- If the file starts with `---` followed by YAML content and another `---`, read the `gspec-version` field
|
|
23
23
|
- If no frontmatter exists, the file predates version tracking
|
|
24
|
-
- If `gspec-version` matches `1.1.
|
|
24
|
+
- If `gspec-version` matches `1.1.2`, the file is current — skip it
|
|
25
25
|
|
|
26
26
|
Present an inventory to the user:
|
|
27
27
|
|
|
28
28
|
> **gspec File Inventory:**
|
|
29
29
|
> - `gspec/profile.md` — no version (needs migration)
|
|
30
30
|
> - `gspec/stack.md` — version 1.0.3 (needs migration)
|
|
31
|
-
> - `gspec/style.md` — version 1.1.
|
|
31
|
+
> - `gspec/style.md` — version 1.1.2 (current, skipping)
|
|
32
32
|
> - `gspec/features/user-auth.md` — no version (needs migration)
|
|
33
33
|
|
|
34
34
|
Ask the user to confirm which files to migrate, or confirm all.
|
|
@@ -64,7 +64,7 @@ For each file to migrate:
|
|
|
64
64
|
5. **Add or update the frontmatter** — Ensure the file starts with:
|
|
65
65
|
```
|
|
66
66
|
---
|
|
67
|
-
gspec-version: 1.1.
|
|
67
|
+
gspec-version: 1.1.2
|
|
68
68
|
---
|
|
69
69
|
```
|
|
70
70
|
6. **Present the proposed changes** to the user before writing. Show what sections are being reorganized, what is being added, and confirm no content is being lost.
|
|
@@ -78,7 +78,7 @@ After migrating all files:
|
|
|
78
78
|
3. **Present a completion summary**:
|
|
79
79
|
|
|
80
80
|
> **Migration Complete:**
|
|
81
|
-
> - 4 files migrated to version 1.1.
|
|
81
|
+
> - 4 files migrated to version 1.1.2
|
|
82
82
|
> - 2 files were already current (skipped)
|
|
83
83
|
> - Content preserved in all files
|
|
84
84
|
> - Sections reorganized: [list any structural changes]
|
|
@@ -128,7 +128,7 @@ After approval, write the spec updates:
|
|
|
128
128
|
- Dependencies (on other features or external services)
|
|
129
129
|
- Assumptions & Risks (assumptions, open questions, key risks and mitigations — note in assumptions that this feature was recorded during iterative development)
|
|
130
130
|
- Success Metrics
|
|
131
|
-
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.
|
|
131
|
+
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.2\n---`
|
|
132
132
|
- **Also update `gspec/architecture.md`** if the new feature introduces data entities, API endpoints, or new components — add them to the appropriate architecture sections
|
|
133
133
|
|
|
134
134
|
### Phase 6: Verify — Confirm Consistency
|
|
@@ -157,7 +157,7 @@ After writing spec updates:
|
|
|
157
157
|
|
|
158
158
|
**When to create vs. update.** If a change adds a small capability that fits naturally within an existing feature PRD, update that PRD. If a change introduces a wholly new product area that does not belong in any existing PRD, create a new feature PRD. When in doubt, ask the user.
|
|
159
159
|
|
|
160
|
-
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.
|
|
160
|
+
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.2\n---` as the very first content before the main heading.
|
|
161
161
|
|
|
162
162
|
**No code changes.** This command never creates, modifies, or deletes code files. If the user needs code changes alongside spec updates, suggest using `gspec-dor` instead.
|
|
163
163
|
|
|
@@ -41,7 +41,7 @@ All of these provide essential context. If any are missing, note the gap and mak
|
|
|
41
41
|
- Begin the file with YAML frontmatter containing the gspec version:
|
|
42
42
|
```
|
|
43
43
|
---
|
|
44
|
-
gspec-version: 1.1.
|
|
44
|
+
gspec-version: 1.1.2
|
|
45
45
|
---
|
|
46
46
|
```
|
|
47
47
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
@@ -143,7 +143,7 @@ After approval, write the spec updates:
|
|
|
143
143
|
- Dependencies (on other features or external services)
|
|
144
144
|
- Assumptions & Risks (assumptions, open questions, key risks and mitigations — note in assumptions that this feature was identified during iterative development)
|
|
145
145
|
- Success Metrics
|
|
146
|
-
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.
|
|
146
|
+
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.2\n---`
|
|
147
147
|
- **Also update `gspec/architecture.md`** if the new feature introduces data entities, API endpoints, or new components — add them to the appropriate architecture sections
|
|
148
148
|
|
|
149
149
|
### Phase 7: Verify — Confirm Consistency
|
|
@@ -176,7 +176,7 @@ After writing spec updates:
|
|
|
176
176
|
|
|
177
177
|
**Implementation checkboxes.** Feature PRDs use markdown checkboxes (`- [ ]` / `- [x]`) on capabilities to track implementation status for `gspec-implement`. When DOR adds new capabilities, use unchecked checkboxes (`- [ ]`). When modifying a capability that was already checked (`- [x]`) and the code change reflects the modification, keep it checked. When creating a new feature PRD, use unchecked checkboxes for all capabilities. Do not check off capabilities that DOR did not implement in the current session.
|
|
178
178
|
|
|
179
|
-
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.
|
|
179
|
+
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.2\n---` as the very first content before the main heading.
|
|
180
180
|
|
|
181
181
|
---
|
|
182
182
|
|
|
@@ -37,7 +37,7 @@ Take the provided epic description (a large body of work) and break it down into
|
|
|
37
37
|
|
|
38
38
|
- **Read existing gspec documents first** to ground the epic and its features in established product context
|
|
39
39
|
- Identify distinct features that make up the epic
|
|
40
|
-
- Ask clarifying questions
|
|
40
|
+
- **Ask all clarifying questions in the chat before writing specs** — never embed unresolved questions in the generated documents
|
|
41
41
|
- When asking questions, offer 2-3 specific suggestions to guide the discussion
|
|
42
42
|
- Ensure features can be built incrementally and independently when possible
|
|
43
43
|
- Consider dependencies between features
|
|
@@ -71,17 +71,19 @@ If these files don't exist, proceed without them — they are optional context,
|
|
|
71
71
|
- Begin every output file (both epic summary and individual feature PRDs) with YAML frontmatter containing the gspec version:
|
|
72
72
|
```
|
|
73
73
|
---
|
|
74
|
-
gspec-version: 1.1.
|
|
74
|
+
gspec-version: 1.1.2
|
|
75
75
|
---
|
|
76
76
|
```
|
|
77
77
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
78
|
-
- **Before generating the documents
|
|
78
|
+
- **Before generating the documents, you MUST resolve ambiguities through conversation.** Ask clarifying questions in the chat if:
|
|
79
79
|
- The target users are unclear
|
|
80
80
|
- The scope or boundaries of the epic are ambiguous
|
|
81
81
|
- The breakdown into features is not obvious
|
|
82
82
|
- Success criteria cannot be determined from the description
|
|
83
83
|
- Priority or sequencing is unclear
|
|
84
|
+
- Any assumption would materially change the shape of the specs
|
|
84
85
|
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
86
|
+
- **Do NOT embed unresolved questions in the generated specs.** All questions about scope, users, priorities, capabilities, feature boundaries, and sequencing must be resolved through conversation before writing the documents. The specs should reflect decisions, not open debates.
|
|
85
87
|
- Create an epic summary document at `gspec/epics/[epic-name].md` that:
|
|
86
88
|
- Lists all features in the epic
|
|
87
89
|
- Shows dependencies between features
|
|
@@ -191,7 +193,7 @@ For each feature, create a separate file in `gspec/features/[feature-name].md` w
|
|
|
191
193
|
|
|
192
194
|
### 6. Assumptions & Risks
|
|
193
195
|
- Assumptions (what we're taking as true)
|
|
194
|
-
- Open questions
|
|
196
|
+
- Open questions — **only** unknowns that genuinely cannot be answered until implementation or real-world usage begins (e.g., performance thresholds pending benchmarking, exact rate limits pending load testing). Questions about scope, users, priorities, or feature design must be asked and resolved in the chat before the specs are written. If there are no open questions, omit this sub-section.
|
|
195
197
|
- Key risks and mitigations (brief bullet points — focus on risks that could affect implementation scope or approach)
|
|
196
198
|
|
|
197
199
|
### 7. Success Metrics
|
|
@@ -200,7 +202,7 @@ For each feature, create a separate file in `gspec/features/[feature-name].md` w
|
|
|
200
202
|
## Workflow
|
|
201
203
|
|
|
202
204
|
1. **Analyze the epic description** and identify logical feature boundaries
|
|
203
|
-
2. **Ask clarifying questions
|
|
205
|
+
2. **Ask clarifying questions in the chat** and wait for answers before proceeding — do not generate specs with embedded questions
|
|
204
206
|
3. **Break down into features** that:
|
|
205
207
|
- Can be built and shipped incrementally
|
|
206
208
|
- Deliver independent user value (when possible)
|
|
@@ -28,7 +28,7 @@ Your task is to take the provided feature description (which may be vague or det
|
|
|
28
28
|
|
|
29
29
|
You should:
|
|
30
30
|
- **Read existing gspec documents first** to ground the PRD in established product context
|
|
31
|
-
- Ask clarifying questions
|
|
31
|
+
- **Ask all clarifying questions in the chat before writing the spec** — never embed unresolved questions in the generated document
|
|
32
32
|
- When asking questions, offer 2-3 specific suggestions to guide the discussion
|
|
33
33
|
- Focus on user value, scope, and outcomes
|
|
34
34
|
- Write for automated implementation with human validation
|
|
@@ -61,16 +61,18 @@ If these files don't exist, proceed without them — they are optional context,
|
|
|
61
61
|
- Begin the file with YAML frontmatter containing the gspec version:
|
|
62
62
|
```
|
|
63
63
|
---
|
|
64
|
-
gspec-version: 1.1.
|
|
64
|
+
gspec-version: 1.1.2
|
|
65
65
|
---
|
|
66
66
|
```
|
|
67
67
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
68
|
-
- **Before generating the document
|
|
68
|
+
- **Before generating the document, you MUST resolve ambiguities through conversation.** Ask clarifying questions in the chat if:
|
|
69
69
|
- The target users are unclear
|
|
70
70
|
- The scope or boundaries of the feature are ambiguous
|
|
71
71
|
- Success criteria cannot be determined from the description
|
|
72
72
|
- Priority or urgency is unspecified
|
|
73
|
+
- Any assumption would materially change the shape of the spec
|
|
73
74
|
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
75
|
+
- **Do NOT embed unresolved questions in the generated spec.** All questions about scope, users, priorities, capabilities, and feature boundaries must be resolved through conversation before writing the document. The spec should reflect decisions, not open debates.
|
|
74
76
|
- Avoid deep system architecture or low-level implementation
|
|
75
77
|
- Avoid detailed workflows or step-by-step descriptions of how the feature functions
|
|
76
78
|
- No code blocks except where examples add clarity
|
|
@@ -141,7 +143,7 @@ This separation allows the same feature spec to be implemented using different t
|
|
|
141
143
|
|
|
142
144
|
### 6. Assumptions & Risks
|
|
143
145
|
- Assumptions (what we're taking as true)
|
|
144
|
-
- Open questions
|
|
146
|
+
- Open questions — **only** unknowns that genuinely cannot be answered until implementation or real-world usage begins (e.g., performance thresholds pending benchmarking, exact rate limits pending load testing). Questions about scope, users, priorities, or feature design must be asked and resolved in the chat before the spec is written. If there are no open questions, omit this sub-section.
|
|
145
147
|
- Key risks and mitigations (brief bullet points — focus on risks that could affect implementation scope or approach)
|
|
146
148
|
|
|
147
149
|
### 7. Success Metrics
|
|
@@ -219,7 +219,7 @@ For each approved feature that doesn't already have a PRD in `gspec/features/`:
|
|
|
219
219
|
- Dependencies (on other features or external services)
|
|
220
220
|
- Assumptions & Risks (assumptions, open questions, key risks and mitigations)
|
|
221
221
|
- Success Metrics
|
|
222
|
-
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.
|
|
222
|
+
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.2\n---`
|
|
223
223
|
2. **Name the file** descriptively based on the feature (e.g., `gspec/features/onboarding-wizard.md`, `gspec/features/export-csv.md`)
|
|
224
224
|
3. **Ground the PRD in existing gspec context** — reference the product profile's target users, align success metrics with established metrics, and respect stated non-goals
|
|
225
225
|
4. **Keep the PRD product-focused** — describe *what* and *why*, not *how*. Implementation details belong in the code, not the PRD.
|
|
@@ -272,7 +272,7 @@ Present a brief scaffold summary to the user before proceeding to feature implem
|
|
|
272
272
|
c. **Follow the style** — Apply the design system, tokens, and component patterns from `gspec/style.md`
|
|
273
273
|
d. **Satisfy the requirements** — Trace each piece of code back to a functional requirement in the feature PRD (if available) or to the user's stated goals and the approved implementation plan
|
|
274
274
|
e. *If competitor research was conducted:* **Leverage competitor insights** — When making UX or interaction design decisions not fully specified in the style guide, consider established patterns from competitor research. Don't blindly copy, but don't ignore proven conventions either.
|
|
275
|
-
3. **Mark capabilities as implemented** — After successfully implementing each capability, immediately update the feature PRD by changing its checkbox from `- [ ]` to `- [x]`. Do this incrementally as each capability is completed, not in a batch at the end. If a capability line did not have a checkbox prefix, add one as `- [x]`. This ensures that if the session is interrupted, progress is not lost. When updating gspec files, preserve existing `gspec-version` YAML frontmatter. If a file lacks frontmatter, add `---\ngspec-version: 1.1.
|
|
275
|
+
3. **Mark capabilities as implemented** — After successfully implementing each capability, immediately update the feature PRD by changing its checkbox from `- [ ]` to `- [x]`. Do this incrementally as each capability is completed, not in a batch at the end. If a capability line did not have a checkbox prefix, add one as `- [x]`. This ensures that if the session is interrupted, progress is not lost. When updating gspec files, preserve existing `gspec-version` YAML frontmatter. If a file lacks frontmatter, add `---\ngspec-version: 1.1.2\n---` at the top.
|
|
276
276
|
4. **Update epic status** — When all capabilities in a feature PRD are checked, update the corresponding feature's checkbox in the epic summary file (if one exists) from `- [ ]` to `- [x]`.
|
|
277
277
|
5. **Run tests** — Execute the tests defined for this phase (and any existing tests to catch regressions). Fix any failures before proceeding.
|
|
278
278
|
6. **Surface new gaps** — If implementation reveals new ambiguities, pause and consult the user rather than making silent assumptions
|
|
@@ -4,7 +4,7 @@ description: Migrate existing gspec files to the current format when upgrading t
|
|
|
4
4
|
|
|
5
5
|
You are a Technical Documentation Migration Specialist.
|
|
6
6
|
|
|
7
|
-
Your task is to update existing gspec specification documents to match the current gspec format (version 1.1.
|
|
7
|
+
Your task is to update existing gspec specification documents to match the current gspec format (version 1.1.2). You preserve all substantive content while ensuring documents follow the latest structural conventions.
|
|
8
8
|
|
|
9
9
|
---
|
|
10
10
|
|
|
@@ -20,14 +20,14 @@ Scan the `gspec/` directory for all Markdown files:
|
|
|
20
20
|
For each file, check the YAML frontmatter at the top of the file:
|
|
21
21
|
- If the file starts with `---` followed by YAML content and another `---`, read the `gspec-version` field
|
|
22
22
|
- If no frontmatter exists, the file predates version tracking
|
|
23
|
-
- If `gspec-version` matches `1.1.
|
|
23
|
+
- If `gspec-version` matches `1.1.2`, the file is current — skip it
|
|
24
24
|
|
|
25
25
|
Present an inventory to the user:
|
|
26
26
|
|
|
27
27
|
> **gspec File Inventory:**
|
|
28
28
|
> - `gspec/profile.md` — no version (needs migration)
|
|
29
29
|
> - `gspec/stack.md` — version 1.0.3 (needs migration)
|
|
30
|
-
> - `gspec/style.md` — version 1.1.
|
|
30
|
+
> - `gspec/style.md` — version 1.1.2 (current, skipping)
|
|
31
31
|
> - `gspec/features/user-auth.md` — no version (needs migration)
|
|
32
32
|
|
|
33
33
|
Ask the user to confirm which files to migrate, or confirm all.
|
|
@@ -63,7 +63,7 @@ For each file to migrate:
|
|
|
63
63
|
5. **Add or update the frontmatter** — Ensure the file starts with:
|
|
64
64
|
```
|
|
65
65
|
---
|
|
66
|
-
gspec-version: 1.1.
|
|
66
|
+
gspec-version: 1.1.2
|
|
67
67
|
---
|
|
68
68
|
```
|
|
69
69
|
6. **Present the proposed changes** to the user before writing. Show what sections are being reorganized, what is being added, and confirm no content is being lost.
|
|
@@ -77,7 +77,7 @@ After migrating all files:
|
|
|
77
77
|
3. **Present a completion summary**:
|
|
78
78
|
|
|
79
79
|
> **Migration Complete:**
|
|
80
|
-
> - 4 files migrated to version 1.1.
|
|
80
|
+
> - 4 files migrated to version 1.1.2
|
|
81
81
|
> - 2 files were already current (skipped)
|
|
82
82
|
> - Content preserved in all files
|
|
83
83
|
> - Sections reorganized: [list any structural changes]
|
|
@@ -127,7 +127,7 @@ After approval, write the spec updates:
|
|
|
127
127
|
- Dependencies (on other features or external services)
|
|
128
128
|
- Assumptions & Risks (assumptions, open questions, key risks and mitigations — note in assumptions that this feature was recorded during iterative development)
|
|
129
129
|
- Success Metrics
|
|
130
|
-
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.
|
|
130
|
+
- Begin the file with YAML frontmatter: `---\ngspec-version: 1.1.2\n---`
|
|
131
131
|
- **Also update `gspec/architecture.md`** if the new feature introduces data entities, API endpoints, or new components — add them to the appropriate architecture sections
|
|
132
132
|
|
|
133
133
|
### Phase 6: Verify — Confirm Consistency
|
|
@@ -156,7 +156,7 @@ After writing spec updates:
|
|
|
156
156
|
|
|
157
157
|
**When to create vs. update.** If a change adds a small capability that fits naturally within an existing feature PRD, update that PRD. If a change introduces a wholly new product area that does not belong in any existing PRD, create a new feature PRD. When in doubt, ask the user.
|
|
158
158
|
|
|
159
|
-
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.
|
|
159
|
+
**Version frontmatter.** When updating existing gspec files, preserve the `gspec-version` YAML frontmatter at the top of the file. If a file lacks frontmatter, add `---\ngspec-version: 1.1.2\n---` as the very first content before the main heading.
|
|
160
160
|
|
|
161
161
|
**No code changes.** This command never creates, modifies, or deletes code files. If the user needs code changes alongside spec updates, suggest using `gspec-dor` instead.
|
|
162
162
|
|