@davidbalzan/groundwork 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +323 -0
- package/docs/DECISIONS.md +170 -0
- package/package.json +38 -0
- package/payload/doc-templates/COMMANDS.md +419 -0
- package/payload/doc-templates/DECISIONS.md +168 -0
- package/payload/doc-templates/FACTS.md +43 -0
- package/payload/doc-templates/GROUNDWORK_METHODOLOGY.md +1300 -0
- package/payload/doc-templates/STACK_MAP.md +90 -0
- package/payload/doc-templates/WORKSTREAMS.md +79 -0
- package/payload/doc-templates/_INDEX.md +54 -0
- package/payload/doc-templates/phases/README.md +36 -0
- package/payload/doc-templates/phases/templates/README.md +63 -0
- package/payload/doc-templates/phases/templates/TASK_TEMPLATE.md +302 -0
- package/payload/doc-templates/phases/templates/task_template_prompt.md +229 -0
- package/payload/doc-templates/templates/ARCHITECTURE_GUIDE_TEMPLATE.md +250 -0
- package/payload/doc-templates/templates/DESIGN_SYSTEM_TEMPLATE.md +336 -0
- package/payload/doc-templates/templates/DONE_TEMPLATE.md +21 -0
- package/payload/doc-templates/templates/PHASES_README_TEMPLATE.md +144 -0
- package/payload/doc-templates/templates/PHASE_README_TEMPLATE.md +142 -0
- package/payload/doc-templates/templates/PRD_TEMPLATE.md +348 -0
- package/payload/doc-templates/templates/PRODUCTION_ROADMAP_TEMPLATE.md +168 -0
- package/payload/doc-templates/templates/QUEUE_TEMPLATE.md +17 -0
- package/payload/doc-templates/templates/TECH_STACK_TEMPLATE.md +199 -0
- package/payload/scripts/check-task.mjs +98 -0
- package/payload/scripts/check-versions.mjs +113 -0
- package/payload/scripts/phase-status.mjs +69 -0
- package/payload/scripts/set-fact.mjs +86 -0
- package/payload/skills/add-data-layer/SKILL.md +129 -0
- package/payload/skills/check-task/SKILL.md +35 -0
- package/payload/skills/check-versions/SKILL.md +47 -0
- package/payload/skills/create-prd/SKILL.md +90 -0
- package/payload/skills/domain-model/SKILL.md +90 -0
- package/payload/skills/kickstart/SKILL.md +157 -0
- package/payload/skills/log-decision/SKILL.md +65 -0
- package/payload/skills/next/SKILL.md +65 -0
- package/payload/skills/plan-phase/SKILL.md +108 -0
- package/payload/skills/remember/SKILL.md +77 -0
- package/payload/skills/start-session/SKILL.md +52 -0
- package/payload/skills/update-workstreams/SKILL.md +60 -0
- package/src/cli.mjs +115 -0
- package/src/commands/add.mjs +39 -0
- package/src/commands/artifacts.mjs +24 -0
- package/src/commands/doctor.mjs +292 -0
- package/src/commands/init.mjs +147 -0
- package/src/commands/knowledge.mjs +148 -0
- package/src/commands/list.mjs +61 -0
- package/src/commands/status.mjs +96 -0
- package/src/commands/update.mjs +128 -0
- package/src/lib/adr-tripwire.mjs +171 -0
- package/src/lib/artifacts.mjs +124 -0
- package/src/lib/config.mjs +43 -0
- package/src/lib/fs.mjs +46 -0
- package/src/lib/log.mjs +22 -0
- package/src/lib/paths.mjs +36 -0
- package/src/lib/progress.mjs +26 -0
- package/src/lib/skills.mjs +42 -0
|
@@ -0,0 +1,348 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "PRD Template"
|
|
3
|
+
tags: [groundwork/template]
|
|
4
|
+
aliases: []
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Product Requirements Document: [Product Name]
|
|
8
|
+
|
|
9
|
+
**Version**: 1.0
|
|
10
|
+
**Status**: Draft | Review | Approved
|
|
11
|
+
**Created**: [Date]
|
|
12
|
+
**Last Updated**: [Date]
|
|
13
|
+
**Author**: [Name]
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 1. Executive Summary
|
|
18
|
+
|
|
19
|
+
> A brief 2-3 sentence overview of what we're building and why it matters.
|
|
20
|
+
|
|
21
|
+
[Summarize the product, its core value proposition, and the primary problem it solves.]
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 2. Problem Statement
|
|
26
|
+
|
|
27
|
+
### The Problem
|
|
28
|
+
|
|
29
|
+
[Describe the specific problem users face. Be concrete and measurable.]
|
|
30
|
+
|
|
31
|
+
### Current State
|
|
32
|
+
|
|
33
|
+
[How do users currently solve this problem? What are the pain points?]
|
|
34
|
+
|
|
35
|
+
### Impact
|
|
36
|
+
|
|
37
|
+
- **Who is affected**: [User segments]
|
|
38
|
+
- **How often**: [Frequency of the problem]
|
|
39
|
+
- **Severity**: [Low/Medium/High/Critical]
|
|
40
|
+
- **Business impact**: [Revenue, churn, efficiency loss, etc.]
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## 3. Vision & Goals
|
|
45
|
+
|
|
46
|
+
### Product Vision
|
|
47
|
+
|
|
48
|
+
> [One sentence describing the ideal future state]
|
|
49
|
+
|
|
50
|
+
### Goals
|
|
51
|
+
|
|
52
|
+
| Goal | Metric | Target | Timeline |
|
|
53
|
+
| -------- | -------------- | -------------- | -------- |
|
|
54
|
+
| [Goal 1] | [How measured] | [Target value] | [When] |
|
|
55
|
+
| [Goal 2] | [How measured] | [Target value] | [When] |
|
|
56
|
+
| [Goal 3] | [How measured] | [Target value] | [When] |
|
|
57
|
+
|
|
58
|
+
### Non-Goals (Out of Scope)
|
|
59
|
+
|
|
60
|
+
- [What we are explicitly NOT building]
|
|
61
|
+
- [Features deferred to future versions]
|
|
62
|
+
- [Adjacent problems we won't address]
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## 4. User Personas & Stories
|
|
67
|
+
|
|
68
|
+
### Primary Persona: [Name]
|
|
69
|
+
|
|
70
|
+
- **Role**: [Job title/role]
|
|
71
|
+
- **Goal**: [What they want to achieve]
|
|
72
|
+
- **Pain Points**: [Current frustrations]
|
|
73
|
+
- **Tech Savviness**: [Low/Medium/High]
|
|
74
|
+
|
|
75
|
+
### Secondary Persona: [Name]
|
|
76
|
+
|
|
77
|
+
- **Role**: [Job title/role]
|
|
78
|
+
- **Goal**: [What they want to achieve]
|
|
79
|
+
- **Pain Points**: [Current frustrations]
|
|
80
|
+
|
|
81
|
+
### User Stories
|
|
82
|
+
|
|
83
|
+
#### Epic: [Epic Name]
|
|
84
|
+
|
|
85
|
+
| ID | As a... | I want to... | So that... | Priority |
|
|
86
|
+
| ------ | --------- | ------------ | ---------- | ----------- |
|
|
87
|
+
| US-001 | [persona] | [action] | [benefit] | Must Have |
|
|
88
|
+
| US-002 | [persona] | [action] | [benefit] | Should Have |
|
|
89
|
+
| US-003 | [persona] | [action] | [benefit] | Could Have |
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## 5. Functional Requirements
|
|
94
|
+
|
|
95
|
+
### 5.1 Core Features
|
|
96
|
+
|
|
97
|
+
#### Feature 1: [Feature Name]
|
|
98
|
+
|
|
99
|
+
**Priority**: Must Have | Should Have | Could Have | Won't Have
|
|
100
|
+
|
|
101
|
+
**Description**: [What it does]
|
|
102
|
+
|
|
103
|
+
**Acceptance Criteria**:
|
|
104
|
+
|
|
105
|
+
- [ ] [Specific, testable criterion]
|
|
106
|
+
- [ ] [Specific, testable criterion]
|
|
107
|
+
- [ ] [Specific, testable criterion]
|
|
108
|
+
|
|
109
|
+
**User Flow**:
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
1. User [action]
|
|
113
|
+
2. System [response]
|
|
114
|
+
3. User [action]
|
|
115
|
+
4. System [response]
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
#### Feature 2: [Feature Name]
|
|
119
|
+
|
|
120
|
+
**Priority**: [Priority]
|
|
121
|
+
|
|
122
|
+
**Description**: [What it does]
|
|
123
|
+
|
|
124
|
+
**Acceptance Criteria**:
|
|
125
|
+
|
|
126
|
+
- [ ] [Criterion]
|
|
127
|
+
- [ ] [Criterion]
|
|
128
|
+
|
|
129
|
+
### 5.2 Feature Priority Matrix
|
|
130
|
+
|
|
131
|
+
| Feature | Priority | Complexity | Dependencies | Phase |
|
|
132
|
+
| ----------- | ----------- | ---------- | ------------ | ----- |
|
|
133
|
+
| [Feature 1] | Must Have | Medium | None | 1 |
|
|
134
|
+
| [Feature 2] | Should Have | High | Feature 1 | 2 |
|
|
135
|
+
| [Feature 3] | Could Have | Low | None | 2 |
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## 6. Non-Functional Requirements
|
|
140
|
+
|
|
141
|
+
### 6.1 Performance
|
|
142
|
+
|
|
143
|
+
| Metric | Requirement | Measurement |
|
|
144
|
+
| ----------------- | ----------- | ------------ |
|
|
145
|
+
| Page Load Time | < 2 seconds | p95 latency |
|
|
146
|
+
| API Response Time | < 200ms | p95 latency |
|
|
147
|
+
| Concurrent Users | 10,000 | Load testing |
|
|
148
|
+
| Uptime | 99.9% | Monthly SLA |
|
|
149
|
+
|
|
150
|
+
### 6.2 Security
|
|
151
|
+
|
|
152
|
+
- [ ] Authentication: [Method - JWT, OAuth, etc.]
|
|
153
|
+
- [ ] Authorization: [RBAC, ABAC, etc.]
|
|
154
|
+
- [ ] Data Encryption: [At rest, in transit]
|
|
155
|
+
- [ ] Compliance: [GDPR, SOC2, HIPAA, etc.]
|
|
156
|
+
- [ ] Audit Logging: [What events to log]
|
|
157
|
+
|
|
158
|
+
### 6.3 Scalability
|
|
159
|
+
|
|
160
|
+
- **Initial Scale**: [Expected users/data at launch]
|
|
161
|
+
- **Growth Target**: [Expected scale in 12 months]
|
|
162
|
+
- **Scaling Strategy**: [Horizontal/vertical, cloud provider]
|
|
163
|
+
|
|
164
|
+
### 6.4 Accessibility
|
|
165
|
+
|
|
166
|
+
- [ ] WCAG 2.1 Level AA compliance
|
|
167
|
+
- [ ] Screen reader support
|
|
168
|
+
- [ ] Keyboard navigation
|
|
169
|
+
- [ ] Color contrast requirements
|
|
170
|
+
|
|
171
|
+
### 6.5 Internationalization
|
|
172
|
+
|
|
173
|
+
- [ ] Languages supported: [List]
|
|
174
|
+
- [ ] RTL support: [Yes/No]
|
|
175
|
+
- [ ] Currency/date localization: [Yes/No]
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## 7. Technical Constraints
|
|
180
|
+
|
|
181
|
+
### Technology Stack
|
|
182
|
+
|
|
183
|
+
| Layer | Technology | Version | Rationale |
|
|
184
|
+
| -------------- | ------------------ | ------------ | ------------ |
|
|
185
|
+
| Frontend | [e.g., React] | [e.g., 19.x] | [Why chosen] |
|
|
186
|
+
| Backend | [e.g., Node.js] | [e.g., 22.x] | [Why chosen] |
|
|
187
|
+
| Database | [e.g., PostgreSQL] | [e.g., 17] | [Why chosen] |
|
|
188
|
+
| Infrastructure | [e.g., AWS] | - | [Why chosen] |
|
|
189
|
+
|
|
190
|
+
### Integration Requirements
|
|
191
|
+
|
|
192
|
+
| System | Type | Purpose | Priority |
|
|
193
|
+
| ---------- | ------- | --------- | -------- |
|
|
194
|
+
| [System 1] | API | [Purpose] | Required |
|
|
195
|
+
| [System 2] | Webhook | [Purpose] | Optional |
|
|
196
|
+
|
|
197
|
+
### Constraints & Limitations
|
|
198
|
+
|
|
199
|
+
- **Budget**: [If applicable]
|
|
200
|
+
- **Timeline**: [Hard deadlines]
|
|
201
|
+
- **Team Size**: [Available resources]
|
|
202
|
+
- **Legacy Systems**: [What must be maintained]
|
|
203
|
+
- **Regulatory**: [Compliance requirements]
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## 8. Data Requirements
|
|
208
|
+
|
|
209
|
+
### Data Model Overview
|
|
210
|
+
|
|
211
|
+
```
|
|
212
|
+
[High-level ERD or description of key entities]
|
|
213
|
+
|
|
214
|
+
Entity: User
|
|
215
|
+
- id, email, name, created_at, updated_at
|
|
216
|
+
|
|
217
|
+
Entity: [Other entities]
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Data Migration
|
|
221
|
+
|
|
222
|
+
- [ ] Migration from existing system required: [Yes/No]
|
|
223
|
+
- [ ] Data volume: [Estimated records]
|
|
224
|
+
- [ ] Migration strategy: [Big bang, phased, parallel run]
|
|
225
|
+
|
|
226
|
+
### Data Retention & Privacy
|
|
227
|
+
|
|
228
|
+
- **Retention Period**: [How long data is kept]
|
|
229
|
+
- **PII Handling**: [How personal data is managed]
|
|
230
|
+
- **Data Deletion**: [User data deletion process]
|
|
231
|
+
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
## 9. Success Metrics & KPIs
|
|
235
|
+
|
|
236
|
+
### Primary Metrics
|
|
237
|
+
|
|
238
|
+
| Metric | Current | Target | Measurement Method |
|
|
239
|
+
| ---------- | ---------- | ------ | ------------------ |
|
|
240
|
+
| [Metric 1] | [Baseline] | [Goal] | [How measured] |
|
|
241
|
+
| [Metric 2] | [Baseline] | [Goal] | [How measured] |
|
|
242
|
+
|
|
243
|
+
### Secondary Metrics
|
|
244
|
+
|
|
245
|
+
| Metric | Target | Purpose |
|
|
246
|
+
| -------- | ------ | ---------------- |
|
|
247
|
+
| [Metric] | [Goal] | [Why it matters] |
|
|
248
|
+
|
|
249
|
+
### Success Criteria
|
|
250
|
+
|
|
251
|
+
**MVP is successful if**:
|
|
252
|
+
|
|
253
|
+
- [ ] [Criterion 1]
|
|
254
|
+
- [ ] [Criterion 2]
|
|
255
|
+
- [ ] [Criterion 3]
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
|
|
259
|
+
## 10. Risks & Mitigations
|
|
260
|
+
|
|
261
|
+
| Risk | Probability | Impact | Mitigation | Owner |
|
|
262
|
+
| -------- | ------------ | ------------ | ---------------- | ----- |
|
|
263
|
+
| [Risk 1] | High/Med/Low | High/Med/Low | [How to address] | [Who] |
|
|
264
|
+
| [Risk 2] | High/Med/Low | High/Med/Low | [How to address] | [Who] |
|
|
265
|
+
| [Risk 3] | High/Med/Low | High/Med/Low | [How to address] | [Who] |
|
|
266
|
+
|
|
267
|
+
### Assumptions
|
|
268
|
+
|
|
269
|
+
- [Assumption 1]
|
|
270
|
+
- [Assumption 2]
|
|
271
|
+
- [Assumption 3]
|
|
272
|
+
|
|
273
|
+
### Dependencies
|
|
274
|
+
|
|
275
|
+
- [External dependency 1]
|
|
276
|
+
- [External dependency 2]
|
|
277
|
+
|
|
278
|
+
---
|
|
279
|
+
|
|
280
|
+
## 11. Timeline & Phases
|
|
281
|
+
|
|
282
|
+
### High-Level Roadmap
|
|
283
|
+
|
|
284
|
+
```
|
|
285
|
+
Phase 1: Foundation (Weeks 1-4)
|
|
286
|
+
βββ [Deliverable 1]
|
|
287
|
+
βββ [Deliverable 2]
|
|
288
|
+
βββ [Deliverable 3]
|
|
289
|
+
|
|
290
|
+
Phase 2: Core Features (Weeks 5-8)
|
|
291
|
+
βββ [Deliverable 1]
|
|
292
|
+
βββ [Deliverable 2]
|
|
293
|
+
βββ [Deliverable 3]
|
|
294
|
+
|
|
295
|
+
Phase 3: Polish & Launch (Weeks 9-12)
|
|
296
|
+
βββ [Deliverable 1]
|
|
297
|
+
βββ [Deliverable 2]
|
|
298
|
+
βββ [Deliverable 3]
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Milestones
|
|
302
|
+
|
|
303
|
+
| Milestone | Target Date | Deliverables |
|
|
304
|
+
| ------------ | ----------- | ----------------- |
|
|
305
|
+
| MVP Complete | [Date] | [What's included] |
|
|
306
|
+
| Beta Launch | [Date] | [What's included] |
|
|
307
|
+
| GA Launch | [Date] | [What's included] |
|
|
308
|
+
|
|
309
|
+
---
|
|
310
|
+
|
|
311
|
+
## 12. Open Questions
|
|
312
|
+
|
|
313
|
+
| # | Question | Owner | Due Date | Resolution |
|
|
314
|
+
| --- | ---------- | ----- | -------- | ---------------------- |
|
|
315
|
+
| 1 | [Question] | [Who] | [When] | [Answer when resolved] |
|
|
316
|
+
| 2 | [Question] | [Who] | [When] | [Answer when resolved] |
|
|
317
|
+
|
|
318
|
+
---
|
|
319
|
+
|
|
320
|
+
## 13. Appendix
|
|
321
|
+
|
|
322
|
+
### A. Glossary
|
|
323
|
+
|
|
324
|
+
| Term | Definition |
|
|
325
|
+
| ------ | ------------ |
|
|
326
|
+
| [Term] | [Definition] |
|
|
327
|
+
|
|
328
|
+
### B. References
|
|
329
|
+
|
|
330
|
+
- [Link to related documents]
|
|
331
|
+
- [Link to research]
|
|
332
|
+
- [Link to competitive analysis]
|
|
333
|
+
|
|
334
|
+
### C. Revision History
|
|
335
|
+
|
|
336
|
+
| Version | Date | Author | Changes |
|
|
337
|
+
| ------- | ------ | ------ | ------------- |
|
|
338
|
+
| 1.0 | [Date] | [Name] | Initial draft |
|
|
339
|
+
|
|
340
|
+
---
|
|
341
|
+
|
|
342
|
+
## Approval
|
|
343
|
+
|
|
344
|
+
| Role | Name | Date | Signature |
|
|
345
|
+
| ------------- | ---- | ---- | --------- |
|
|
346
|
+
| Product Owner | | | |
|
|
347
|
+
| Tech Lead | | | |
|
|
348
|
+
| Stakeholder | | | |
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Production Roadmap Template"
|
|
3
|
+
tags: [groundwork/template]
|
|
4
|
+
aliases: ["Roadmap Template"]
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# [Project Name] - Production Roadmap
|
|
8
|
+
|
|
9
|
+
> Single source of truth for the project's journey from current state to production readiness. Updated as phases progress and priorities shift.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## π― Current Status
|
|
14
|
+
|
|
15
|
+
> For the live state of all in-flight work streams, see `[[WORKSTREAMS]]`. This section is the high-level phase pointer; `[[WORKSTREAMS]]` is the per-stream detail.
|
|
16
|
+
|
|
17
|
+
**Phase**: Phase [N] - [Phase Name β the active development phase]
|
|
18
|
+
**Task**: [Current task name β the specific work item being executed right now]
|
|
19
|
+
**Status**: [π§ In Progress / βΈοΈ Blocked / β
Complete β current execution status]
|
|
20
|
+
**Branch**: `[branch-name β the git branch where active work is happening]`
|
|
21
|
+
**Blocking Issues**: [List any blockers preventing progress, or "None" if unblocked]
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## π Current State Assessment
|
|
26
|
+
|
|
27
|
+
### β
What We Have
|
|
28
|
+
|
|
29
|
+
- [Feature/capability that is built and working β describe functional state, e.g., "Authentication with JWT tokens, tested against PostgreSQL"]
|
|
30
|
+
- [Feature/capability that is built and working β include quality indicators like test coverage or performance metrics]
|
|
31
|
+
- [Feature/capability that is built and working β note any limitations or known issues]
|
|
32
|
+
- [Infrastructure that is set up β e.g., "CI/CD pipeline with GitHub Actions, deploys to staging on merge"]
|
|
33
|
+
|
|
34
|
+
### π¨ What's Missing for Production
|
|
35
|
+
|
|
36
|
+
- [Critical gap β describe what's missing, why it matters, and the risk of shipping without it, e.g., "Rate limiting: API is vulnerable to abuse without request throttling"]
|
|
37
|
+
- [Critical gap β describe impact on users/business, e.g., "Error monitoring: No visibility into production failures, mean time to detect is unknown"]
|
|
38
|
+
- [Critical gap β describe technical debt or quality concern, e.g., "Test coverage at 45%: Key user flows untested, refactoring is risky"]
|
|
39
|
+
- [Critical gap β describe operational concern, e.g., "No database backup strategy: Single point of failure for all user data"]
|
|
40
|
+
|
|
41
|
+
### π Production Readiness Score
|
|
42
|
+
|
|
43
|
+
- **Functional Completeness**: [X]% β [Brief explanation of what's included in this assessment]
|
|
44
|
+
- **Test Coverage**: [X]% β [Current coverage and target, e.g., "45% current β 80% target"]
|
|
45
|
+
- **Security Posture**: [Low/Medium/High] β [Brief assessment, e.g., "Auth works but no rate limiting, CORS too permissive"]
|
|
46
|
+
- **Operational Readiness**: [Low/Medium/High] β [Brief assessment, e.g., "No monitoring, no alerting, manual deploys"]
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## πΊοΈ Phase Overview
|
|
51
|
+
|
|
52
|
+
### Phase 1: [Phase Name β e.g., "Foundation & Core Infrastructure"]
|
|
53
|
+
|
|
54
|
+
**Goal**: [One-liner that describes the measurable outcome of this phase, e.g., "Users can sign up, log in, and access the main dashboard with data persisted in PostgreSQL"]
|
|
55
|
+
**Duration**: [X] weeks β [Brief justification for estimate, e.g., "Based on 3 major features with 2-3 day estimates each"]
|
|
56
|
+
**Status**: [π’ Complete / π‘ In Progress / βͺ Not Started]
|
|
57
|
+
|
|
58
|
+
**Key Deliverables**:
|
|
59
|
+
|
|
60
|
+
- [ ] [Deliverable with acceptance criteria β e.g., "User authentication: signup, login, logout, password reset flows all functional with email verification"]
|
|
61
|
+
- [ ] [Deliverable with acceptance criteria β e.g., "Database schema: Core tables created with migrations, seeding script for dev data"]
|
|
62
|
+
- [ ] [Deliverable with acceptance criteria β e.g., "API health monitoring: /health endpoint returns status, uptime, and version"]
|
|
63
|
+
|
|
64
|
+
**Dependencies**: [What must exist before this phase starts β e.g., "None β this is the foundation phase"]
|
|
65
|
+
**Risks**: [Primary risk and mitigation β e.g., "Schema design may need revision; mitigate by starting with minimal viable schema"]
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
### Phase 2: [Phase Name β e.g., "Core Features & Business Logic"]
|
|
70
|
+
|
|
71
|
+
**Goal**: [One-liner measurable outcome, e.g., "All primary user workflows are functional, tested, and performant under expected load"]
|
|
72
|
+
**Duration**: [X] weeks β [Brief justification]
|
|
73
|
+
**Status**: [π’ Complete / π‘ In Progress / βͺ Not Started]
|
|
74
|
+
|
|
75
|
+
**Key Deliverables**:
|
|
76
|
+
|
|
77
|
+
- [ ] [Deliverable with acceptance criteria β describe what "done" looks like for this feature]
|
|
78
|
+
- [ ] [Deliverable with acceptance criteria β include measurable targets where possible]
|
|
79
|
+
- [ ] [Deliverable with acceptance criteria β note integration points with other phases]
|
|
80
|
+
|
|
81
|
+
**Dependencies**: [What must be complete β e.g., "Phase 1 complete: auth, database, and core API operational"]
|
|
82
|
+
**Risks**: [Primary risk β e.g., "Third-party API integration may have rate limits; mitigate with caching layer"]
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
### Phase 3: [Phase Name β e.g., "Polish, Security & Production Hardening"]
|
|
87
|
+
|
|
88
|
+
**Goal**: [One-liner measurable outcome, e.g., "Application is secure, performant, monitored, and ready for public launch"]
|
|
89
|
+
**Duration**: [X] weeks β [Brief justification]
|
|
90
|
+
**Status**: [π’ Complete / π‘ In Progress / βͺ Not Started]
|
|
91
|
+
|
|
92
|
+
**Key Deliverables**:
|
|
93
|
+
|
|
94
|
+
- [ ] [Deliverable with acceptance criteria β e.g., "Rate limiting: 100 req/min per IP on public endpoints, 1000 req/min for authenticated"]
|
|
95
|
+
- [ ] [Deliverable with acceptance criteria β e.g., "Error monitoring: Sentry integrated, alerts configured for error rate > 1%"]
|
|
96
|
+
|
|
97
|
+
**Dependencies**: [What must be complete β e.g., "Phase 2 complete: all core features functional and tested"]
|
|
98
|
+
**Risks**: [Primary risk β e.g., "Performance optimization may reveal architectural issues; budget extra time for refactoring"]
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## π Implementation Priority Matrix
|
|
103
|
+
|
|
104
|
+
| Phase | Priority | Blocks Other Phases? | Complexity | Duration | Key Risk |
|
|
105
|
+
| --------------- | ----------------------------------- | ------------------------------ | --------------------------------------- | --------- | ----------------------- |
|
|
106
|
+
| Phase 1: [Name] | [π΄ Critical / π‘ High / π’ Medium] | [Yes β blocks Phase 2, 3 / No] | [Low/Medium/High β brief justification] | [X weeks] | [One-line risk summary] |
|
|
107
|
+
| Phase 2: [Name] | [Priority] | [What it blocks] | [Complexity] | [X weeks] | [Risk summary] |
|
|
108
|
+
| Phase 3: [Name] | [Priority] | [What it blocks] | [Complexity] | [X weeks] | [Risk summary] |
|
|
109
|
+
|
|
110
|
+
**Critical Path**: [Describe the sequence of dependent phases that determines the minimum project duration, e.g., "Phase 1 β Phase 2 β Phase 3 (sequential, ~12 weeks total)"]
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## β‘ Quick Wins (Can Start Immediately)
|
|
115
|
+
|
|
116
|
+
> Tasks that provide immediate value with minimal risk and effort. Execute these in parallel with phase work.
|
|
117
|
+
|
|
118
|
+
1. **[Quick win name]** ([estimated duration, e.g., "2 hours"])
|
|
119
|
+
- [What to do β be specific enough that a developer can start immediately]
|
|
120
|
+
- [Expected impact β e.g., "Reduces page load by ~200ms" or "Fixes confusing error message"]
|
|
121
|
+
- [How to validate β e.g., "Run lighthouse audit, confirm score > 90"]
|
|
122
|
+
|
|
123
|
+
2. **[Quick win name]** ([estimated duration])
|
|
124
|
+
- [What to do]
|
|
125
|
+
- [Expected impact]
|
|
126
|
+
|
|
127
|
+
3. **[Quick win name]** ([estimated duration])
|
|
128
|
+
- [What to do]
|
|
129
|
+
- [Expected impact]
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## π Success Metrics
|
|
134
|
+
|
|
135
|
+
### Technical Metrics
|
|
136
|
+
|
|
137
|
+
- [ ] [Metric with specific target β e.g., "API response time: p95 < 200ms for all endpoints"]
|
|
138
|
+
- [ ] [Metric with specific target β e.g., "Test coverage: > 80% line coverage across all packages"]
|
|
139
|
+
- [ ] [Metric with specific target β e.g., "Build time: < 60 seconds for full production build"]
|
|
140
|
+
- [ ] [Metric with specific target β e.g., "Zero critical/high severity security vulnerabilities"]
|
|
141
|
+
|
|
142
|
+
### Business Metrics
|
|
143
|
+
|
|
144
|
+
- [ ] [Metric with specific target β e.g., "User onboarding: < 2 minutes from signup to first value"]
|
|
145
|
+
- [ ] [Metric with specific target β e.g., "Uptime: 99.9% availability during business hours"]
|
|
146
|
+
|
|
147
|
+
### Operational Metrics
|
|
148
|
+
|
|
149
|
+
- [ ] [Metric with specific target β e.g., "Mean time to detect failures: < 5 minutes"]
|
|
150
|
+
- [ ] [Metric with specific target β e.g., "Deployment frequency: ability to deploy multiple times per day"]
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
## π Revision History
|
|
155
|
+
|
|
156
|
+
| Date | Change | Reason |
|
|
157
|
+
| -------------------------- | ----------------------- | ------------------------------------------ |
|
|
158
|
+
| [Date of initial creation] | Initial roadmap created | [Project kickoff / sprint planning / etc.] |
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
## π Related Documents
|
|
163
|
+
|
|
164
|
+
- **[[TECH_STACK|Tech Stack]]** - Technology choices and versions
|
|
165
|
+
- **[[ARCHITECTURE_GUIDE|Architecture Guide]]** - System design and patterns
|
|
166
|
+
- **[[DECISIONS|Decisions Log]]** - Architectural Decision Records
|
|
167
|
+
- **[Phase Details](./phases/)** - Detailed phase task breakdowns with checklists
|
|
168
|
+
- **[[WORKSTREAMS|Workstreams]]** - Live state of parallel work streams
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# QUEUE β <project>
|
|
2
|
+
|
|
3
|
+
The inbound task queue. Phases are planned via `/plan-phase` and appear here as single items
|
|
4
|
+
referencing the full task breakdown. Ad-hoc tasks (bug fixes, improvements) are added directly by
|
|
5
|
+
the human. This file is intake only: live in-flight state lives in [[WORKSTREAMS]], completions
|
|
6
|
+
are recorded in `docs/DONE.md`.
|
|
7
|
+
|
|
8
|
+
**Write rule (single writer per file):** the human (or their planning proxy) writes here β add /
|
|
9
|
+
reorder / remove / edit items, set priority (`P1`/`P2`/`P3`; top-to-bottom breaks ties), add
|
|
10
|
+
constraints, acceptance criteria, or refs inline. Whoever executes work never edits this file β it
|
|
11
|
+
reads the top unblocked item fresh and appends the completion to `docs/DONE.md` instead. Pruning
|
|
12
|
+
satisfied items is the writer's job. No compare-and-swap ceremony needed: the filesystem enforces
|
|
13
|
+
the boundary.
|
|
14
|
+
|
|
15
|
+
## Queue
|
|
16
|
+
|
|
17
|
+
- [ ] (P1) Phase 1: [Phase Name] β see [[phases/phase1/PHASE1_TASKS]] Β· acceptance: all Phase 1 success criteria met
|