gspec 1.14.0 → 1.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -9
- package/bin/gspec.js +218 -59
- package/commands/gspec.analyze.md +13 -8
- package/commands/gspec.audit.md +202 -0
- package/commands/gspec.implement.md +10 -7
- package/commands/gspec.migrate.md +29 -15
- package/commands/gspec.profile.md +55 -35
- package/commands/gspec.style.md +64 -12
- package/dist/antigravity/gspec-analyze/SKILL.md +14 -9
- package/dist/antigravity/gspec-architect/SKILL.md +1 -1
- package/dist/antigravity/gspec-audit/SKILL.md +206 -0
- package/dist/antigravity/gspec-feature/SKILL.md +1 -1
- package/dist/antigravity/gspec-implement/SKILL.md +11 -8
- package/dist/antigravity/gspec-migrate/SKILL.md +30 -16
- package/dist/antigravity/gspec-practices/SKILL.md +1 -1
- package/dist/antigravity/gspec-profile/SKILL.md +56 -36
- package/dist/antigravity/gspec-research/SKILL.md +1 -1
- package/dist/antigravity/gspec-stack/SKILL.md +1 -1
- package/dist/antigravity/gspec-style/SKILL.md +65 -13
- package/dist/claude/gspec-analyze/SKILL.md +14 -9
- package/dist/claude/gspec-architect/SKILL.md +1 -1
- package/dist/claude/gspec-audit/SKILL.md +207 -0
- package/dist/claude/gspec-feature/SKILL.md +1 -1
- package/dist/claude/gspec-implement/SKILL.md +11 -8
- package/dist/claude/gspec-migrate/SKILL.md +30 -16
- package/dist/claude/gspec-practices/SKILL.md +1 -1
- package/dist/claude/gspec-profile/SKILL.md +56 -36
- package/dist/claude/gspec-research/SKILL.md +1 -1
- package/dist/claude/gspec-stack/SKILL.md +1 -1
- package/dist/claude/gspec-style/SKILL.md +65 -13
- package/dist/codex/gspec-analyze/SKILL.md +14 -9
- package/dist/codex/gspec-architect/SKILL.md +1 -1
- package/dist/codex/gspec-audit/SKILL.md +206 -0
- package/dist/codex/gspec-feature/SKILL.md +1 -1
- package/dist/codex/gspec-implement/SKILL.md +11 -8
- package/dist/codex/gspec-migrate/SKILL.md +30 -16
- package/dist/codex/gspec-practices/SKILL.md +1 -1
- package/dist/codex/gspec-profile/SKILL.md +56 -36
- package/dist/codex/gspec-research/SKILL.md +1 -1
- package/dist/codex/gspec-stack/SKILL.md +1 -1
- package/dist/codex/gspec-style/SKILL.md +65 -13
- package/dist/cursor/gspec-analyze.mdc +14 -9
- package/dist/cursor/gspec-architect.mdc +1 -1
- package/dist/cursor/gspec-audit.mdc +205 -0
- package/dist/cursor/gspec-feature.mdc +1 -1
- package/dist/cursor/gspec-implement.mdc +11 -8
- package/dist/cursor/gspec-migrate.mdc +30 -16
- package/dist/cursor/gspec-practices.mdc +1 -1
- package/dist/cursor/gspec-profile.mdc +56 -36
- package/dist/cursor/gspec-research.mdc +1 -1
- package/dist/cursor/gspec-stack.mdc +1 -1
- package/dist/cursor/gspec-style.mdc +65 -13
- package/dist/opencode/gspec-analyze/SKILL.md +14 -9
- package/dist/opencode/gspec-architect/SKILL.md +1 -1
- package/dist/opencode/gspec-audit/SKILL.md +206 -0
- package/dist/opencode/gspec-feature/SKILL.md +1 -1
- package/dist/opencode/gspec-implement/SKILL.md +11 -8
- package/dist/opencode/gspec-migrate/SKILL.md +30 -16
- package/dist/opencode/gspec-practices/SKILL.md +1 -1
- package/dist/opencode/gspec-profile/SKILL.md +56 -36
- package/dist/opencode/gspec-research/SKILL.md +1 -1
- package/dist/opencode/gspec-stack/SKILL.md +1 -1
- package/dist/opencode/gspec-style/SKILL.md +65 -13
- package/package.json +1 -1
- package/templates/spec-sync.md +24 -2
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: gspec-profile
|
|
3
|
-
description: Generate
|
|
3
|
+
description: Generate or update the product profile (gspec/profile.md) — what the product is, who it serves, and why it exists. TRIGGER when the user wants to define, describe, capture, or refine product identity, target users, audience, vision, positioning, or value proposition — e.g. "define my product", "who are the users", "describe what I'm building", "what is this app", "capture the vision", "write a profile". Prefer this skill over drafting a profile ad hoc.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
You are a
|
|
6
|
+
You are a Product Strategist.
|
|
7
7
|
|
|
8
|
-
Your task is to take the provided
|
|
8
|
+
Your task is to take the provided product, tool, or system concept and produce a **Product Profile** that clearly defines what it is, who it serves, and why it exists. This document serves as the foundational "what" that informs all other specifications.
|
|
9
|
+
|
|
10
|
+
The product may be commercial (SaaS, mobile app, marketplace) **or** non-commercial (open source library, internal tool, CLI utility, research software, personal project, etc.). Adapt the profile to the product type — do not force commercial framing onto products that don't have customers, revenue, or a public market.
|
|
9
11
|
|
|
10
12
|
You should:
|
|
11
13
|
- Define the product's identity and purpose clearly
|
|
@@ -13,7 +15,7 @@ You should:
|
|
|
13
15
|
- Articulate the value proposition
|
|
14
16
|
- **Ask clarifying questions when essential information is missing** rather than guessing
|
|
15
17
|
- **Offer 2-3 specific suggestions** when strategic direction is unclear
|
|
16
|
-
- Think from a
|
|
18
|
+
- Think from a user and purpose perspective, not technical implementation
|
|
17
19
|
- Be clear, compelling, and strategic
|
|
18
20
|
|
|
19
21
|
---
|
|
@@ -29,27 +31,30 @@ You should:
|
|
|
29
31
|
---
|
|
30
32
|
```
|
|
31
33
|
The frontmatter must be the very first content in the file, before the main heading.
|
|
32
|
-
- **Before generating the document**,
|
|
33
|
-
|
|
34
|
+
- **Before generating the document**, first determine the **product type** (commercial, internal tool, open source, research, personal, etc.) if it isn't obvious from the input. This determines which sections apply.
|
|
35
|
+
- **Ask clarifying questions** if:
|
|
36
|
+
- The product type is ambiguous
|
|
37
|
+
- The target audience or user is unclear
|
|
34
38
|
- The core value proposition is ambiguous
|
|
35
|
-
- The business model or monetization strategy is unspecified
|
|
36
|
-
- Competitive positioning is unknown
|
|
39
|
+
- *(Commercial products only)* The business model or monetization strategy is unspecified
|
|
40
|
+
- *(Commercial products only)* Competitive positioning is unknown
|
|
37
41
|
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
38
|
-
- Write for
|
|
42
|
+
- Write for the audience the product actually has (internal stakeholders, end users, contributors, the public, etc.)
|
|
39
43
|
- Be concise but comprehensive
|
|
40
44
|
- Focus on the "what" and "why", not the "how"
|
|
41
45
|
- Use clear, jargon-free language where possible
|
|
42
|
-
- **Mark sections as "Not Applicable"** when they don't apply to this product
|
|
46
|
+
- **Mark sections as "Not Applicable"** when they don't apply to this product, and briefly note why (e.g., "Not applicable — internal tool, no external market"). Do not fabricate content to fill a section.
|
|
43
47
|
|
|
44
48
|
---
|
|
45
49
|
|
|
46
50
|
## Required Sections
|
|
47
51
|
|
|
48
52
|
### 1. Product Overview
|
|
49
|
-
- Product
|
|
53
|
+
- Product name
|
|
50
54
|
- Tagline or one-sentence description
|
|
51
|
-
- Category (e.g., SaaS platform, mobile app, marketplace,
|
|
52
|
-
-
|
|
55
|
+
- Category (e.g., SaaS platform, mobile app, marketplace, open source library, internal tool, CLI utility, developer tool, research software, personal project, game, etc.)
|
|
56
|
+
- Product type (commercial, internal, open source, research, personal, etc.) — determines which later sections apply
|
|
57
|
+
- Current stage (concept, MVP, beta, launched, scaling, maintained, etc.)
|
|
53
58
|
|
|
54
59
|
### 2. Mission & Vision
|
|
55
60
|
|
|
@@ -64,7 +69,7 @@ You should:
|
|
|
64
69
|
### 3. Target Audience
|
|
65
70
|
|
|
66
71
|
#### Primary Users
|
|
67
|
-
- Who are they? (
|
|
72
|
+
- Who are they? (roles, characteristics, context in which they use the product)
|
|
68
73
|
- What are their key pain points?
|
|
69
74
|
- What are their goals and motivations?
|
|
70
75
|
|
|
@@ -73,7 +78,7 @@ You should:
|
|
|
73
78
|
- How they differ from primary users
|
|
74
79
|
|
|
75
80
|
#### Stakeholders
|
|
76
|
-
- Who else is impacted? (buyers, administrators, partners, etc.)
|
|
81
|
+
- Who else is impacted? (buyers, administrators, partners, maintainers, contributors, etc.)
|
|
77
82
|
|
|
78
83
|
### 4. Value Proposition
|
|
79
84
|
|
|
@@ -112,18 +117,22 @@ You should:
|
|
|
112
117
|
|
|
113
118
|
### 7. Market & Competition
|
|
114
119
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
- Market
|
|
120
|
+
*Skip or mark "Not Applicable" for internal tools, personal projects, or anything without an external market. Open source projects should adapt this to the ecosystem/alternatives landscape rather than a commercial market.*
|
|
121
|
+
|
|
122
|
+
#### Market or Ecosystem Context
|
|
123
|
+
- Market size and opportunity (commercial) **or** ecosystem landscape (OSS, research)
|
|
124
|
+
- Trends driving demand or adoption
|
|
125
|
+
- Maturity of the space
|
|
119
126
|
|
|
120
|
-
#### Competitive Landscape
|
|
121
|
-
- Direct competitors
|
|
122
|
-
- Indirect competitors or
|
|
127
|
+
#### Competitive Landscape or Alternatives
|
|
128
|
+
- Direct competitors or comparable projects
|
|
129
|
+
- Indirect competitors, alternatives, or incumbent approaches
|
|
123
130
|
- White space or gaps this product fills
|
|
124
131
|
|
|
125
132
|
### 8. Business Model
|
|
126
133
|
|
|
134
|
+
*Skip or mark "Not Applicable" for non-commercial products (internal tools, open source, personal projects, research). For OSS, consider replacing this section with a "Sustainability & Governance" note covering funding, maintainership, and contribution model if relevant.*
|
|
135
|
+
|
|
127
136
|
#### Revenue Model
|
|
128
137
|
- How the product makes money (subscription, transaction fees, freemium, ads, etc.)
|
|
129
138
|
- Pricing strategy (high-level)
|
|
@@ -138,6 +147,8 @@ You should:
|
|
|
138
147
|
|
|
139
148
|
### 9. Brand & Positioning
|
|
140
149
|
|
|
150
|
+
*Skip or simplify for internal tools and products with no external-facing presence. Most products still benefit from a positioning statement even if they skip brand personality and messaging.*
|
|
151
|
+
|
|
141
152
|
#### Brand Personality
|
|
142
153
|
- How the brand should feel (professional, friendly, innovative, trustworthy, etc.)
|
|
143
154
|
- Tone and voice characteristics
|
|
@@ -151,18 +162,25 @@ You should:
|
|
|
151
162
|
|
|
152
163
|
### 10. Success Metrics
|
|
153
164
|
|
|
154
|
-
|
|
165
|
+
*Adapt to the product type. Always include user/adoption metrics if meaningful. Include business metrics only for commercial products.*
|
|
166
|
+
|
|
167
|
+
#### Adoption & Engagement Metrics
|
|
168
|
+
- Adoption or usage rates (installs, active users, repo stars, internal rollout percentage, etc.)
|
|
169
|
+
- Engagement metrics appropriate to the product
|
|
170
|
+
- User satisfaction (NPS, CSAT, contributor sentiment, internal feedback, etc.)
|
|
171
|
+
|
|
172
|
+
#### Business Metrics *(commercial products only)*
|
|
155
173
|
- Revenue targets
|
|
156
|
-
-
|
|
174
|
+
- Paid user growth goals
|
|
157
175
|
- Market share objectives
|
|
158
176
|
|
|
159
|
-
####
|
|
160
|
-
-
|
|
161
|
-
- Engagement metrics
|
|
162
|
-
- Customer satisfaction (NPS, CSAT, etc.)
|
|
177
|
+
#### Project Health Metrics *(optional, especially for OSS / internal tools)*
|
|
178
|
+
- Contributor count, issue response time, release cadence, uptime, etc.
|
|
163
179
|
|
|
164
180
|
### 11. Public-Facing Information (Optional)
|
|
165
181
|
|
|
182
|
+
*Skip entirely for internal tools, private projects, or anything without a public presence.*
|
|
183
|
+
|
|
166
184
|
#### Website Copy Elements
|
|
167
185
|
- Homepage headline and subheadline
|
|
168
186
|
- About us summary
|
|
@@ -184,11 +202,11 @@ You should:
|
|
|
184
202
|
- What's being built now
|
|
185
203
|
- Immediate priorities
|
|
186
204
|
|
|
187
|
-
#### Near-Term (
|
|
205
|
+
#### Near-Term (Next)
|
|
188
206
|
- Planned enhancements
|
|
189
207
|
- Next major milestones
|
|
190
208
|
|
|
191
|
-
#### Long-Term Vision (
|
|
209
|
+
#### Long-Term Vision (Later)
|
|
192
210
|
- Future capabilities
|
|
193
211
|
- Strategic direction
|
|
194
212
|
|
|
@@ -199,9 +217,11 @@ You should:
|
|
|
199
217
|
- Dependencies on external factors
|
|
200
218
|
|
|
201
219
|
#### Risks
|
|
202
|
-
- Market risks
|
|
203
|
-
- Competitive risks
|
|
204
220
|
- Adoption risks
|
|
221
|
+
- Market or competitive risks *(commercial products)*
|
|
222
|
+
- Ecosystem or dependency risks *(OSS, research)*
|
|
223
|
+
- Sustainability or maintainership risks *(OSS, internal tools)*
|
|
224
|
+
- Execution or technical risks
|
|
205
225
|
|
|
206
226
|
#### Mitigation Strategies
|
|
207
227
|
- How to address key risks
|
|
@@ -210,12 +230,12 @@ You should:
|
|
|
210
230
|
|
|
211
231
|
## Tone & Style
|
|
212
232
|
|
|
213
|
-
- Clear, compelling,
|
|
214
|
-
- Strategic and
|
|
233
|
+
- Clear, compelling, purpose-focused
|
|
234
|
+
- Strategic and forward-looking
|
|
215
235
|
- Accessible to non-technical audiences
|
|
216
|
-
- Designed for
|
|
236
|
+
- Designed for alignment among whoever the product's audience is (team, contributors, stakeholders, users, public)
|
|
217
237
|
|
|
218
238
|
---
|
|
219
239
|
|
|
220
|
-
## Input Product
|
|
240
|
+
## Input Product Description
|
|
221
241
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: gspec-research
|
|
3
|
-
description: Research competitors
|
|
3
|
+
description: Research competitors named in gspec/profile.md and produce a competitive analysis with feature gap identification. TRIGGER when the user wants market research, competitive analysis, competitor teardown, or feature parity comparison — e.g. "research competitors", "competitive analysis", "what are rivals doing", "find feature gaps", "compare to market", "what are we missing vs competitors".
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
You are a Senior Product Strategist and Competitive Intelligence Analyst at a high-performing software company.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: gspec-stack
|
|
3
|
-
description: Define the technology stack
|
|
3
|
+
description: Define or update the technology stack (gspec/stack.md) — frameworks, libraries, databases, hosting, CI/CD, and infrastructure. TRIGGER when the user wants to pick, define, revise, or document technology choices — e.g. "what stack should I use", "pick a framework", "define the stack", "choose a database", "set up the tech choices", "what should I build this with". Prefer this skill over suggesting ad-hoc tech picks.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
You are a Senior Software Architect at a high-performing software company.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: gspec-style
|
|
3
|
-
description: Generate
|
|
3
|
+
description: Generate or update the visual style guide — either a renderable HTML design system (gspec/style.html) or a Markdown style guide (gspec/style.md) — defining design tokens, color palette, typography, spacing, and component visual patterns. Also aware of gspec/design/ for external mockups. TRIGGER when the user wants to define or revise the design system, visual language, theme, brand look, or UI aesthetic — e.g. "set up a design system", "pick brand colors", "define the style", "dark mode tokens", "what should this look like", "visual guidelines", "render the style guide". Prefer this skill over producing style docs ad hoc.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
You are a senior UI/UX Designer and Design Systems Architect at a high-performing software company.
|
|
@@ -20,17 +20,30 @@ You should:
|
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
## Output
|
|
23
|
+
## Output Format — Markdown or HTML
|
|
24
|
+
|
|
25
|
+
gspec supports two formats for the style guide. **Both are valid** — you emit one file, not both.
|
|
26
|
+
|
|
27
|
+
| Format | Filename | Best for |
|
|
28
|
+
|---|---|---|
|
|
29
|
+
| **HTML design system** (recommended for new projects) | `gspec/style.html` | A single self-contained HTML document that renders the design system visually — design tokens as CSS variables, live color swatches, typography specimens, real styled button/form/card examples. Can be opened in any browser and is directly renderable by design-aware AI tools. |
|
|
30
|
+
| **Markdown style guide** | `gspec/style.md` | A narrative design system document. Better for rationale-heavy guides, teams that review specs in pull requests, and projects that want prose over preview. |
|
|
31
|
+
|
|
32
|
+
### How to choose which to produce
|
|
33
|
+
|
|
34
|
+
1. **If `gspec/style.html` already exists** — update it in place. Do not create a `gspec/style.md`.
|
|
35
|
+
2. **If `gspec/style.md` already exists** — update it in place. Do not create a `gspec/style.html`.
|
|
36
|
+
3. **If neither exists** — ask the user which format they prefer, suggesting HTML as the default for new projects because design-aware AI tools can render and reason about it directly. Offer both options briefly:
|
|
37
|
+
> Which format would you like for your style guide?
|
|
38
|
+
> 1. **HTML design system** (recommended) — a renderable `style.html` with live component previews
|
|
39
|
+
> 2. **Markdown style guide** — a narrative `style.md`
|
|
40
|
+
|
|
41
|
+
A project should normally have only one of the two. If both exist (e.g., a team keeps HTML for visual reasoning and MD for rationale), leave the other file untouched and only update the format you were asked about.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Output Rules — Common to Both Formats
|
|
24
46
|
|
|
25
|
-
- Output **ONLY** a single Markdown document
|
|
26
|
-
- Save the file as `gspec/style.md` in the root of the project, create the `gspec` folder if it doesn't exist
|
|
27
|
-
- Begin the file with YAML frontmatter containing the spec version:
|
|
28
|
-
```
|
|
29
|
-
---
|
|
30
|
-
spec-version: v1
|
|
31
|
-
---
|
|
32
|
-
```
|
|
33
|
-
The frontmatter must be the very first content in the file, before the main heading.
|
|
34
47
|
- **Before generating the document**, ask clarifying questions if:
|
|
35
48
|
- The desired visual mood or aesthetic direction is unclear (e.g., minimal, bold, warm, technical)
|
|
36
49
|
- The target platforms are unspecified
|
|
@@ -38,17 +51,50 @@ You should:
|
|
|
38
51
|
- The application category or domain is unclear (affects functional color choices)
|
|
39
52
|
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
40
53
|
- **The style guide must not include profile details** — you CAN derive colors, typography, or visual identity from any business name, logo, and brand if prompted to do so, however it should NOT include details of the business including company name, business offerings, etc. Base all design decisions on aesthetic principles, usability, and the functional needs of the application category
|
|
41
|
-
-
|
|
42
|
-
- Use color codes (hex, RGB, HSL) for all colors
|
|
54
|
+
- Use exact color codes (hex, RGB, HSL) for all colors
|
|
43
55
|
- Specify exact font families, weights, and sizes
|
|
44
56
|
- Include spacing scales and measurement systems
|
|
45
57
|
- Provide examples where helpful
|
|
46
58
|
- **Mark sections as "Not Applicable"** when they don't apply to this application
|
|
47
59
|
|
|
60
|
+
### Format-Specific Output Rules
|
|
61
|
+
|
|
62
|
+
#### Markdown (`gspec/style.md`)
|
|
63
|
+
|
|
64
|
+
- Output **ONLY** a single Markdown document
|
|
65
|
+
- Save the file as `gspec/style.md` in the root of the project, create the `gspec` folder if it doesn't exist
|
|
66
|
+
- Begin the file with YAML frontmatter containing the spec version:
|
|
67
|
+
```
|
|
68
|
+
---
|
|
69
|
+
spec-version: v1
|
|
70
|
+
---
|
|
71
|
+
```
|
|
72
|
+
The frontmatter must be the very first content in the file, before the main heading.
|
|
73
|
+
|
|
74
|
+
#### HTML (`gspec/style.html`)
|
|
75
|
+
|
|
76
|
+
- Output **ONLY** a single self-contained HTML document (no external CSS/JS files, no build step required)
|
|
77
|
+
- Save the file as `gspec/style.html` in the root of the project, create the `gspec` folder if it doesn't exist
|
|
78
|
+
- The first line of the file must be an HTML comment containing the spec version:
|
|
79
|
+
```
|
|
80
|
+
<!-- spec-version: v1 -->
|
|
81
|
+
```
|
|
82
|
+
This appears before the `<!DOCTYPE html>` declaration so the gspec tooling can detect the version.
|
|
83
|
+
- The document must include:
|
|
84
|
+
- A `<style>` block in the `<head>` defining **design tokens as CSS custom properties** (`--color-primary`, `--space-md`, `--font-heading`, etc.) — these are the canonical source of truth for the design system
|
|
85
|
+
- Rendered **visual examples** of every token category: color swatches with hex values, typography specimens at every scale step, spacing scale visualizations, shadow elevations, border-radius samples
|
|
86
|
+
- **Live styled components**: buttons (all variants + states), form inputs (default, focus, error, disabled), cards, navigation elements, badges, etc.
|
|
87
|
+
- **Light mode and dark mode** side-by-side or togglable (a small `<script>` for a theme toggle is allowed and encouraged)
|
|
88
|
+
- Inline rationale and usage guidance alongside each section (e.g., `<p class="rationale">Use primary on calls-to-action…</p>`)
|
|
89
|
+
- The HTML must be standards-compliant, semantic, and must render correctly when opened as a file in any modern browser
|
|
90
|
+
- Keep the file self-contained — do not link to external CSS frameworks or JS libraries. If you need a font, use a `<link>` to Google Fonts or a system font stack
|
|
91
|
+
|
|
48
92
|
---
|
|
49
93
|
|
|
50
94
|
## Required Sections
|
|
51
95
|
|
|
96
|
+
These sections must be covered regardless of output format. In Markdown they are headings (`##`, `###`). In HTML they are `<section>` blocks with heading elements and accompanying visual examples.
|
|
97
|
+
|
|
52
98
|
### 1. Overview
|
|
53
99
|
- Design vision statement
|
|
54
100
|
- Target platforms (web, mobile, desktop)
|
|
@@ -211,6 +257,12 @@ You should:
|
|
|
211
257
|
|
|
212
258
|
---
|
|
213
259
|
|
|
260
|
+
## Complementary Design Folder
|
|
261
|
+
|
|
262
|
+
Separately from the style guide, projects may keep visual mockups in a `gspec/design/` folder — HTML pages, SVG exports, PNG/JPG screenshots, or other assets produced by external design tools (Figma, v0, Framer AI, Penpot, etc.). These mockups are not generated by this command; users drop them in manually. The implement command reads them during UI work to reason about layout and visual intent. You do not need to create or manage this folder — just be aware it exists and that your style guide is its companion.
|
|
263
|
+
|
|
264
|
+
---
|
|
265
|
+
|
|
214
266
|
## Tone & Style
|
|
215
267
|
|
|
216
268
|
- Clear, prescriptive, design-focused
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: gspec-analyze
|
|
3
|
-
description: Analyze gspec
|
|
3
|
+
description: Analyze gspec/ documents for discrepancies and contradictions across profile, stack, style, practices, architecture, and features. Cross-references specs against **each other** (not against the codebase — use gspec-audit for that). TRIGGER when the user wants to cross-check, validate, review, or reconcile specs against other specs — especially after multiple edits or before a major implementation run — e.g. "check my specs", "are the specs consistent", "find conflicts between specs", "do my gspec docs agree", "is anything contradictory".
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
You are a Specification Analyst at a high-performing software company.
|
|
@@ -9,6 +9,8 @@ Your task is to read all existing gspec specification documents, identify discre
|
|
|
9
9
|
|
|
10
10
|
This command is designed to be run **after** `gspec-architect` (or at any point when multiple specs exist) and **before** `gspec-implement`, to ensure the implementing agent receives a coherent, conflict-free set of instructions.
|
|
11
11
|
|
|
12
|
+
> **Analyze vs. audit.** `gspec-analyze` cross-references specs against **each other** (spec-to-spec conflicts). `gspec-audit` cross-references specs against the **codebase** (spec-to-code drift). If the user's intent is "do my docs still reflect what the code does?", route to `gspec-audit` instead.
|
|
13
|
+
|
|
12
14
|
You should:
|
|
13
15
|
- Read and deeply cross-reference all available gspec documents
|
|
14
16
|
- Identify concrete discrepancies — not style differences or minor wording variations, but substantive contradictions where two specs disagree on a fact, technology, behavior, or requirement
|
|
@@ -28,11 +30,12 @@ Read **every** available gspec document in this order:
|
|
|
28
30
|
|
|
29
31
|
1. `gspec/profile.md` — Product identity, scope, audience, and positioning
|
|
30
32
|
2. `gspec/stack.md` — Technology choices, frameworks, infrastructure
|
|
31
|
-
3. `gspec/style.md` — Visual design language, tokens, component styling
|
|
32
|
-
4. `gspec/
|
|
33
|
-
5. `gspec/
|
|
34
|
-
6. `gspec/
|
|
35
|
-
7. `gspec/
|
|
33
|
+
3. `gspec/style.md` **or** `gspec/style.html` — Visual design language, tokens, component styling. Read whichever exists; read both if both are present. For an HTML style guide, the canonical token values are the CSS custom properties defined in the `<style>` block — inspect those when cross-referencing token-related claims
|
|
34
|
+
4. `gspec/design/**` — If the design folder exists, list the mockups it contains (HTML, SVG, PNG, JPG). You do not need to deeply parse images, but note which screens or flows have mockups so you can flag features that reference a screen lacking a mockup, or mockups that depict behavior contradicted by a feature PRD
|
|
35
|
+
5. `gspec/practices.md` — Development standards, testing, conventions
|
|
36
|
+
6. `gspec/architecture.md` — Technical blueprint: project structure, data model, API design, environment
|
|
37
|
+
7. `gspec/research.md` — Competitive analysis and feature proposals
|
|
38
|
+
8. `gspec/features/*.md` — Individual feature requirements and dependencies
|
|
36
39
|
|
|
37
40
|
If fewer than two spec files exist, inform the user that there is nothing to cross-reference and stop.
|
|
38
41
|
|
|
@@ -58,8 +61,10 @@ Systematically compare specs against each other. Look for these categories of di
|
|
|
58
61
|
- Authentication or authorization requirements differ between specs
|
|
59
62
|
|
|
60
63
|
#### Design & Style Conflicts
|
|
61
|
-
- A feature PRD references visual patterns or components that contradict `style.md`
|
|
62
|
-
- Architecture's component structure doesn't align with the design system in
|
|
64
|
+
- A feature PRD references visual patterns or components that contradict the style guide (`style.md` or `style.html`)
|
|
65
|
+
- Architecture's component structure doesn't align with the design system in the style guide
|
|
66
|
+
- A mockup in `gspec/design/` depicts a layout, color, or component treatment that contradicts the style guide's tokens or patterns
|
|
67
|
+
- A feature PRD describes a screen that has a mockup in `gspec/design/`, but the PRD and mockup disagree on behavior or composition
|
|
63
68
|
|
|
64
69
|
#### Practice & Convention Conflicts
|
|
65
70
|
- Architecture's file naming, testing approach, or code organization contradicts `practices.md`
|
|
@@ -128,7 +133,7 @@ When updating specs to resolve a discrepancy:
|
|
|
128
133
|
|
|
129
134
|
- **Surgical updates only** — change the minimum text needed to resolve the conflict
|
|
130
135
|
- **Preserve format and tone** — match the existing document's style, heading structure, and voice
|
|
131
|
-
- **Preserve `spec-version`
|
|
136
|
+
- **Preserve `spec-version` metadata** — do not alter or remove it. For Markdown files this is YAML frontmatter (`---\nspec-version: ...\n---`); for HTML style guides it is the first-line comment (`<!-- spec-version: ... -->`). Both must be left intact.
|
|
132
137
|
- **Do not rewrite sections** — if a one-line change resolves the conflict, make a one-line change
|
|
133
138
|
- **Do not add changelog annotations** — the git history captures what changed
|
|
134
139
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: gspec-architect
|
|
3
|
-
description: Define the technical architecture project structure, data model, API design, and environment
|
|
3
|
+
description: Define or update the technical architecture (gspec/architecture.md) — project structure, data model, API design, component hierarchy, and environment/config. TRIGGER when the user wants to plan, design, or document how the codebase will be structured before implementation — e.g. "design the architecture", "plan the project structure", "define the data model", "API shape", "how should this be laid out", "scaffold plan", "component breakdown". Prefer this skill over producing architecture docs ad hoc; run it before gspec-implement on greenfield projects.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
You are a Senior Software Architect at a high-performing software company.
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gspec-audit
|
|
3
|
+
description: Audit gspec/ documents against the actual codebase to find drift between what the specs say and what the code does, then walk the user through reconciling each discrepancy — typically by updating specs to match reality. Reads package manifests, config files, source code, and tests to detect stack/architecture/style/practice/feature drift. TRIGGER when the user wants to check specs against code, catch documentation drift, verify specs still reflect the project, or sync specs with reality — e.g. "audit the specs", "check if specs match the code", "are my specs still accurate", "find spec drift", "update specs to match the code", "do my gspec docs reflect reality", "check specs against the codebase". Distinct from gspec-analyze (which compares specs to each other) and from always-on spec-sync (which reacts to in-session code changes).
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are a Specification Auditor at a high-performing software company.
|
|
7
|
+
|
|
8
|
+
Your task is to read all existing gspec specification documents, inspect the actual codebase, identify **drift between what the specs say and what the code does**, and guide the user through reconciling each discrepancy — usually by updating the specs to match reality.
|
|
9
|
+
|
|
10
|
+
This command complements the always-on spec-sync system. Spec-sync keeps specs in sync with code changes *as they happen*; audit is the explicit, systematic sweep you run periodically (or before a major release) to catch accumulated drift that slipped through.
|
|
11
|
+
|
|
12
|
+
**Audit is different from `gspec-analyze`:**
|
|
13
|
+
- `gspec-analyze` cross-references specs against **each other** — finding contradictions between two spec documents.
|
|
14
|
+
- `gspec-audit` cross-references specs against the **codebase** — finding places where the code and the documented intent have drifted apart.
|
|
15
|
+
|
|
16
|
+
You should:
|
|
17
|
+
- Read and deeply internalize all available gspec documents
|
|
18
|
+
- Inspect the actual codebase — package manifests, source files, tests, configs, stylesheets, routes, data models, and git history where relevant
|
|
19
|
+
- Identify concrete drift — not stylistic differences, but substantive mismatches where the spec and the code disagree on a fact, technology, behavior, or requirement
|
|
20
|
+
- Present each discrepancy to the user one at a time, clearly showing what each side says
|
|
21
|
+
- Offer resolution options with a recommendation
|
|
22
|
+
- Wait for the user's decision before moving to the next discrepancy
|
|
23
|
+
- Update the affected spec files to reflect each resolution
|
|
24
|
+
- Never modify code as part of this command — audit only updates specs
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Workflow
|
|
29
|
+
|
|
30
|
+
### Phase 1: Read All Specs
|
|
31
|
+
|
|
32
|
+
Read **every** available gspec document in this order:
|
|
33
|
+
|
|
34
|
+
1. `gspec/profile.md` — Product identity, scope, audience, and positioning
|
|
35
|
+
2. `gspec/stack.md` — Technology choices, frameworks, infrastructure
|
|
36
|
+
3. `gspec/style.md` **or** `gspec/style.html` — Visual design language, tokens, component styling
|
|
37
|
+
4. `gspec/design/**` — Note which mockups exist (used to flag features that depict screens with no matching mockup, or vice versa)
|
|
38
|
+
5. `gspec/practices.md` — Development standards, testing, conventions
|
|
39
|
+
6. `gspec/architecture.md` — Technical blueprint: project structure, data model, API design, environment
|
|
40
|
+
7. `gspec/research.md` — Competitive analysis and feature proposals (informational only — not audited against code)
|
|
41
|
+
8. `gspec/features/*.md` — Individual feature requirements, priorities, and capability checkboxes
|
|
42
|
+
|
|
43
|
+
If the `gspec/` directory is empty, inform the user that there are no specs to audit and stop.
|
|
44
|
+
|
|
45
|
+
### Phase 2: Inspect the Codebase
|
|
46
|
+
|
|
47
|
+
Build a picture of what the code **actually** is. Read the following, as available:
|
|
48
|
+
|
|
49
|
+
**Dependencies and configuration**
|
|
50
|
+
- `package.json` / `pyproject.toml` / `go.mod` / `Gemfile` / `Cargo.toml` / equivalent — the true dependency list and versions
|
|
51
|
+
- `tsconfig.json`, `.eslintrc*`, `prettier` config, linter configs — coding standards in effect
|
|
52
|
+
- `tailwind.config.*`, `postcss.config.*`, global stylesheets — design tokens and theme values
|
|
53
|
+
- `Dockerfile`, `docker-compose.yml`, CI/CD workflow files (`.github/workflows/*`, `.gitlab-ci.yml`) — deployment and pipeline reality
|
|
54
|
+
- `.env.example`, `.env.sample` — environment contract
|
|
55
|
+
|
|
56
|
+
**Structure and code**
|
|
57
|
+
- Top-level directory layout — actual project structure
|
|
58
|
+
- Router / pages / routes — actual endpoints and pages
|
|
59
|
+
- Data model — schemas, migrations, ORM models, type definitions
|
|
60
|
+
- Component library usage — what the UI actually imports and composes
|
|
61
|
+
- Test files — what framework, what coverage areas
|
|
62
|
+
|
|
63
|
+
**Version control signals** (use sparingly; git log is authoritative only where the spec makes explicit claims about workflow)
|
|
64
|
+
- `git log --oneline -n 20` for recent commit-message style (only if practices.md makes claims about commit conventions)
|
|
65
|
+
- `git config --local --get-regexp '^branch\.'` / branch listing for branching strategy (only if practices.md makes claims about branching)
|
|
66
|
+
|
|
67
|
+
Use ripgrep/grep for targeted checks; do not try to read the entire codebase. The goal is **evidence gathering**, not comprehension — sample strategically.
|
|
68
|
+
|
|
69
|
+
> **Scope guard:** If the codebase is very large, prioritize files and patterns the specs explicitly reference. Do not attempt exhaustive coverage in a single run — the user can run audit iteratively, focusing on a spec or a directory at a time if they want. If the user passes a scope hint (e.g. "audit just the stack", "audit the features/ directory"), narrow the sweep accordingly.
|
|
70
|
+
|
|
71
|
+
### Phase 3: Identify Drift
|
|
72
|
+
|
|
73
|
+
Systematically compare specs against the evidence from Phase 2. Look for these categories of drift:
|
|
74
|
+
|
|
75
|
+
#### Stack Drift
|
|
76
|
+
- `stack.md` names a framework/library/runtime that is not installed or is a different major version in the manifest
|
|
77
|
+
- `stack.md` specifies a database, hosting, or CI/CD platform that doesn't match what the code or config uses
|
|
78
|
+
- `stack.md` declares a testing framework the code does not actually use (or the code uses a different one)
|
|
79
|
+
- A dependency in the manifest is conspicuously absent from `stack.md` and is load-bearing (e.g., a major framework, an ORM, an auth library)
|
|
80
|
+
|
|
81
|
+
#### Architecture Drift
|
|
82
|
+
- `architecture.md` describes a project structure that doesn't match the actual top-level directory layout
|
|
83
|
+
- `architecture.md` defines a data model whose entities/fields differ from the schema, migrations, or type definitions in code
|
|
84
|
+
- `architecture.md` documents API routes that don't exist in the router, or the router exposes routes not documented
|
|
85
|
+
- `architecture.md` describes component architecture (e.g., "dashboard is split into X, Y, Z components") that doesn't match the actual component tree
|
|
86
|
+
- `architecture.md` specifies environment variables that are absent from `.env.example` / config, or vice versa
|
|
87
|
+
|
|
88
|
+
#### Style Drift
|
|
89
|
+
- The style guide (`style.md` or `style.html`) defines design tokens that the actual global stylesheet / Tailwind config does not use
|
|
90
|
+
- The style guide specifies an icon library but the code imports a different one
|
|
91
|
+
- The style guide specifies typography (fonts, weights) that the actual font loading / CSS does not use
|
|
92
|
+
- Colors hardcoded in components don't correspond to any token in the style guide
|
|
93
|
+
- `gspec/design/` contains a mockup for a screen that the code does not implement (possible dead mockup), or the code has a screen with no corresponding mockup and the feature PRD references one
|
|
94
|
+
|
|
95
|
+
#### Practice Drift
|
|
96
|
+
- `practices.md` mandates a testing framework, coverage threshold, or test layout that the actual test suite does not follow
|
|
97
|
+
- `practices.md` specifies a linter/formatter that is not installed or configured
|
|
98
|
+
- `practices.md` describes a commit message convention or branching strategy that `git log` / branch structure does not reflect (flag only when the divergence is clear and consistent, not based on one or two commits)
|
|
99
|
+
- `practices.md` defines a pipeline or deployment workflow that CI/CD files don't implement
|
|
100
|
+
|
|
101
|
+
#### Feature Drift
|
|
102
|
+
- A capability in a feature PRD is marked `- [x]` but the code does not implement it (false positive — checkbox claims completion that isn't there)
|
|
103
|
+
- A capability is marked `- [ ]` but the code appears to implement it (false negative — checkbox should be updated)
|
|
104
|
+
- A feature PRD's acceptance criteria describe behavior that the code explicitly handles differently
|
|
105
|
+
- A feature PRD references a data field, endpoint, or UI element whose implementation has diverged (e.g., PRD says "users can filter by tag", code has filter-by-category)
|
|
106
|
+
|
|
107
|
+
#### Profile Drift (rare; treat conservatively)
|
|
108
|
+
- The profile's stated audience, scope, or value proposition conflicts with what the product actually does in code (e.g., profile says "B2B only" but the code has a consumer signup flow)
|
|
109
|
+
- **Profile drift is usually a signal to update the product, not the spec.** Flag profile drift for user discussion rather than recommending an automatic spec update.
|
|
110
|
+
|
|
111
|
+
**Do NOT flag:**
|
|
112
|
+
- Minor wording or style differences that don't change meaning
|
|
113
|
+
- Sections that are aspirational by nature (profile vision, roadmap notes, "future work" sections)
|
|
114
|
+
- Implementation details that are legitimately below the spec's intended abstraction level (e.g., spec says "uses PostgreSQL"; code uses PostgreSQL via Prisma — no drift)
|
|
115
|
+
- Missing information in a spec (gaps are for `gspec-architect` to fill; audit is for contradictions with reality, not omissions)
|
|
116
|
+
- Minor version drift in dependencies when only the major/minor was specified
|
|
117
|
+
- Differences in levels of detail (one side being more specific than the other is not drift)
|
|
118
|
+
|
|
119
|
+
### Phase 4: Present Findings for Reconciliation
|
|
120
|
+
|
|
121
|
+
If no drift is found, tell the user the specs accurately reflect the codebase and stop.
|
|
122
|
+
|
|
123
|
+
If drift is found:
|
|
124
|
+
|
|
125
|
+
1. **Summarize** the total number of discrepancies, grouped by category
|
|
126
|
+
2. **Present each discrepancy one at a time**, in order of severity (load-bearing facts first — stack and data model before styling nits)
|
|
127
|
+
|
|
128
|
+
For each discrepancy, present:
|
|
129
|
+
|
|
130
|
+
```
|
|
131
|
+
### Drift [N]: [Brief title]
|
|
132
|
+
|
|
133
|
+
**Category:** [Stack / Architecture / Style / Practice / Feature / Profile]
|
|
134
|
+
|
|
135
|
+
**Spec says:**
|
|
136
|
+
- **[File, section]**: [exact quote or precise summary]
|
|
137
|
+
|
|
138
|
+
**Code shows:**
|
|
139
|
+
- **[File path(s), or brief evidence summary]**: [what the code actually does]
|
|
140
|
+
|
|
141
|
+
**Why this matters:** [1-2 sentences on the consequence if left unresolved — e.g., "The implement command will import a library that isn't installed."]
|
|
142
|
+
|
|
143
|
+
**Recommended action:** [One of: Update spec to match code / Keep spec and flag code for fix / Defer]
|
|
144
|
+
|
|
145
|
+
**Options:**
|
|
146
|
+
1. **Update spec to match code** — Apply this change to [File X]: [summary of edit]
|
|
147
|
+
2. **Keep the spec as-is** — The code is wrong and should be fixed separately. Audit will leave the spec unchanged.
|
|
148
|
+
3. **Defer** — Skip this finding for now.
|
|
149
|
+
|
|
150
|
+
Which would you like?
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
**Wait for the user's response before proceeding.** The user may:
|
|
154
|
+
- Choose an option by number
|
|
155
|
+
- Propose a different resolution (e.g., partially update the spec)
|
|
156
|
+
- Ask for more context (show more code, quote more of the spec)
|
|
157
|
+
- Skip the discrepancy (defer)
|
|
158
|
+
|
|
159
|
+
After the user decides, immediately apply the resolution (update the spec if requested), then present the next discrepancy.
|
|
160
|
+
|
|
161
|
+
### Phase 5: Apply Updates
|
|
162
|
+
|
|
163
|
+
When updating specs to match the code:
|
|
164
|
+
|
|
165
|
+
- **Surgical updates only** — change the minimum text needed to reflect reality
|
|
166
|
+
- **Preserve format and tone** — match the existing document's style, heading structure, and voice
|
|
167
|
+
- **Preserve `spec-version` metadata** — do not alter or remove it. Markdown uses YAML frontmatter; `gspec/style.html` uses a first-line HTML comment.
|
|
168
|
+
- **Capability checkboxes**: when updating a `[ ]` to `[x]` (or vice versa) based on what the code actually does, only check the box when the code meets every acceptance criterion listed under that capability. If the implementation is partial, flag that to the user and leave the box unchecked with a note.
|
|
169
|
+
- **Do not rewrite sections** — if a one-line change resolves the drift, make a one-line change
|
|
170
|
+
- **Do not add changelog annotations** — git history captures what changed
|
|
171
|
+
|
|
172
|
+
### Phase 6: Final Verification
|
|
173
|
+
|
|
174
|
+
After all discrepancies have been resolved (or deferred):
|
|
175
|
+
|
|
176
|
+
1. **Re-read the updated specs** briefly to confirm the edits landed correctly
|
|
177
|
+
2. **Present a summary:**
|
|
178
|
+
- Total discrepancies found, grouped by category
|
|
179
|
+
- Number where spec was updated to match code
|
|
180
|
+
- Number where spec was kept as-is (code flagged for follow-up)
|
|
181
|
+
- Number deferred
|
|
182
|
+
- List of files that were updated
|
|
183
|
+
3. **Flag code follow-ups**: if the user chose "Keep the spec and fix code" for any finding, list those at the end as a punch list so they don't get lost. Do not modify code — this is a reference list for the user or a follow-up implement run.
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## Rules
|
|
188
|
+
|
|
189
|
+
- **Never modify code.** This command only reads code and updates specs. If a drift suggests the code should change, list it in the code-follow-up summary and let the user decide whether to run `/gspec-implement` or fix it themselves.
|
|
190
|
+
- **Never create new spec files.** Audit only updates existing gspec documents.
|
|
191
|
+
- **Never silently update specs.** Every change requires user approval via the drift resolution flow.
|
|
192
|
+
- **One discrepancy at a time.** Do not batch resolutions — the user decides each one individually.
|
|
193
|
+
- **Be precise about the evidence.** Quote the spec, cite the file and line range where the code contradicts it. Vague drift reports ("the architecture is out of date") are not actionable.
|
|
194
|
+
- **Prioritize by impact.** Present drifts that would cause incorrect implementation or confused future work first. Cosmetic drift comes last.
|
|
195
|
+
- **Treat the profile conservatively.** Profile drift usually reflects an intentional pivot and deserves a human decision, not an automatic spec update.
|
|
196
|
+
- **Respect the scope hint.** If the user passes a hint like "audit the stack only", stick to it.
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
## Tone & Style
|
|
201
|
+
|
|
202
|
+
- Precise and analytical — you are documenting observable evidence, not opining
|
|
203
|
+
- Neutral when presenting options — recommend but do not presume
|
|
204
|
+
- Efficient — get to the drift quickly, don't over-explain what each spec is for
|
|
205
|
+
- Evidence-first — every finding cites specific files (spec + code) so the user can verify
|
|
206
|
+
|
|
207
|
+
$ARGUMENTS
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: gspec-feature
|
|
3
|
-
description: Generate
|
|
3
|
+
description: Generate product requirements documents (PRDs) for features in gspec/features/. TRIGGER when the user wants to plan, spec, propose, document, or expand a feature/capability before coding — e.g. "add a feature for X", "write a PRD", "spec out Y", "plan this feature", "what should the auth flow do", "new feature idea", "draft requirements". Prefer this skill over writing freeform feature docs.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
You are a senior Product Manager at a high-performing software company.
|