jumpstart-mode 1.0.6 → 1.0.8
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/.cursorrules +3 -0
- package/.github/agents/jumpstart-analyst.agent.md +28 -7
- package/.github/agents/jumpstart-architect.agent.md +28 -7
- package/.github/agents/jumpstart-challenger.agent.md +37 -4
- package/.github/agents/jumpstart-developer.agent.md +19 -8
- package/.github/agents/jumpstart-facilitator.agent.md +75 -0
- package/.github/agents/jumpstart-pm.agent.md +13 -6
- package/.github/agents/jumpstart-scout.agent.md +50 -0
- package/.github/copilot-instructions.md +13 -5
- package/.github/instructions/specs.instructions.md +2 -0
- package/.github/prompts/jumpstart-review.prompt.md +2 -0
- package/.github/prompts/jumpstart-status.prompt.md +8 -1
- package/.jumpstart/agents/analyst.md +235 -28
- package/.jumpstart/agents/architect.md +163 -15
- package/.jumpstart/agents/challenger.md +91 -6
- package/.jumpstart/agents/developer.md +55 -2
- package/.jumpstart/agents/facilitator.md +227 -0
- package/.jumpstart/agents/pm.md +40 -5
- package/.jumpstart/agents/scout.md +358 -0
- package/.jumpstart/commands/commands.md +102 -26
- package/.jumpstart/config.yaml +46 -1
- package/.jumpstart/domain-complexity.csv +15 -0
- package/.jumpstart/roadmap.md +85 -0
- package/.jumpstart/templates/agents-md.md +93 -0
- package/.jumpstart/templates/architecture.md +48 -8
- package/.jumpstart/templates/challenger-brief.md +6 -4
- package/.jumpstart/templates/codebase-context.md +265 -0
- package/.jumpstart/templates/implementation-plan.md +9 -5
- package/.jumpstart/templates/insights.md +18 -18
- package/.jumpstart/templates/prd.md +7 -5
- package/.jumpstart/templates/product-brief.md +6 -4
- package/.jumpstart/templates/roadmap.md +79 -0
- package/AGENTS.md +31 -1
- package/CLAUDE.md +3 -0
- package/README.md +67 -8
- package/bin/cli.js +199 -3
- package/bin/context7-setup.js +405 -0
- package/package.json +1 -1
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
# Codebase Context
|
|
2
|
+
|
|
3
|
+
> **Phase:** Pre-0 -- Reconnaissance
|
|
4
|
+
> **Agent:** The Scout
|
|
5
|
+
> **Status:** Draft
|
|
6
|
+
> **Created:** [DATE]
|
|
7
|
+
> **Approval date:** [DATE or "Pending"]
|
|
8
|
+
> **Approved by:** [Human's name or "Pending"]
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Project Overview
|
|
13
|
+
|
|
14
|
+
| Attribute | Detail |
|
|
15
|
+
|-----------|--------|
|
|
16
|
+
| **Project Name** | [Name from config or repository] |
|
|
17
|
+
| **Primary Language(s)** | [e.g., TypeScript, Python, Go] |
|
|
18
|
+
| **Framework(s)** | [e.g., Express, Django, React] |
|
|
19
|
+
| **Build System** | [e.g., npm scripts, Makefile, Gradle] |
|
|
20
|
+
| **Package Manager(s)** | [e.g., npm, pip, cargo] |
|
|
21
|
+
| **Runtime** | [e.g., Node.js 20, Python 3.12, Go 1.22] |
|
|
22
|
+
| **Repository Age** | [Approximate, from git history if available] |
|
|
23
|
+
| **Approximate Size** | [Number of source files, lines of code if measurable] |
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Repository Structure
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
[project-root]/
|
|
31
|
+
|-- [annotated directory tree]
|
|
32
|
+
|-- [each directory with a brief purpose description]
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Directory Purposes
|
|
36
|
+
|
|
37
|
+
| Directory | Purpose | Language(s) | Notable Files |
|
|
38
|
+
|-----------|---------|-------------|---------------|
|
|
39
|
+
| `[dir]` | [What this directory contains and its role] | [Language] | [Key files] |
|
|
40
|
+
| | | | |
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Technology Stack
|
|
45
|
+
|
|
46
|
+
| Category | Technology | Version | Role | Notes |
|
|
47
|
+
|----------|-----------|---------|------|-------|
|
|
48
|
+
| **Language** | [e.g., TypeScript] | [e.g., 5.x] | Primary application language | |
|
|
49
|
+
| **Runtime** | [e.g., Node.js] | [e.g., 20 LTS] | Server runtime | |
|
|
50
|
+
| **Framework** | [e.g., Express] | [e.g., 4.18] | HTTP server framework | |
|
|
51
|
+
| **Database** | [e.g., PostgreSQL] | [e.g., 16] | Primary data store | |
|
|
52
|
+
| **ORM** | [e.g., Prisma] | [e.g., 5.x] | Database access layer | |
|
|
53
|
+
| **Testing** | [e.g., Jest] | [e.g., 29.x] | Test framework | |
|
|
54
|
+
| **Linting** | [e.g., ESLint] | | Code quality | |
|
|
55
|
+
| **CI/CD** | [e.g., GitHub Actions] | | Continuous integration | |
|
|
56
|
+
|
|
57
|
+
[Add or remove rows as appropriate.]
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Dependencies
|
|
62
|
+
|
|
63
|
+
### Production Dependencies
|
|
64
|
+
|
|
65
|
+
| Package | Version | Category | Role |
|
|
66
|
+
|---------|---------|----------|------|
|
|
67
|
+
| [package-name] | [version] | Core / Database / Auth / UI / Utility | [What it does in this project] |
|
|
68
|
+
| | | | |
|
|
69
|
+
|
|
70
|
+
### Development Dependencies
|
|
71
|
+
|
|
72
|
+
| Package | Version | Category | Role |
|
|
73
|
+
|---------|---------|----------|------|
|
|
74
|
+
| [package-name] | [version] | Testing / Build / Linting / Tooling | [What it does] |
|
|
75
|
+
| | | | |
|
|
76
|
+
|
|
77
|
+
### Dependency Observations
|
|
78
|
+
|
|
79
|
+
[Notes about dependency health, outdated packages, version pinning strategies, or notable gaps.]
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## External Integrations
|
|
84
|
+
|
|
85
|
+
| System / Service | Type | Protocol | Purpose | Configuration |
|
|
86
|
+
|-----------------|------|----------|---------|---------------|
|
|
87
|
+
| [e.g., Stripe API] | Third-party API | REST/HTTPS | Payment processing | `STRIPE_API_KEY` env var |
|
|
88
|
+
| [e.g., PostgreSQL] | Database | TCP/SQL | Primary data store | `DATABASE_URL` env var |
|
|
89
|
+
| [e.g., Redis] | Cache | TCP | Session/cache store | `REDIS_URL` env var |
|
|
90
|
+
| | | | | |
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## C4 Architecture Diagrams
|
|
95
|
+
|
|
96
|
+
### System Context (Level 1)
|
|
97
|
+
|
|
98
|
+
```mermaid
|
|
99
|
+
graph TB
|
|
100
|
+
%% Replace with actual system context diagram
|
|
101
|
+
User[User] -->|Uses| System[The System]
|
|
102
|
+
System -->|Calls| ExtService[External Service]
|
|
103
|
+
System -->|Reads/Writes| DB[(Database)]
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
[Description of what this diagram shows — the system boundary and external actors.]
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
### Container Diagram (Level 2)
|
|
111
|
+
|
|
112
|
+
```mermaid
|
|
113
|
+
graph TB
|
|
114
|
+
%% Replace with actual container diagram
|
|
115
|
+
subgraph System Boundary
|
|
116
|
+
App[Application<br/>Language/Framework]
|
|
117
|
+
DB[(Database<br/>Engine)]
|
|
118
|
+
end
|
|
119
|
+
User[User] --> App
|
|
120
|
+
App --> DB
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
[Description of the major deployable containers within the system.]
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
### Component Diagram (Level 3) — If Configured
|
|
128
|
+
|
|
129
|
+
```mermaid
|
|
130
|
+
graph TB
|
|
131
|
+
%% Replace with actual component diagram if c4_levels includes "component"
|
|
132
|
+
subgraph Container
|
|
133
|
+
ModA[Module A]
|
|
134
|
+
ModB[Module B]
|
|
135
|
+
ModC[Module C]
|
|
136
|
+
end
|
|
137
|
+
ModA --> ModB
|
|
138
|
+
ModB --> ModC
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
[Description of internal components within the primary container.]
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
### Code Diagram (Level 4) — If Configured
|
|
146
|
+
|
|
147
|
+
[Include only if `c4_levels` includes `code`. Focus on the most critical or complex modules.]
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## Code Patterns and Conventions
|
|
152
|
+
|
|
153
|
+
### File Organization
|
|
154
|
+
|
|
155
|
+
| Pattern | Convention | Example |
|
|
156
|
+
|---------|-----------|---------|
|
|
157
|
+
| **File naming** | [kebab-case / camelCase / PascalCase / snake_case] | [e.g., `user-service.ts`] |
|
|
158
|
+
| **Directory structure** | [Feature-based / Layer-based / Hybrid] | [e.g., `src/features/auth/`] |
|
|
159
|
+
| **Test location** | [Co-located / Separate tree / Both] | [e.g., `__tests__/` next to source] |
|
|
160
|
+
| **Config files** | [Root / Dedicated config dir] | [e.g., `.env`, `config/`] |
|
|
161
|
+
|
|
162
|
+
### Coding Patterns
|
|
163
|
+
|
|
164
|
+
| Pattern | Approach | Notes |
|
|
165
|
+
|---------|----------|-------|
|
|
166
|
+
| **Error handling** | [Exceptions / Result types / Error codes / Error-first callbacks] | |
|
|
167
|
+
| **Async model** | [async/await / Promises / Callbacks / Goroutines] | |
|
|
168
|
+
| **Dependency injection** | [Constructor / Framework DI / Module imports / None] | |
|
|
169
|
+
| **Logging** | [Library name and approach, e.g., "Winston, structured JSON"] | |
|
|
170
|
+
| **Input validation** | [Library or approach, e.g., "Joi schemas at controller layer"] | |
|
|
171
|
+
| **State management** | [Approach if frontend, e.g., "Redux Toolkit"] | |
|
|
172
|
+
|
|
173
|
+
### Testing Patterns
|
|
174
|
+
|
|
175
|
+
| Aspect | Convention |
|
|
176
|
+
|--------|-----------|
|
|
177
|
+
| **Test framework** | [e.g., Jest, pytest, Go testing] |
|
|
178
|
+
| **Test naming** | [e.g., `describe/it`, `test_function_name`, `TestFunctionName`] |
|
|
179
|
+
| **Mocking approach** | [e.g., jest.mock, unittest.mock, testify/mock] |
|
|
180
|
+
| **Test data** | [Fixtures / Factories / Inline / Seed files] |
|
|
181
|
+
| **Coverage** | [Approximate coverage level if measurable] |
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## Existing Documentation
|
|
186
|
+
|
|
187
|
+
| Document | Location | Status | Notes |
|
|
188
|
+
|----------|----------|--------|-------|
|
|
189
|
+
| README | [path] | [Current / Outdated / Minimal] | [Brief assessment] |
|
|
190
|
+
| API docs | [path or URL] | [Current / Outdated / Missing] | |
|
|
191
|
+
| Architecture docs | [path] | [Current / Outdated / Missing] | |
|
|
192
|
+
| Contributing guide | [path] | [Exists / Missing] | |
|
|
193
|
+
| AGENTS.md / AI instructions | [path] | [Exists / Missing] | |
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## Technical Debt and Observations
|
|
198
|
+
|
|
199
|
+
> **Note:** These are observations, not recommendations. The Scout documents what it sees without prescribing changes.
|
|
200
|
+
|
|
201
|
+
### Structural Observations
|
|
202
|
+
|
|
203
|
+
- [Observation about code organization, module boundaries, or file structure]
|
|
204
|
+
- [e.g., "The `utils/` directory contains 47 files with varied purposes, suggesting it may benefit from sub-categorization"]
|
|
205
|
+
|
|
206
|
+
### Code Quality Observations
|
|
207
|
+
|
|
208
|
+
- [Observation about patterns, consistency, or notable code characteristics]
|
|
209
|
+
- [e.g., "Error handling is inconsistent: controllers use try/catch, services use error callbacks"]
|
|
210
|
+
|
|
211
|
+
### Test Coverage Observations
|
|
212
|
+
|
|
213
|
+
- [Observation about which areas are well-tested vs. under-tested]
|
|
214
|
+
- [e.g., "Unit tests exist for all service modules; no integration or e2e tests found"]
|
|
215
|
+
|
|
216
|
+
### Security Observations
|
|
217
|
+
|
|
218
|
+
- [Observation about security-relevant patterns]
|
|
219
|
+
- [e.g., "Authentication middleware is applied per-route rather than globally"]
|
|
220
|
+
|
|
221
|
+
### TODO/FIXME/HACK Comments
|
|
222
|
+
|
|
223
|
+
| File | Line | Comment | Category |
|
|
224
|
+
|------|------|---------|----------|
|
|
225
|
+
| [path] | [line] | [The comment text] | TODO / FIXME / HACK |
|
|
226
|
+
| | | | |
|
|
227
|
+
|
|
228
|
+
[Include only notable or high-impact comments, not an exhaustive list.]
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
|
|
232
|
+
## Key Files Reference
|
|
233
|
+
|
|
234
|
+
| File | Purpose | Importance |
|
|
235
|
+
|------|---------|------------|
|
|
236
|
+
| [path] | [What this file does — entry point, config, core logic, etc.] | Critical / High / Medium |
|
|
237
|
+
| | | |
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
|
|
241
|
+
## Insights Reference
|
|
242
|
+
|
|
243
|
+
**Companion Document:** [specs/insights/codebase-context-insights.md](insights/codebase-context-insights.md)
|
|
244
|
+
|
|
245
|
+
This artifact was informed by ongoing insights captured during reconnaissance. Key insights:
|
|
246
|
+
|
|
247
|
+
1. **[Brief insight title]** - [One sentence summary]
|
|
248
|
+
2. **[Brief insight title]** - [One sentence summary]
|
|
249
|
+
3. **[Brief insight title]** - [One sentence summary]
|
|
250
|
+
|
|
251
|
+
See the insights document for complete observation rationale, ambiguities encountered, and patterns discovered.
|
|
252
|
+
|
|
253
|
+
---
|
|
254
|
+
|
|
255
|
+
## Phase Gate Approval
|
|
256
|
+
|
|
257
|
+
- [ ] Repository structure has been mapped and annotated
|
|
258
|
+
- [ ] Dependencies have been cataloged with categories and versions
|
|
259
|
+
- [ ] C4 diagrams have been generated at configured levels
|
|
260
|
+
- [ ] Code patterns and conventions have been documented
|
|
261
|
+
- [ ] The human has reviewed and approved this document
|
|
262
|
+
|
|
263
|
+
**Approved by:** [Human's name or "Pending"]
|
|
264
|
+
**Approval date:** [Date or "Pending"]
|
|
265
|
+
**Status:** Draft
|
|
@@ -2,12 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
> **Phase:** 3 -- Solutioning (output) / Phase 4 -- Implementing (working document)
|
|
4
4
|
> **Agent:** Generated by The Architect, executed by The Developer
|
|
5
|
-
> **Status:** Draft
|
|
5
|
+
> **Status:** Draft
|
|
6
6
|
> **Created:** [DATE]
|
|
7
|
-
> **
|
|
7
|
+
> **Approval date:** [DATE or "Pending"]
|
|
8
|
+
> **Approved by:** [Human's name or "Pending"]
|
|
8
9
|
> **Upstream References:**
|
|
9
|
-
> - [specs/prd.md](
|
|
10
|
-
> - [specs/architecture.md](
|
|
10
|
+
> - [specs/prd.md](prd.md)
|
|
11
|
+
> - [specs/architecture.md](architecture.md)
|
|
11
12
|
|
|
12
13
|
---
|
|
13
14
|
|
|
@@ -28,6 +29,9 @@
|
|
|
28
29
|
|--------|---------|
|
|
29
30
|
| `[S]` | Sequential -- must complete before the next task can begin |
|
|
30
31
|
| `[P]` | Parallelizable -- can run alongside other `[P]` tasks in the same group |
|
|
32
|
+
| `[R]` | Refactoring -- modifies existing code without changing behavior (brownfield) |
|
|
33
|
+
| `[M]` | Migration -- data or schema migration task (brownfield) |
|
|
34
|
+
| `[D]` | Documentation -- creates or updates AGENTS.md or other documentation files (greenfield) |
|
|
31
35
|
| `[PENDING]` | Not yet started |
|
|
32
36
|
| `[IN PROGRESS]` | Currently being implemented |
|
|
33
37
|
| `[COMPLETE]` | Finished and verified |
|
|
@@ -200,7 +204,7 @@ Document any deviations from the original plan during implementation.
|
|
|
200
204
|
|
|
201
205
|
## Insights Reference
|
|
202
206
|
|
|
203
|
-
**Companion Document:** [specs/insights/implementation-plan-insights.md](
|
|
207
|
+
**Companion Document:** [specs/insights/implementation-plan-insights.md](insights/implementation-plan-insights.md)
|
|
204
208
|
|
|
205
209
|
This artifact was informed by ongoing insights captured during Solutioning and Implementation. Key insights that shaped this document:
|
|
206
210
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **Phase:** [0-4] -- [Phase Name]
|
|
4
4
|
> **Agent:** [Agent Name]
|
|
5
|
-
> **Parent Artifact:** [`specs/[artifact-name].md`](
|
|
5
|
+
> **Parent Artifact:** [`specs/[artifact-name].md`](../[artifact-name].md)
|
|
6
6
|
> **Created:** [DATE]
|
|
7
7
|
> **Last Updated:** [DATE]
|
|
8
8
|
|
|
@@ -49,9 +49,9 @@ You can record different kinds of insights. Here are some common types, but don'
|
|
|
49
49
|
When an insight relates to a specific section of the parent artifact, link to it:
|
|
50
50
|
|
|
51
51
|
```markdown
|
|
52
|
-
→ See [Problem Statement](
|
|
53
|
-
→ Related to [User Persona 2](
|
|
54
|
-
→ Influences [Architecture Decision 003](
|
|
52
|
+
→ See [Problem Statement](../challenger-brief.md#reframed-problem-statement)
|
|
53
|
+
→ Related to [User Persona 2](../product-brief.md#user-personas)
|
|
54
|
+
→ Influences [Architecture Decision 003](../decisions/003-api-design.md)
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
### Timestamps
|
|
@@ -122,8 +122,8 @@ During assumption surfacing, the human initially framed the problem as "develope
|
|
|
122
122
|
This realization shifted the problem from "ongoing inefficiency" to "high-friction project initialization." The scope and solution implications are very different.
|
|
123
123
|
|
|
124
124
|
**Cross-references:**
|
|
125
|
-
- [Assumption #3](
|
|
126
|
-
- [Reframed Problem Statement](
|
|
125
|
+
- [Assumption #3](../challenger-brief.md#assumptions-identified) captured this shift
|
|
126
|
+
- [Reframed Problem Statement](../challenger-brief.md#reframed-problem-statement) now focuses on "project setup friction"
|
|
127
127
|
|
|
128
128
|
---
|
|
129
129
|
|
|
@@ -140,7 +140,7 @@ The human chose to follow the organizational path, which revealed that the root
|
|
|
140
140
|
I noted the tooling branch as "Alternative thread" in the brief—it might resurface during architecture phase.
|
|
141
141
|
|
|
142
142
|
**Cross-references:**
|
|
143
|
-
- [Root Cause Analysis](
|
|
143
|
+
- [Root Cause Analysis](../challenger-brief.md#root-cause-analysis-five-whys)
|
|
144
144
|
|
|
145
145
|
---
|
|
146
146
|
|
|
@@ -157,8 +157,8 @@ While synthesizing interview notes (simulated), I noticed a third distinct behav
|
|
|
157
157
|
This persona has inverse priorities: they *want* more friction at setup to ensure compliance. Including them changes the requirements—solution needs configuration/policy layer, not just speed.
|
|
158
158
|
|
|
159
159
|
**Cross-references:**
|
|
160
|
-
- Added as [Persona 3: Platform Engineer](
|
|
161
|
-
- Impacts [Feature Priority](
|
|
160
|
+
- Added as [Persona 3: Platform Engineer](../product-brief.md#user-personas)
|
|
161
|
+
- Impacts [Feature Priority](../product-brief.md#feature-prioritization)—audit/compliance features elevated
|
|
162
162
|
|
|
163
163
|
---
|
|
164
164
|
|
|
@@ -175,7 +175,7 @@ This could be a meaningful differentiation point—not just templates, but *opin
|
|
|
175
175
|
Noted as open question for PM phase to address with proposed value prop testing.
|
|
176
176
|
|
|
177
177
|
**Cross-references:**
|
|
178
|
-
- [Competitive Analysis](
|
|
178
|
+
- [Competitive Analysis](../product-brief.md#competitive-landscape)
|
|
179
179
|
|
|
180
180
|
---
|
|
181
181
|
|
|
@@ -197,8 +197,8 @@ Decision: defer all advanced customization to v2. MVP will be opinionated by def
|
|
|
197
197
|
Trade-off acknowledged: loses Platform Engineer as primary MVP audience. They become secondary (can still use, but won't get custom policy enforcement).
|
|
198
198
|
|
|
199
199
|
**Cross-references:**
|
|
200
|
-
- [MVP Scope](
|
|
201
|
-
- [Persona 3 deprioritized rationale](
|
|
200
|
+
- [MVP Scope](../prd.md#mvp-scope)
|
|
201
|
+
- [Persona 3 deprioritized rationale](../prd.md#out-of-scope)
|
|
202
202
|
|
|
203
203
|
---
|
|
204
204
|
|
|
@@ -215,7 +215,7 @@ Problem: "active" is vague. Active in what sense? Commits? Deploys? Team still e
|
|
|
215
215
|
Alternative: "Users report 50% reduction in setup time" (survey-based, direct). Suggested we use both: time saved (short-term) and project longevity (long-term quality signal).
|
|
216
216
|
|
|
217
217
|
**Cross-references:**
|
|
218
|
-
- [Success Metrics](
|
|
218
|
+
- [Success Metrics](../prd.md#success-metrics)—now includes both
|
|
219
219
|
|
|
220
220
|
---
|
|
221
221
|
|
|
@@ -243,8 +243,8 @@ Reasoning:
|
|
|
243
243
|
Trade-off: Hard to add community-contributed templates without code changes. Acceptable for MVP.
|
|
244
244
|
|
|
245
245
|
**Cross-references:**
|
|
246
|
-
- [Architecture Decision Record 004](
|
|
247
|
-
- [Component: Template Engine](
|
|
246
|
+
- [Architecture Decision Record 004](../decisions/004-template-storage.md)
|
|
247
|
+
- [Component: Template Engine](../architecture.md#component-template-engine)
|
|
248
248
|
|
|
249
249
|
---
|
|
250
250
|
|
|
@@ -266,8 +266,8 @@ Options:
|
|
|
266
266
|
Chose #1 + note to revisit in developer phase. Flagged as performance testing requirement in implementation plan.
|
|
267
267
|
|
|
268
268
|
**Cross-references:**
|
|
269
|
-
- [Performance Requirements](
|
|
270
|
-
- [Implementation Task: Optimize File I/O](
|
|
269
|
+
- [Performance Requirements](../architecture.md#non-functional-requirements)
|
|
270
|
+
- [Implementation Task: Optimize File I/O](../implementation-plan.md#phase-1-tasks)
|
|
271
271
|
|
|
272
272
|
---
|
|
273
273
|
|
|
@@ -310,7 +310,7 @@ Trade-off: if we expand CLI to 10+ commands later, we might regret this. For MVP
|
|
|
310
310
|
|
|
311
311
|
**Cross-references:**
|
|
312
312
|
- [Implementation: CLI module](src/cli.js)
|
|
313
|
-
- [Dependency Justification](
|
|
313
|
+
- [Dependency Justification](../architecture.md#external-dependencies)—updated to remove yargs
|
|
314
314
|
|
|
315
315
|
---
|
|
316
316
|
|
|
@@ -2,12 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
> **Phase:** 2 -- Planning
|
|
4
4
|
> **Agent:** The Product Manager
|
|
5
|
-
> **Status:** Draft
|
|
5
|
+
> **Status:** Draft
|
|
6
6
|
> **Created:** [DATE]
|
|
7
|
-
> **
|
|
7
|
+
> **Approval date:** [DATE or "Pending"]
|
|
8
|
+
> **Approved by:** [Human's name or "Pending"]
|
|
8
9
|
> **Upstream References:**
|
|
9
|
-
> - [specs/challenger-brief.md](
|
|
10
|
-
> - [specs/product-brief.md](
|
|
10
|
+
> - [specs/challenger-brief.md](challenger-brief.md)
|
|
11
|
+
> - [specs/product-brief.md](product-brief.md)
|
|
11
12
|
|
|
12
13
|
---
|
|
13
14
|
|
|
@@ -346,7 +347,7 @@ Polish (Phase N)
|
|
|
346
347
|
---
|
|
347
348
|
## Insights Reference
|
|
348
349
|
|
|
349
|
-
**Companion Document:** [specs/insights/prd-insights.md](
|
|
350
|
+
**Companion Document:** [specs/insights/prd-insights.md](insights/prd-insights.md)
|
|
350
351
|
|
|
351
352
|
This artifact was informed by ongoing insights captured during Planning. Key insights that shaped this document:
|
|
352
353
|
|
|
@@ -373,3 +374,4 @@ See the insights document for complete decision rationale, alternatives consider
|
|
|
373
374
|
|
|
374
375
|
**Approved by:** [Human's name or "Pending"]
|
|
375
376
|
**Approval date:** [Date or "Pending"]
|
|
377
|
+
**Status:** Draft
|
|
@@ -2,10 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
> **Phase:** 1 -- Analysis
|
|
4
4
|
> **Agent:** The Analyst
|
|
5
|
-
> **Status:** Draft
|
|
5
|
+
> **Status:** Draft
|
|
6
6
|
> **Created:** [DATE]
|
|
7
|
-
> **
|
|
8
|
-
> **
|
|
7
|
+
> **Approval date:** [DATE or "Pending"]
|
|
8
|
+
> **Approved by:** [Human's name or "Pending"]
|
|
9
|
+
> **Upstream Reference:** [specs/challenger-brief.md](challenger-brief.md)
|
|
9
10
|
|
|
10
11
|
---
|
|
11
12
|
|
|
@@ -176,7 +177,7 @@ Capabilities explicitly excluded from this effort. Documenting these is as impor
|
|
|
176
177
|
|
|
177
178
|
## Insights Reference
|
|
178
179
|
|
|
179
|
-
**Companion Document:** [specs/insights/product-brief-insights.md](
|
|
180
|
+
**Companion Document:** [specs/insights/product-brief-insights.md](insights/product-brief-insights.md)
|
|
180
181
|
|
|
181
182
|
This artifact was informed by ongoing insights captured during Analysis. Key insights that shaped this document:
|
|
182
183
|
|
|
@@ -200,3 +201,4 @@ See the insights document for complete decision rationale, alternatives consider
|
|
|
200
201
|
|
|
201
202
|
**Approved by:** [Human's name or "Pending"]
|
|
202
203
|
**Approval date:** [Date or "Pending"]
|
|
204
|
+
**Status:** Draft
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# [PROJECT_NAME] Roadmap
|
|
2
|
+
|
|
3
|
+
> This document defines the non-negotiable principles that govern all AI agent behavior in this project. Roadmap principles supersede agent-specific protocols — no agent may violate a Core Principle, regardless of phase or task context.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Core Principles
|
|
8
|
+
|
|
9
|
+
### I. [PRINCIPLE_1_NAME]
|
|
10
|
+
<!-- Example: Sequential Phase Integrity -->
|
|
11
|
+
[PRINCIPLE_1_DESCRIPTION]
|
|
12
|
+
<!-- Example: Phases are strictly sequential. No phase may begin until the previous
|
|
13
|
+
phase's artifact is explicitly approved by the human operator. Agents must never
|
|
14
|
+
skip, combine, or reorder phases. -->
|
|
15
|
+
|
|
16
|
+
### II. [PRINCIPLE_2_NAME]
|
|
17
|
+
<!-- Example: Template Compliance -->
|
|
18
|
+
[PRINCIPLE_2_DESCRIPTION]
|
|
19
|
+
<!-- Example: All output artifacts must be generated using the markdown templates
|
|
20
|
+
in `.jumpstart/templates/`. Agents must not invent new document formats or omit
|
|
21
|
+
required template sections. -->
|
|
22
|
+
|
|
23
|
+
### III. [PRINCIPLE_3_NAME]
|
|
24
|
+
<!-- Example: Test-First Development (when enabled) -->
|
|
25
|
+
[PRINCIPLE_3_DESCRIPTION]
|
|
26
|
+
<!-- Example: When `roadmap.test_drive_mandate` is `true` in config, the Developer
|
|
27
|
+
agent must write failing tests first, present them for human approval, and only then
|
|
28
|
+
write implementation code. No source code may be written for a task until its tests
|
|
29
|
+
exist and the human has confirmed them. -->
|
|
30
|
+
|
|
31
|
+
### IV. [PRINCIPLE_4_NAME]
|
|
32
|
+
<!-- Example: Upstream Traceability -->
|
|
33
|
+
[PRINCIPLE_4_DESCRIPTION]
|
|
34
|
+
<!-- Example: Every requirement, story, and task must trace back to an upstream artifact.
|
|
35
|
+
PRD stories reference Product Brief capabilities. Product Brief capabilities reference
|
|
36
|
+
Challenger Brief validation criteria. No orphan requirements are permitted. -->
|
|
37
|
+
|
|
38
|
+
### V. [PRINCIPLE_5_NAME]
|
|
39
|
+
<!-- Example: Human Gate Authority -->
|
|
40
|
+
[PRINCIPLE_5_DESCRIPTION]
|
|
41
|
+
<!-- Example: No agent may mark a phase as complete or approve its own output. All phase
|
|
42
|
+
transitions require explicit human approval. The human operator is the sole authority
|
|
43
|
+
on artifact acceptance. -->
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## [SECTION_2_NAME]
|
|
48
|
+
<!-- Example: Additional Constraints, Security Requirements, Compliance Standards, etc. -->
|
|
49
|
+
|
|
50
|
+
[SECTION_2_CONTENT]
|
|
51
|
+
<!-- Example: Technology stack restrictions, data privacy requirements, deployment
|
|
52
|
+
policies, regulatory compliance standards, etc. -->
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## [SECTION_3_NAME]
|
|
57
|
+
<!-- Example: Development Workflow, Quality Gates, Review Process, etc. -->
|
|
58
|
+
|
|
59
|
+
[SECTION_3_CONTENT]
|
|
60
|
+
<!-- Example: Code review requirements, testing gates, deployment approval process,
|
|
61
|
+
documentation standards, etc. -->
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Governance
|
|
66
|
+
|
|
67
|
+
<!-- The Roadmap supersedes all other agent protocols and practices.
|
|
68
|
+
Amendments to a Core Principle require:
|
|
69
|
+
1. A written proposal with rationale
|
|
70
|
+
2. Explicit human approval
|
|
71
|
+
3. A migration plan for any affected artifacts or processes
|
|
72
|
+
Roadmap violations must always be reported to the human, never silently ignored. -->
|
|
73
|
+
|
|
74
|
+
[GOVERNANCE_RULES]
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
**Version**: [CONSTITUTION_VERSION] | **Ratified**: [RATIFICATION_DATE] | **Last Amended**: [LAST_AMENDED_DATE]
|
|
79
|
+
<!-- Example: Version: 1.0.0 | Ratified: 2026-02-08 | Last Amended: 2026-02-08 -->
|
package/AGENTS.md
CHANGED
|
@@ -4,29 +4,46 @@
|
|
|
4
4
|
|
|
5
5
|
## Workflow Overview
|
|
6
6
|
|
|
7
|
-
The development lifecycle follows
|
|
7
|
+
The development lifecycle follows strict, sequential phases. No phase may begin until the previous phase's artifact is **explicitly approved** by the human operator. For **brownfield** projects, a pre-phase Scout agent analyzes the existing codebase before Phase 0 begins.
|
|
8
8
|
|
|
9
9
|
```mermaid
|
|
10
10
|
flowchart TB
|
|
11
|
+
CONST["Roadmap\n(.jumpstart/roadmap.md)"] -.->|governs all agents| P0
|
|
12
|
+
CONST -.->|governs all agents| P1
|
|
13
|
+
CONST -.->|governs all agents| P2
|
|
14
|
+
CONST -.->|governs all agents| P3
|
|
15
|
+
CONST -.->|governs all agents| P4
|
|
16
|
+
S[Pre-Phase: Scout] -.->|brownfield only| P0
|
|
11
17
|
P0[Phase 0: Challenge] -->|Brief| P1[Phase 1: Analyze]
|
|
12
18
|
P1 -->|Product Brief| P2[Phase 2: Plan]
|
|
13
19
|
P2 -->|PRD| P3[Phase 3: Architect]
|
|
14
20
|
P3 -->|Specs| P4[Phase 4: Build]
|
|
21
|
+
PM_PARTY["Party Mode\n(advisory)"] -.->|available anytime| P0
|
|
22
|
+
PM_PARTY -.->|available anytime| P1
|
|
23
|
+
PM_PARTY -.->|available anytime| P2
|
|
24
|
+
PM_PARTY -.->|available anytime| P3
|
|
25
|
+
PM_PARTY -.->|available anytime| P4
|
|
15
26
|
|
|
27
|
+
SC(Scout) -.-> S
|
|
16
28
|
C(Challenger) -.-> P0
|
|
17
29
|
A(Analyst) -.-> P1
|
|
18
30
|
PM(Product Manager) -.-> P2
|
|
19
31
|
Arch(Architect) -.-> P3
|
|
20
32
|
Dev(Developer) -.-> P4
|
|
33
|
+
F(Facilitator) -.-> PM_PARTY
|
|
21
34
|
|
|
35
|
+
style S fill:#ff9800,stroke:#333,stroke-width:2px,color:#fff
|
|
22
36
|
style P0 fill:#1976d2,stroke:#333,stroke-width:2px,color:#fff
|
|
23
37
|
style P4 fill:#43a047,stroke:#333,stroke-width:2px,color:#fff
|
|
38
|
+
style CONST fill:#e53935,stroke:#333,stroke-width:2px,color:#fff
|
|
39
|
+
style PM_PARTY fill:#7b1fa2,stroke:#333,stroke-width:2px,color:#fff
|
|
24
40
|
```
|
|
25
41
|
|
|
26
42
|
## Agent Directory
|
|
27
43
|
|
|
28
44
|
| Phase | Agent Persona | Activation Command | Primary Responsibility | Output Artifact |
|
|
29
45
|
| --- | --- | --- | --- | --- |
|
|
46
|
+
| **Pre-0** | **The Scout** | `/jumpstart.scout` | Analyzes existing codebase for brownfield projects. Creates C4 diagrams and context. | `specs/codebase-context.md` |
|
|
30
47
|
| **0** | **The Challenger** | `/jumpstart.challenge` | Interrogates the problem, finds root causes, reframes assumptions. | `specs/challenger-brief.md` |
|
|
31
48
|
| **1** | **The Analyst** | `/jumpstart.analyze` | Defines personas, user journeys, and MVP scope. | `specs/product-brief.md` |
|
|
32
49
|
| **2** | **The PM** | `/jumpstart.plan` | Writes user stories, acceptance criteria, and NFRs. | `specs/prd.md` |
|
|
@@ -34,6 +51,7 @@ flowchart TB
|
|
|
34
51
|
|
|
35
52
|
<br>`specs/implementation-plan.md` |
|
|
36
53
|
| **4** | **The Developer** | `/jumpstart.build` | Writes code and tests according to the plan. | `src/`, `tests/`, `README.md` |
|
|
54
|
+
| **Any** | **The Facilitator** | `/jumpstart.party` | Orchestrates multi-agent roundtable discussions. Advisory only. | None (insights only) |
|
|
37
55
|
|
|
38
56
|
---
|
|
39
57
|
|
|
@@ -47,6 +65,7 @@ All agents must follow these directives without exception.
|
|
|
47
65
|
* **Upstream Traceability:** You must read the *approved* artifacts from previous phases.
|
|
48
66
|
* *Analyst* reads *Challenger Brief*.
|
|
49
67
|
* *Architect* reads *PRD*, *Product Brief*, and *Challenger Brief*.
|
|
68
|
+
* **Brownfield Context:** If `project.type` is `brownfield`, all agents (Phase 0–4) must also read `specs/codebase-context.md` to understand the existing codebase.
|
|
50
69
|
* Do not hallucinate requirements that contradict upstream documents.
|
|
51
70
|
|
|
52
71
|
|
|
@@ -54,10 +73,13 @@ All agents must follow these directives without exception.
|
|
|
54
73
|
### 2. The Execution Protocol
|
|
55
74
|
|
|
56
75
|
* **Stay in Lane:**
|
|
76
|
+
* The **Scout** only analyzes — it never proposes changes, new features, or solutions.
|
|
57
77
|
* The **Challenger** never suggests solutions or technologies.
|
|
58
78
|
* The **Analyst** never writes code or defines database schemas.
|
|
59
79
|
* The **Developer** never changes the architecture without flagging a deviation.
|
|
60
80
|
|
|
81
|
+
* **Greenfield AGENTS.md Files:** For greenfield projects, the **Architect** plans per-directory `AGENTS.md` files in the implementation plan, and the **Developer** creates and maintains them during scaffolding and task execution. These files provide AI-friendly context for each module.
|
|
82
|
+
|
|
61
83
|
|
|
62
84
|
* **Use Templates:** All outputs must be generated using the markdown templates located in `.jumpstart/templates/`. Do not invent new document formats.
|
|
63
85
|
* **Living Insights:** Simultaneously maintain your phase's `insights.md` file to log your reasoning, trade-offs, and discarded alternatives.
|
|
@@ -79,6 +101,14 @@ All agents must follow these directives without exception.
|
|
|
79
101
|
* **Source Code:** Application code goes into `src/`.
|
|
80
102
|
* **Tests:** Test code goes into `tests/`.
|
|
81
103
|
|
|
104
|
+
### 5. The Roadmap Protocol
|
|
105
|
+
|
|
106
|
+
* **Read on Activation:** Every agent must read `.jumpstart/roadmap.md` before generating any content.
|
|
107
|
+
* **Non-Negotiable:** Roadmap principles supersede agent-specific instructions. If a protocol step conflicts with the Roadmap, the Roadmap wins.
|
|
108
|
+
* **Article III (Test-First):** When `roadmap.test_drive_mandate` is `true` in `.jumpstart/config.yaml`, the Developer agent must follow strict Red-Green-Refactor TDD for every task.
|
|
109
|
+
* **Amendments:** Only the human can amend the Roadmap. Agents may propose amendments in their insights files, but may not modify the Roadmap directly.
|
|
110
|
+
* **Domain Awareness:** If `project.domain` is set in config, agents must consult `.jumpstart/domain-complexity.csv` for domain-specific concerns and adapt their outputs accordingly.
|
|
111
|
+
|
|
82
112
|
---
|
|
83
113
|
|
|
84
114
|
## Tool Usage (VS Code Copilot)
|
package/CLAUDE.md
CHANGED
|
@@ -6,11 +6,13 @@ This repository uses the Jump Start spec-driven agentic coding framework.
|
|
|
6
6
|
|
|
7
7
|
| Command | Action |
|
|
8
8
|
|---------|--------|
|
|
9
|
+
| `/jumpstart.scout` | Check `project.type` is `brownfield`. Load `.jumpstart/agents/scout.md`. Follow Reconnaissance Protocol. Output to `specs/codebase-context.md`. |
|
|
9
10
|
| `/jumpstart.challenge [idea]` | Load `.jumpstart/agents/challenger.md`. Follow the Elicitation Protocol. Output to `specs/challenger-brief.md`. |
|
|
10
11
|
| `/jumpstart.analyze` | Verify Phase 0 approved. Load `.jumpstart/agents/analyst.md`. Output to `specs/product-brief.md`. |
|
|
11
12
|
| `/jumpstart.plan` | Verify Phases 0-1 approved. Load `.jumpstart/agents/pm.md`. Output to `specs/prd.md`. |
|
|
12
13
|
| `/jumpstart.architect` | Verify Phases 0-2 approved. Load `.jumpstart/agents/architect.md`. Output to `specs/architecture.md`, `specs/implementation-plan.md`, `specs/decisions/*.md`. |
|
|
13
14
|
| `/jumpstart.build` | Verify Phases 0-3 approved. Load `.jumpstart/agents/developer.md`. Output code to `src/`, tests to `tests/`. |
|
|
15
|
+
| `/jumpstart.party` | Load `.jumpstart/agents/facilitator.md`. Launch multi-agent roundtable discussion. Advisory only — no artifact writes. |
|
|
14
16
|
| `/jumpstart.status` | Read config and all spec files. Report phase completion status. |
|
|
15
17
|
| `/jumpstart.review` | Validate current artifacts against templates. Report gaps. |
|
|
16
18
|
|
|
@@ -21,3 +23,4 @@ This repository uses the Jump Start spec-driven agentic coding framework.
|
|
|
21
23
|
3. Always ask for explicit human approval before phase transitions.
|
|
22
24
|
4. Use templates from `.jumpstart/templates/`.
|
|
23
25
|
5. Read `.jumpstart/config.yaml` at the start of every command.
|
|
26
|
+
6. Read `.jumpstart/roadmap.md` at activation. Roadmap principles are non-negotiable and supersede agent-specific instructions.
|