gspec 1.6.0 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/README.md +4 -7
  2. package/bin/gspec.js +275 -8
  3. package/commands/gspec.analyze.md +2 -4
  4. package/commands/gspec.architect.md +2 -3
  5. package/commands/gspec.feature.md +37 -7
  6. package/commands/gspec.implement.md +14 -19
  7. package/commands/gspec.migrate.md +1 -2
  8. package/commands/gspec.practices.md +3 -1
  9. package/commands/gspec.research.md +1 -1
  10. package/commands/gspec.stack.md +11 -6
  11. package/commands/gspec.style.md +18 -23
  12. package/dist/antigravity/gspec-analyze/SKILL.md +2 -4
  13. package/dist/antigravity/gspec-architect/SKILL.md +3 -4
  14. package/dist/antigravity/gspec-feature/SKILL.md +39 -9
  15. package/dist/antigravity/gspec-implement/SKILL.md +15 -20
  16. package/dist/antigravity/gspec-migrate/SKILL.md +6 -7
  17. package/dist/antigravity/gspec-practices/SKILL.md +4 -2
  18. package/dist/antigravity/gspec-profile/SKILL.md +1 -1
  19. package/dist/antigravity/gspec-research/SKILL.md +4 -4
  20. package/dist/antigravity/gspec-stack/SKILL.md +12 -7
  21. package/dist/antigravity/gspec-style/SKILL.md +19 -24
  22. package/dist/claude/gspec-analyze/SKILL.md +2 -4
  23. package/dist/claude/gspec-architect/SKILL.md +3 -4
  24. package/dist/claude/gspec-feature/SKILL.md +39 -9
  25. package/dist/claude/gspec-implement/SKILL.md +15 -20
  26. package/dist/claude/gspec-migrate/SKILL.md +6 -7
  27. package/dist/claude/gspec-practices/SKILL.md +4 -2
  28. package/dist/claude/gspec-profile/SKILL.md +1 -1
  29. package/dist/claude/gspec-research/SKILL.md +4 -4
  30. package/dist/claude/gspec-stack/SKILL.md +12 -7
  31. package/dist/claude/gspec-style/SKILL.md +19 -24
  32. package/dist/codex/gspec-analyze/SKILL.md +2 -4
  33. package/dist/codex/gspec-architect/SKILL.md +3 -4
  34. package/dist/codex/gspec-feature/SKILL.md +39 -9
  35. package/dist/codex/gspec-implement/SKILL.md +15 -20
  36. package/dist/codex/gspec-migrate/SKILL.md +6 -7
  37. package/dist/codex/gspec-practices/SKILL.md +4 -2
  38. package/dist/codex/gspec-profile/SKILL.md +1 -1
  39. package/dist/codex/gspec-research/SKILL.md +4 -4
  40. package/dist/codex/gspec-stack/SKILL.md +12 -7
  41. package/dist/codex/gspec-style/SKILL.md +19 -24
  42. package/dist/cursor/gspec-analyze.mdc +2 -4
  43. package/dist/cursor/gspec-architect.mdc +3 -4
  44. package/dist/cursor/gspec-feature.mdc +39 -9
  45. package/dist/cursor/gspec-implement.mdc +15 -20
  46. package/dist/cursor/gspec-migrate.mdc +6 -7
  47. package/dist/cursor/gspec-practices.mdc +4 -2
  48. package/dist/cursor/gspec-profile.mdc +1 -1
  49. package/dist/cursor/gspec-research.mdc +4 -4
  50. package/dist/cursor/gspec-stack.mdc +12 -7
  51. package/dist/cursor/gspec-style.mdc +19 -24
  52. package/dist/opencode/gspec-analyze/SKILL.md +168 -0
  53. package/dist/opencode/gspec-architect/SKILL.md +361 -0
  54. package/dist/opencode/gspec-feature/SKILL.md +204 -0
  55. package/dist/opencode/gspec-implement/SKILL.md +200 -0
  56. package/dist/opencode/gspec-migrate/SKILL.md +118 -0
  57. package/dist/opencode/gspec-practices/SKILL.md +137 -0
  58. package/dist/opencode/gspec-profile/SKILL.md +221 -0
  59. package/dist/opencode/gspec-research/SKILL.md +302 -0
  60. package/dist/opencode/gspec-stack/SKILL.md +305 -0
  61. package/dist/opencode/gspec-style/SKILL.md +224 -0
  62. package/package.json +3 -1
  63. package/starters/features/about-page.md +98 -0
  64. package/starters/features/contact-form.md +147 -0
  65. package/starters/features/contact-page.md +103 -0
  66. package/starters/features/home-page.md +103 -0
  67. package/starters/features/responsive-navbar.md +113 -0
  68. package/starters/features/services-page.md +103 -0
  69. package/starters/features/site-footer.md +121 -0
  70. package/starters/features/theme-switcher.md +124 -0
  71. package/starters/practices/tdd-pipeline-first.md +192 -0
  72. package/starters/stacks/astro-tailwind-github-pages.md +283 -0
  73. package/starters/stacks/nextjs-supabase-vercel.md +319 -0
  74. package/starters/stacks/nextjs-vercel-typescript.md +264 -0
  75. package/starters/styles/clean-professional.md +316 -0
  76. package/starters/styles/dark-minimal-developer.md +442 -0
  77. package/templates/spec-sync.md +2 -2
  78. package/commands/gspec.epic.md +0 -228
  79. package/dist/antigravity/gspec-epic/SKILL.md +0 -232
  80. package/dist/claude/gspec-epic/SKILL.md +0 -233
  81. package/dist/codex/gspec-epic/SKILL.md +0 -232
  82. package/dist/cursor/gspec-epic.mdc +0 -231
