gspec 1.1.0 → 1.1.1
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 +16 -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 +1 -1
- package/dist/antigravity/gspec-feature/SKILL.md +1 -1
- 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 +1 -1
- package/dist/claude/gspec-feature/SKILL.md +1 -1
- 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 +1 -1
- package/dist/cursor/gspec-feature.mdc +1 -1
- 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
|
@@ -24,7 +24,7 @@ These documents become the shared context for all subsequent AI interactions. Wh
|
|
|
24
24
|
### The Workflow
|
|
25
25
|
|
|
26
26
|
```
|
|
27
|
-
Define → Specify → Build → Iterate
|
|
27
|
+
Define → Specify → Architect → Build → Iterate
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
**1. Define the Fundamentals** — Establish the foundation that drives every decision.
|
|
@@ -43,19 +43,31 @@ Define → Specify → Build → Iterate
|
|
|
43
43
|
| `gspec.feature` | Product Manager | PRD for a single feature with prioritized capabilities |
|
|
44
44
|
| `gspec.epic` | Product Manager | Breaks a large epic into multiple feature PRDs with dependency mapping |
|
|
45
45
|
|
|
46
|
-
**3.
|
|
46
|
+
**3. Architect** — Translate specs into a concrete technical blueprint.
|
|
47
|
+
|
|
48
|
+
| Command | Role | What it produces |
|
|
49
|
+
|---|---|---|
|
|
50
|
+
| `gspec.architect` | Senior Architect | Technical architecture document with data models, API design, project structure, auth flows, and Mermaid diagrams |
|
|
51
|
+
|
|
52
|
+
**4. Build** — Implement with full context.
|
|
47
53
|
|
|
48
54
|
| Command | Role | What it does |
|
|
49
55
|
|---|---|---|
|
|
50
56
|
| `gspec.implement` | Senior Engineer | Reads all specs, identifies gaps, researches competitors, plans and builds |
|
|
51
57
|
|
|
52
|
-
**
|
|
58
|
+
**5. Iterate** — Keep specs and code in sync as the project evolves.
|
|
53
59
|
|
|
54
60
|
| Command | Role | What it does |
|
|
55
61
|
|---|---|---|
|
|
56
62
|
| `gspec.dor` | Engineer + Doc Lead | Makes code changes and updates specs to match |
|
|
57
63
|
| `gspec.record` | Doc Lead | Updates specs to reflect decisions or changes — no code modifications |
|
|
58
64
|
|
|
65
|
+
**Maintenance** — Keep specs up to date with the latest gspec format.
|
|
66
|
+
|
|
67
|
+
| Command | Role | What it does |
|
|
68
|
+
|---|---|---|
|
|
69
|
+
| `gspec.migrate` | Migration Specialist | Updates existing gspec documents to the current format when you upgrade gspec, preserving all content |
|
|
70
|
+
|
|
59
71
|
Each command is self-contained and will ask clarifying questions when essential information is missing.
|
|
60
72
|
|
|
61
73
|
## Installation
|
|
@@ -95,6 +107,7 @@ project-root/
|
|
|
95
107
|
├── style.md # Visual design language
|
|
96
108
|
├── stack.md # Technology stack and architecture
|
|
97
109
|
├── practices.md # Development standards
|
|
110
|
+
├── architecture.md # Technical architecture blueprint
|
|
98
111
|
├── epics/
|
|
99
112
|
│ └── onboarding-flow.md
|
|
100
113
|
└── features/
|
|
@@ -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.1
|
|
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.1\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.1\n---` as the very first content before the main heading.
|
|
181
181
|
|
|
182
182
|
---
|
|
183
183
|
|
|
@@ -72,7 +72,7 @@ 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.1
|
|
76
76
|
---
|
|
77
77
|
```
|
|
78
78
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
@@ -62,7 +62,7 @@ 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.1
|
|
66
66
|
---
|
|
67
67
|
```
|
|
68
68
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
@@ -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.1\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.1\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.1). 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.1`, 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.1 (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.1
|
|
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.1
|
|
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.1\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.1\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.1
|
|
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.1\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.1\n---` as the very first content before the main heading.
|
|
181
181
|
|
|
182
182
|
---
|
|
183
183
|
|
|
@@ -72,7 +72,7 @@ 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.1
|
|
76
76
|
---
|
|
77
77
|
```
|
|
78
78
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
@@ -62,7 +62,7 @@ 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.1
|
|
66
66
|
---
|
|
67
67
|
```
|
|
68
68
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
@@ -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.1\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.1\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.1). 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.1`, 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.1 (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.1
|
|
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.1
|
|
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.1\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.1\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.1
|
|
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.1\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.1\n---` as the very first content before the main heading.
|
|
180
180
|
|
|
181
181
|
---
|
|
182
182
|
|
|
@@ -71,7 +71,7 @@ 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.1
|
|
75
75
|
---
|
|
76
76
|
```
|
|
77
77
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
@@ -61,7 +61,7 @@ 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.1
|
|
65
65
|
---
|
|
66
66
|
```
|
|
67
67
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
@@ -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.1\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.1\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.1). 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.1`, 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.1 (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.1
|
|
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.1
|
|
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.1\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.1\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
|
|