@@ -1,233 +0,0 @@
1
- ---
2
- name: gspec-epic
3
- description: Break down a large epic into multiple focused feature PRDs with dependency mapping
4
- ---
5
-
6
- You are a senior Product Manager at a high-performing software company.
7
-
8
- Generate multiple Product Requirements Documents (PRDs) from a high-level epic description.
9
-
10
- ## Task
11
-
12
- Take the provided epic description (a large body of work) and break it down into **multiple focused Product Requirements Documents (PRDs)**, each representing a distinct feature or component that can be built independently.
13
-
14
- ## Important: Agent-Oriented Documentation
15
-
16
- **These epics and PRDs are designed for automated agent consumption** (via `gspec-implement`), with humans validating the content for accuracy and completeness. Write documents that are:
17
-
18
- - **Implementation-ready blueprints**, not project plans
19
- - Focused on **what** to build and **why**, not **when** or **how long**
20
- - Clear on technical and functional requirements an agent needs to execute
21
-
22
- **AVOID project management details:**
23
- - ❌ Sprint planning, week numbers, or timeline estimates
24
- - ❌ Team assignments or resource allocation
25
- - ❌ Velocity or story point estimates
26
- - ❌ Delivery schedules or milestone dates
27
- - ❌ "Phase 1 ships in Q2" or similar calendar commitments
28
-
29
- **DO include implementation guidance:**
30
- - ✅ Clear functional requirements and acceptance criteria
31
- - ✅ Dependencies between features (technical, not temporal)
32
- - ✅ Priority levels (P0, P1, P2) for scope decisions
33
- - ✅ Build order recommendations based on technical dependencies
34
- - ✅ Minimum viable epic (MVE) scope definition
35
- - ✅ Feature sequencing based on what must be built first
36
-
37
- ## Guidelines
38
-
39
- - **Read existing feature PRDs and epics** in `gspec/features/` and `gspec/epics/` to understand already-specified work and avoid overlap
40
- - Identify distinct features that make up the epic
41
- - **Ask all clarifying questions in the chat before writing specs** — never embed unresolved questions in the generated documents
42
- - When asking questions, offer 2-3 specific suggestions to guide the discussion
43
- - Ensure features can be built incrementally and independently when possible
44
- - Consider dependencies between features
45
- - Focus on user value, scope, and outcomes
46
- - Write for automated implementation with human validation
47
- - Be concise, structured, and decisive
48
-
49
- ---
50
-
51
- ## Portability
52
-
53
- Epic summaries and the feature PRDs they produce are designed to be **portable across projects**. A feature spec written for one project should be reusable in a different project with a different profile, design system, tech stack, and development practices. Project-specific context is resolved at implementation time by `gspec-implement`, which reads all gspec documents (profile, style, stack, practices) alongside the feature PRDs.
54
-
55
- **To maintain portability, DO NOT read or incorporate context from:**
56
- - `gspec/profile.md` — Do not reference project-specific personas, competitive landscape, or positioning
57
- - `gspec/style.md` — Do not reference a specific design system or component library
58
- - `gspec/stack.md` — Do not reference specific technologies (already covered by Technology Agnosticism)
59
- - `gspec/practices.md` — Do not reference project-specific development standards
60
-
61
- **DO read existing feature PRDs and epics** in `gspec/features/` and `gspec/epics/` to:
62
- - Avoid duplicating or contradicting already-specified features
63
- - Identify cross-feature and cross-epic dependencies
64
- - Ensure consistent scope boundaries and terminology
65
-
66
- **Write in generic, portable terms:**
67
- - Use relative role descriptions ("primary users", "administrators", "content creators") not project-specific persona names
68
- - Justify priorities based on intrinsic user value and technical dependencies, not competitive landscape
69
- - Describe desired UX behavior generically ("clear error feedback", "responsive layout") without referencing a specific design system
70
- - Define success metrics in terms of each feature's own outcomes, not project-level KPIs
71
- - Sequence features based on logical dependencies, not project-specific stack constraints
72
-
73
- ## Output Rules
74
-
75
- - Output **multiple** Markdown documents (one per feature)
76
- - Save each file to the `gspec/features/` folder in the root of the project (create if it doesn't exist)
77
- - Name each file based on the feature (e.g., `user-authentication.md`, `dashboard-analytics.md`)
78
- - Begin every output file (both epic summary and individual feature PRDs) with YAML frontmatter containing the gspec version:
79
- ```
80
- ---
81
- gspec-version: 1.6.0
82
- ---
83
- ```
84
- The frontmatter must be the very first content in the file, before the main heading.
85
- - **Before generating the documents, you MUST resolve ambiguities through conversation.** Ask clarifying questions in the chat if:
86
- - The target users are unclear
87
- - The scope or boundaries of the epic are ambiguous
88
- - The breakdown into features is not obvious
89
- - Success criteria cannot be determined from the description
90
- - Priority or sequencing is unclear
91
- - Any assumption would materially change the shape of the specs
92
- - **When asking questions**, offer 2-3 specific suggestions to guide the discussion
93
- - **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.
94
- - Create an epic summary document at `gspec/epics/[epic-name].md` that:
95
- - Lists all features in the epic
96
- - Shows dependencies between features
97
- - Provides a high-level roadmap or phasing suggestion
98
- - Links to each individual feature PRD
99
- - Avoid deep system architecture or low-level implementation
100
- - No code blocks except where examples add clarity
101
- - Clear acceptance criteria are required for each capability
102
- - Make tradeoffs and scope explicit
103
-
104
- ### Technology Agnosticism
105
-
106
- **IMPORTANT**: Epic and feature PRDs must remain technology-agnostic to enable implementation with different technology stacks. The `gspec/stack.md` file is the single source of truth for technology choices.
107
-
108
- **DO use generic architectural terms:**
109
- - ✅ "database", "data store", "persistent storage"
110
- - ✅ "authentication service", "IAM", "identity provider"
111
- - ✅ "API", "backend service", "server"
112
- - ✅ "frontend", "client application", "user interface"
113
- - ✅ "message queue", "event system", "pub/sub"
114
- - ✅ "object storage", "file storage"
115
- - ✅ "cache", "caching layer"
116
- - ✅ "search index", "full-text search"
117
-
118
- **DO NOT reference specific technologies:**
119
- - ❌ React, Vue, Angular, Svelte
120
- - ❌ PostgreSQL, MySQL, MongoDB, DynamoDB
121
- - ❌ AWS Lambda, Google Cloud Functions, Azure Functions
122
- - ❌ Redis, Memcached
123
- - ❌ Elasticsearch, Algolia, Solr
124
- - ❌ S3, GCS, Azure Blob Storage
125
- - ❌ Kafka, RabbitMQ, SQS
126
-
127
- This separation — combined with the portability principles above — allows the same epic and feature specs to be reused across projects with different technology stacks, design systems, and product contexts.
128
-
129
- ## Epic Summary Document Structure
130
-
131
- **IMPORTANT**: Only include the sections listed below. Do NOT add additional sections such as "Technology Notes", "Implementation Details", "Technical Architecture", or any other custom sections. Stick strictly to this structure.
132
-
133
- Create a file at `gspec/epics/[epic-name].md` with:
134
-
135
- ### 1. Epic Overview
136
- - Epic name
137
- - Executive summary
138
- - Strategic objective
139
-
140
- ### 2. Features Breakdown
141
- - List of all features with links to their PRDs, **using unchecked markdown checkboxes** (e.g., `- [ ] **P0**: [Feature Name](../features/feature-name.md) — Brief description`). The `gspec-implement` command will check these off (`- [x]`) as features are fully implemented, allowing incremental runs.
142
- - Brief description of each feature
143
- - Priority level (P0, P1, P2)
144
- - Estimated sequencing/dependencies
145
-
146
- ### 3. Success Metrics
147
- - Overall epic success criteria
148
- - Key performance indicators
149
- - How features collectively deliver value
150
-
151
- ### 4. Dependencies & Risks
152
- - Inter-feature dependencies
153
- - Technical dependencies
154
- - Business risks
155
- - Mitigation strategies
156
-
157
- ### 5. Phasing Recommendation
158
- - Suggested build order
159
- - Rationale for sequencing
160
- - Minimum viable epic (MVE) scope
161
-
162
- ## Individual Feature PRD Structure
163
-
164
- **IMPORTANT**: Only include the sections listed below. Do NOT add additional sections such as "Technology Notes", "Implementation Details", "Technical Architecture", or any other custom sections. Stick strictly to this structure.
165
-
166
- For each feature, create a separate file in `gspec/features/[feature-name].md` with:
167
-
168
- ### 1. Overview
169
- - Feature name
170
- - Summary (1-2 sentences)
171
- - Problem being solved and why it matters now
172
- - **Parent Epic** (link to epic summary)
173
-
174
- ### 2. Users & Use Cases
175
- - Primary users (use generic role descriptions like "end users", "administrators", "content managers" — not project-specific persona names)
176
- - Key use cases (3-4 scenarios showing how users benefit)
177
-
178
- ### 3. Scope
179
- - In-scope goals
180
- - Out-of-scope items (things this feature explicitly won't do)
181
- - Deferred ideas (things we may do later, but not now)
182
-
183
- ### 4. Capabilities
184
- - What the feature provides to users, written in user-focused language
185
- - **Priority level** for each capability (P0 = must-have, P1 = should-have, P2 = nice-to-have)
186
- - Focus on *what* users can do, not *how* they do it — include UX expectations (empty states, error handling, key flows) as acceptance criteria on the relevant capabilities
187
- - **Use unchecked markdown checkboxes** for each capability to enable implementation tracking (e.g., `- [ ] **P0**: User can create an account`). The `gspec-implement` command will check these off (`- [x]`) as capabilities are implemented, allowing incremental runs.
188
- - **Each capability MUST include brief acceptance criteria** — 2-4 testable conditions that define "done" for that capability. These tell the implementing agent exactly when a capability is complete and give test writers concrete assertions. Format as a sub-list under each capability:
189
- ```
190
- - [ ] **P0**: User can create an account
191
- - Valid email + strong password → account is created and confirmation is sent
192
- - Duplicate email → error message explains email is taken
193
- - Weak password → inline validation shows password requirements
194
- ```
195
-
196
- ### 5. Dependencies
197
- - Dependencies on other features in this epic
198
- - External dependencies
199
- - If none, state "None"
200
-
201
- ### 6. Assumptions & Risks
202
- - Assumptions (what we're taking as true)
203
- - 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.
204
- - Key risks and mitigations (brief bullet points — focus on risks that could affect implementation scope or approach)
205
-
206
- ### 7. Success Metrics
207
- - 2-4 measurable outcomes that define whether this feature is working
208
-
209
- ### 8. Implementation Context
210
- - Include the following standard note verbatim:
211
- > This feature PRD is portable and project-agnostic. During implementation, consult the project's `gspec/profile.md` (target users, positioning), `gspec/style.md` (design system), `gspec/stack.md` (technology choices), and `gspec/practices.md` (development standards) to resolve project-specific context.
212
-
213
- ## Workflow
214
-
215
- 1. **Analyze the epic description** and identify logical feature boundaries
216
- 2. **Ask clarifying questions in the chat** and wait for answers before proceeding — do not generate specs with embedded questions
217
- 3. **Break down into features** that:
218
- - Can be built and shipped incrementally
219
- - Deliver independent user value (when possible)
220
- - Have clear boundaries and responsibilities
221
- - Consider technical and business dependencies
222
- 4. **Create the epic summary** document first
223
- 5. **Generate individual feature PRDs** for each feature
224
- 6. **Ensure consistency** across all documents (terminology, user personas, metrics)
225
-
226
- ## Tone & Style
227
-
228
- - Clear, neutral, product-led
229
- - No fluff, no jargon
230
- - Designed to be skimmed
231
- - Consistent across all generated documents
232
-
233
- $ARGUMENTS
@@ -1,232 +0,0 @@
1
- ---
2
- name: gspec-epic
3
- description: Break down a large epic into multiple focused feature PRDs with dependency mapping
4
- ---
5
-
6
- You are a senior Product Manager at a high-performing software company.
7
-
8
- Generate multiple Product Requirements Documents (PRDs) from a high-level epic description.
9
-
10
- ## Task
11
-
12
- Take the provided epic description (a large body of work) and break it down into **multiple focused Product Requirements Documents (PRDs)**, each representing a distinct feature or component that can be built independently.
13
-
14
- ## Important: Agent-Oriented Documentation
15
-
16
- **These epics and PRDs are designed for automated agent consumption** (via `gspec-implement`), with humans validating the content for accuracy and completeness. Write documents that are:
17
-
18
- - **Implementation-ready blueprints**, not project plans
19
- - Focused on **what** to build and **why**, not **when** or **how long**
20
- - Clear on technical and functional requirements an agent needs to execute
21
-
22
- **AVOID project management details:**
23
- - ❌ Sprint planning, week numbers, or timeline estimates
24
- - ❌ Team assignments or resource allocation
25
- - ❌ Velocity or story point estimates
26
- - ❌ Delivery schedules or milestone dates
27
- - ❌ "Phase 1 ships in Q2" or similar calendar commitments
28
-
29
- **DO include implementation guidance:**
30
- - ✅ Clear functional requirements and acceptance criteria
31
- - ✅ Dependencies between features (technical, not temporal)
32
- - ✅ Priority levels (P0, P1, P2) for scope decisions
33
- - ✅ Build order recommendations based on technical dependencies
34
- - ✅ Minimum viable epic (MVE) scope definition
35
- - ✅ Feature sequencing based on what must be built first
36
-
37
- ## Guidelines
38
-
39
- - **Read existing feature PRDs and epics** in `gspec/features/` and `gspec/epics/` to understand already-specified work and avoid overlap
40
- - Identify distinct features that make up the epic
41
- - **Ask all clarifying questions in the chat before writing specs** — never embed unresolved questions in the generated documents
42
- - When asking questions, offer 2-3 specific suggestions to guide the discussion
43
- - Ensure features can be built incrementally and independently when possible
44
- - Consider dependencies between features
45
- - Focus on user value, scope, and outcomes
46
- - Write for automated implementation with human validation
47
- - Be concise, structured, and decisive
48
-
49
- ---
50
-
51
- ## Portability
52
-
53
- Epic summaries and the feature PRDs they produce are designed to be **portable across projects**. A feature spec written for one project should be reusable in a different project with a different profile, design system, tech stack, and development practices. Project-specific context is resolved at implementation time by `gspec-implement`, which reads all gspec documents (profile, style, stack, practices) alongside the feature PRDs.
54
-
55
- **To maintain portability, DO NOT read or incorporate context from:**
56
- - `gspec/profile.md` — Do not reference project-specific personas, competitive landscape, or positioning
57
- - `gspec/style.md` — Do not reference a specific design system or component library
58
- - `gspec/stack.md` — Do not reference specific technologies (already covered by Technology Agnosticism)
59
- - `gspec/practices.md` — Do not reference project-specific development standards
60
-
61
- **DO read existing feature PRDs and epics** in `gspec/features/` and `gspec/epics/` to:
62
- - Avoid duplicating or contradicting already-specified features
63
- - Identify cross-feature and cross-epic dependencies
64
- - Ensure consistent scope boundaries and terminology
65
-
66
- **Write in generic, portable terms:**
67
- - Use relative role descriptions ("primary users", "administrators", "content creators") not project-specific persona names
68
- - Justify priorities based on intrinsic user value and technical dependencies, not competitive landscape
69
- - Describe desired UX behavior generically ("clear error feedback", "responsive layout") without referencing a specific design system
70
- - Define success metrics in terms of each feature's own outcomes, not project-level KPIs
71
- - Sequence features based on logical dependencies, not project-specific stack constraints
72
-
73
- ## Output Rules
74
-
75
- - Output **multiple** Markdown documents (one per feature)
76
- - Save each file to the `gspec/features/` folder in the root of the project (create if it doesn't exist)
77
- - Name each file based on the feature (e.g., `user-authentication.md`, `dashboard-analytics.md`)
78
- - Begin every output file (both epic summary and individual feature PRDs) with YAML frontmatter containing the gspec version:
79
- ```
80
- ---
81
- gspec-version: 1.6.0
82
- ---
83
- ```
84
- The frontmatter must be the very first content in the file, before the main heading.
85
- - **Before generating the documents, you MUST resolve ambiguities through conversation.** Ask clarifying questions in the chat if:
86
- - The target users are unclear
87
- - The scope or boundaries of the epic are ambiguous
88
- - The breakdown into features is not obvious
89
- - Success criteria cannot be determined from the description
90
- - Priority or sequencing is unclear
91
- - Any assumption would materially change the shape of the specs
92
- - **When asking questions**, offer 2-3 specific suggestions to guide the discussion
93
- - **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.
94
- - Create an epic summary document at `gspec/epics/[epic-name].md` that:
95
- - Lists all features in the epic
96
- - Shows dependencies between features
97
- - Provides a high-level roadmap or phasing suggestion
98
- - Links to each individual feature PRD
99
- - Avoid deep system architecture or low-level implementation
100
- - No code blocks except where examples add clarity
101
- - Clear acceptance criteria are required for each capability
102
- - Make tradeoffs and scope explicit
103
-
104
- ### Technology Agnosticism
105
-
106
- **IMPORTANT**: Epic and feature PRDs must remain technology-agnostic to enable implementation with different technology stacks. The `gspec/stack.md` file is the single source of truth for technology choices.
107
-
108
- **DO use generic architectural terms:**
109
- - ✅ "database", "data store", "persistent storage"
110
- - ✅ "authentication service", "IAM", "identity provider"
111
- - ✅ "API", "backend service", "server"
112
- - ✅ "frontend", "client application", "user interface"
113
- - ✅ "message queue", "event system", "pub/sub"
114
- - ✅ "object storage", "file storage"
115
- - ✅ "cache", "caching layer"
116
- - ✅ "search index", "full-text search"
117
-
118
- **DO NOT reference specific technologies:**
119
- - ❌ React, Vue, Angular, Svelte
120
- - ❌ PostgreSQL, MySQL, MongoDB, DynamoDB
121
- - ❌ AWS Lambda, Google Cloud Functions, Azure Functions
122
- - ❌ Redis, Memcached
123
- - ❌ Elasticsearch, Algolia, Solr
124
- - ❌ S3, GCS, Azure Blob Storage
125
- - ❌ Kafka, RabbitMQ, SQS
126
-
127
- This separation — combined with the portability principles above — allows the same epic and feature specs to be reused across projects with different technology stacks, design systems, and product contexts.
128
-
129
- ## Epic Summary Document Structure
130
-
131
- **IMPORTANT**: Only include the sections listed below. Do NOT add additional sections such as "Technology Notes", "Implementation Details", "Technical Architecture", or any other custom sections. Stick strictly to this structure.
132
-
133
- Create a file at `gspec/epics/[epic-name].md` with:
134
-
135
- ### 1. Epic Overview
136
- - Epic name
137
- - Executive summary
138
- - Strategic objective
139
-
140
- ### 2. Features Breakdown
141
- - List of all features with links to their PRDs, **using unchecked markdown checkboxes** (e.g., `- [ ] **P0**: [Feature Name](../features/feature-name.md) — Brief description`). The `gspec-implement` command will check these off (`- [x]`) as features are fully implemented, allowing incremental runs.
142
- - Brief description of each feature
143
- - Priority level (P0, P1, P2)
144
- - Estimated sequencing/dependencies
145
-
146
- ### 3. Success Metrics
147
- - Overall epic success criteria
148
- - Key performance indicators
149
- - How features collectively deliver value
150
-
151
- ### 4. Dependencies & Risks
152
- - Inter-feature dependencies
153
- - Technical dependencies
154
- - Business risks
155
- - Mitigation strategies
156
-
157
- ### 5. Phasing Recommendation
158
- - Suggested build order
159
- - Rationale for sequencing
160
- - Minimum viable epic (MVE) scope
161
-
162
- ## Individual Feature PRD Structure
163
-
164
- **IMPORTANT**: Only include the sections listed below. Do NOT add additional sections such as "Technology Notes", "Implementation Details", "Technical Architecture", or any other custom sections. Stick strictly to this structure.
165
-
166
- For each feature, create a separate file in `gspec/features/[feature-name].md` with:
167
-
168
- ### 1. Overview
169
- - Feature name
170
- - Summary (1-2 sentences)
171
- - Problem being solved and why it matters now
172
- - **Parent Epic** (link to epic summary)
173
-
174
- ### 2. Users & Use Cases
175
- - Primary users (use generic role descriptions like "end users", "administrators", "content managers" — not project-specific persona names)
176
- - Key use cases (3-4 scenarios showing how users benefit)
177
-
178
- ### 3. Scope
179
- - In-scope goals
180
- - Out-of-scope items (things this feature explicitly won't do)
181
- - Deferred ideas (things we may do later, but not now)
182
-
183
- ### 4. Capabilities
184
- - What the feature provides to users, written in user-focused language
185
- - **Priority level** for each capability (P0 = must-have, P1 = should-have, P2 = nice-to-have)
186
- - Focus on *what* users can do, not *how* they do it — include UX expectations (empty states, error handling, key flows) as acceptance criteria on the relevant capabilities
187
- - **Use unchecked markdown checkboxes** for each capability to enable implementation tracking (e.g., `- [ ] **P0**: User can create an account`). The `gspec-implement` command will check these off (`- [x]`) as capabilities are implemented, allowing incremental runs.
188
- - **Each capability MUST include brief acceptance criteria** — 2-4 testable conditions that define "done" for that capability. These tell the implementing agent exactly when a capability is complete and give test writers concrete assertions. Format as a sub-list under each capability:
189
- ```
190
- - [ ] **P0**: User can create an account
191
- - Valid email + strong password → account is created and confirmation is sent
192
- - Duplicate email → error message explains email is taken
193
- - Weak password → inline validation shows password requirements
194
- ```
195
-
196
- ### 5. Dependencies
197
- - Dependencies on other features in this epic
198
- - External dependencies
199
- - If none, state "None"
200
-
201
- ### 6. Assumptions & Risks
202
- - Assumptions (what we're taking as true)
203
- - 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.
204
- - Key risks and mitigations (brief bullet points — focus on risks that could affect implementation scope or approach)
205
-
206
- ### 7. Success Metrics
207
- - 2-4 measurable outcomes that define whether this feature is working
208
-
209
- ### 8. Implementation Context
210
- - Include the following standard note verbatim:
211
- > This feature PRD is portable and project-agnostic. During implementation, consult the project's `gspec/profile.md` (target users, positioning), `gspec/style.md` (design system), `gspec/stack.md` (technology choices), and `gspec/practices.md` (development standards) to resolve project-specific context.
212
-
213
- ## Workflow
214
-
215
- 1. **Analyze the epic description** and identify logical feature boundaries
216
- 2. **Ask clarifying questions in the chat** and wait for answers before proceeding — do not generate specs with embedded questions
217
- 3. **Break down into features** that:
218
- - Can be built and shipped incrementally
219
- - Deliver independent user value (when possible)
220
- - Have clear boundaries and responsibilities
221
- - Consider technical and business dependencies
222
- 4. **Create the epic summary** document first
223
- 5. **Generate individual feature PRDs** for each feature
224
- 6. **Ensure consistency** across all documents (terminology, user personas, metrics)
225
-
226
- ## Tone & Style
227
-
228
- - Clear, neutral, product-led
229
- - No fluff, no jargon
230
- - Designed to be skimmed
231
- - Consistent across all generated documents
232
-