zaileys 2.2.7 → 3.0.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/.agent/skills/codebase-mapper/SKILL.md +226 -0
- package/.agent/skills/context-compressor/SKILL.md +201 -0
- package/.agent/skills/context-fetch/SKILL.md +184 -0
- package/.agent/skills/context-health-monitor/SKILL.md +105 -0
- package/.agent/skills/debugger/SKILL.md +273 -0
- package/.agent/skills/empirical-validation/SKILL.md +97 -0
- package/.agent/skills/executor/SKILL.md +465 -0
- package/.agent/skills/plan-checker/SKILL.md +283 -0
- package/.agent/skills/planner/SKILL.md +485 -0
- package/.agent/skills/token-budget/SKILL.md +166 -0
- package/.agent/skills/verifier/SKILL.md +421 -0
- package/.agent/workflows/add-phase.md +96 -0
- package/.agent/workflows/add-todo.md +69 -0
- package/.agent/workflows/audit-milestone.md +107 -0
- package/.agent/workflows/check-todos.md +80 -0
- package/.agent/workflows/complete-milestone.md +135 -0
- package/.agent/workflows/debug.md +235 -0
- package/.agent/workflows/discuss-phase.md +103 -0
- package/.agent/workflows/execute.md +325 -0
- package/.agent/workflows/health.md +122 -0
- package/.agent/workflows/help.md +96 -0
- package/.agent/workflows/insert-phase.md +109 -0
- package/.agent/workflows/install.md +152 -0
- package/.agent/workflows/list-phase-assumptions.md +82 -0
- package/.agent/workflows/map.md +394 -0
- package/.agent/workflows/new-milestone.md +126 -0
- package/.agent/workflows/new-project.md +368 -0
- package/.agent/workflows/pause.md +176 -0
- package/.agent/workflows/plan-milestone-gaps.md +116 -0
- package/.agent/workflows/plan.md +380 -0
- package/.agent/workflows/progress.md +90 -0
- package/.agent/workflows/quick.md +128 -0
- package/.agent/workflows/remove-phase.md +139 -0
- package/.agent/workflows/research-phase.md +160 -0
- package/.agent/workflows/resume.md +131 -0
- package/.agent/workflows/update.md +203 -0
- package/.agent/workflows/verify.md +263 -0
- package/.agent/workflows/web-search.md +121 -0
- package/.agent/workflows/whats-new.md +80 -0
- package/.gemini/GEMINI.md +67 -0
- package/.gsd/DEBUG.md +26 -0
- package/.gsd/GSD-STYLE.md +272 -0
- package/.gsd/PROJECT_RULES.md +256 -0
- package/.gsd/ROADMAP.md +38 -0
- package/.gsd/SPEC.md +16 -0
- package/.gsd/STATE.md +10 -0
- package/.gsd/adapters/CLAUDE.md +77 -0
- package/.gsd/adapters/GEMINI.md +92 -0
- package/.gsd/adapters/GPT_OSS.md +130 -0
- package/.gsd/docs/model-selection-playbook.md +128 -0
- package/.gsd/docs/runbook.md +296 -0
- package/.gsd/docs/token-optimization-guide.md +207 -0
- package/.gsd/model_capabilities.yaml +108 -0
- package/.gsd/phases/1/1-PLAN.md +44 -0
- package/.gsd/phases/1/2-PLAN.md +54 -0
- package/.gsd/phases/1/3-PLAN.md +46 -0
- package/.gsd/phases/1/4-PLAN.md +39 -0
- package/.gsd/phases/2/2-1-SUMMARY.md +8 -0
- package/.gsd/phases/2/2-PLAN.md +47 -0
- package/.gsd/phases/3/3-1-SUMMARY.md +8 -0
- package/.gsd/phases/3/3-PLAN.md +43 -0
- package/.gsd/phases/4/4-1-PLAN.md +44 -0
- package/.gsd/phases/4/4-1-SUMMARY.md +8 -0
- package/.gsd/phases/4/4-2-PLAN.md +59 -0
- package/.gsd/phases/4/4-2-SUMMARY.md +8 -0
- package/.gsd/phases/4/4-3-PLAN.md +42 -0
- package/.gsd/phases/4/4-3-SUMMARY.md +8 -0
- package/.gsd/phases/4/VERIFICATION.md +8 -0
- package/.gsd/phases/5/1-SUMMARY.md +5 -0
- package/.gsd/phases/5/5-PLAN.md +47 -0
- package/.gsd/phases/5/RESEARCH.md +24 -0
- package/.gsd/phases/5/VERIFICATION.md +8 -0
- package/.gsd/phases/6/1-SUMMARY.md +6 -0
- package/.gsd/phases/6/6-PLAN.md +46 -0
- package/.gsd/phases/6/RESEARCH.md +33 -0
- package/.gsd/phases/6/VERIFICATION.md +7 -0
- package/.gsd/phases/7/1-SUMMARY.md +12 -0
- package/.gsd/phases/7/7-PLAN.md +78 -0
- package/.gsd/phases/7/VERIFICATION.md +7 -0
- package/.gsd/templates/DEBUG.md +123 -0
- package/.gsd/templates/PLAN.md +90 -0
- package/.gsd/templates/RESEARCH.md +75 -0
- package/.gsd/templates/SUMMARY.md +103 -0
- package/.gsd/templates/UAT.md +168 -0
- package/.gsd/templates/VERIFICATION.md +70 -0
- package/.gsd/templates/architecture.md +67 -0
- package/.gsd/templates/context.md +91 -0
- package/.gsd/templates/decisions.md +37 -0
- package/.gsd/templates/discovery.md +122 -0
- package/.gsd/templates/journal.md +46 -0
- package/.gsd/templates/milestone.md +91 -0
- package/.gsd/templates/phase-summary.md +52 -0
- package/.gsd/templates/project.md +124 -0
- package/.gsd/templates/requirements.md +92 -0
- package/.gsd/templates/roadmap.md +103 -0
- package/.gsd/templates/spec.md +51 -0
- package/.gsd/templates/sprint.md +57 -0
- package/.gsd/templates/stack.md +62 -0
- package/.gsd/templates/state.md +92 -0
- package/.gsd/templates/state_snapshot.md +132 -0
- package/.gsd/templates/todo.md +32 -0
- package/.gsd/templates/token_report.md +79 -0
- package/.gsd/templates/user-setup.md +116 -0
- package/.husky/commit-msg +1 -0
- package/.husky/pre-commit +1 -0
- package/LICENSE +21 -21
- package/README.MD +1280 -1230
- package/commitlint.config.js +3 -0
- package/dist/index.d.mts +1397 -908
- package/dist/index.d.ts +1397 -908
- package/dist/index.js +29 -28
- package/dist/index.mjs +29 -28
- package/package.json +11 -27
- package/tsconfig.json +19 -19
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Discovery Template
|
|
2
|
+
|
|
3
|
+
Template for `.gsd/phases/{N}/DISCOVERY.md` — shallow research for library/option decisions.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Answer "which library/option should we use" questions during planning.
|
|
6
|
+
|
|
7
|
+
For deep ecosystem research, use `/research-phase` which produces RESEARCH.md.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## File Template
|
|
12
|
+
|
|
13
|
+
```markdown
|
|
14
|
+
---
|
|
15
|
+
phase: {N}
|
|
16
|
+
type: discovery
|
|
17
|
+
topic: [discovery-topic]
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
<discovery_objective>
|
|
21
|
+
Discover [topic] to inform [phase name] implementation.
|
|
22
|
+
|
|
23
|
+
Purpose: [What decision/implementation this enables]
|
|
24
|
+
Scope: [Boundaries]
|
|
25
|
+
Output: DISCOVERY.md with recommendation
|
|
26
|
+
</discovery_objective>
|
|
27
|
+
|
|
28
|
+
<discovery_scope>
|
|
29
|
+
<include>
|
|
30
|
+
- [Question to answer]
|
|
31
|
+
- [Area to investigate]
|
|
32
|
+
- [Specific comparison if needed]
|
|
33
|
+
</include>
|
|
34
|
+
|
|
35
|
+
<exclude>
|
|
36
|
+
- [Out of scope for this discovery]
|
|
37
|
+
- [Defer to implementation phase]
|
|
38
|
+
</exclude>
|
|
39
|
+
</discovery_scope>
|
|
40
|
+
|
|
41
|
+
<discovery_protocol>
|
|
42
|
+
|
|
43
|
+
**Source Priority:**
|
|
44
|
+
1. **Official Docs** — Authoritative, current
|
|
45
|
+
2. **Web Search** — For comparisons, trends (verify findings)
|
|
46
|
+
3. **GitHub** — For real usage patterns
|
|
47
|
+
|
|
48
|
+
**Quality Checklist:**
|
|
49
|
+
- [ ] All claims have authoritative sources
|
|
50
|
+
- [ ] Negative claims verified with official docs
|
|
51
|
+
- [ ] Alternative approaches considered
|
|
52
|
+
- [ ] Recent updates checked for breaking changes
|
|
53
|
+
|
|
54
|
+
**Confidence Levels:**
|
|
55
|
+
- HIGH: Official docs confirm
|
|
56
|
+
- MEDIUM: Multiple sources confirm
|
|
57
|
+
- LOW: Single source or training knowledge only
|
|
58
|
+
|
|
59
|
+
</discovery_protocol>
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Output Structure
|
|
65
|
+
|
|
66
|
+
Create `.gsd/phases/{N}/DISCOVERY.md`:
|
|
67
|
+
|
|
68
|
+
```markdown
|
|
69
|
+
# [Topic] Discovery
|
|
70
|
+
|
|
71
|
+
## Summary
|
|
72
|
+
[2-3 paragraph executive summary]
|
|
73
|
+
|
|
74
|
+
## Primary Recommendation
|
|
75
|
+
[What to do and why — specific and actionable]
|
|
76
|
+
|
|
77
|
+
## Alternatives Considered
|
|
78
|
+
[What else was evaluated and why not chosen]
|
|
79
|
+
|
|
80
|
+
## Key Findings
|
|
81
|
+
|
|
82
|
+
### [Category 1]
|
|
83
|
+
- [Finding with source URL]
|
|
84
|
+
|
|
85
|
+
### [Category 2]
|
|
86
|
+
- [Finding with relevance]
|
|
87
|
+
|
|
88
|
+
## Code Examples
|
|
89
|
+
[Relevant patterns if applicable]
|
|
90
|
+
|
|
91
|
+
## Metadata
|
|
92
|
+
|
|
93
|
+
<confidence level="high|medium|low">
|
|
94
|
+
[Why this confidence level]
|
|
95
|
+
</confidence>
|
|
96
|
+
|
|
97
|
+
<sources>
|
|
98
|
+
- [Primary sources used]
|
|
99
|
+
</sources>
|
|
100
|
+
|
|
101
|
+
<open_questions>
|
|
102
|
+
[What needs validation during implementation]
|
|
103
|
+
</open_questions>
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## When to Use
|
|
109
|
+
|
|
110
|
+
**Use discovery when:**
|
|
111
|
+
- Technology choice unclear (library A vs B)
|
|
112
|
+
- Best practices needed for unfamiliar integration
|
|
113
|
+
- API/library investigation required
|
|
114
|
+
|
|
115
|
+
**Don't use when:**
|
|
116
|
+
- Established patterns (CRUD, auth with known library)
|
|
117
|
+
- Questions answerable from project context
|
|
118
|
+
|
|
119
|
+
**Use RESEARCH.md instead when:**
|
|
120
|
+
- Niche/complex domains (3D, games, audio)
|
|
121
|
+
- Need ecosystem knowledge, not just library choice
|
|
122
|
+
- "How do experts build this" questions
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# JOURNAL.md — Session Log
|
|
2
|
+
|
|
3
|
+
> **Purpose**: Chronicle of work sessions for context continuity.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Sessions
|
|
8
|
+
|
|
9
|
+
## Session: YYYY-MM-DD HH:MM
|
|
10
|
+
|
|
11
|
+
### Objective
|
|
12
|
+
{What you set out to accomplish this session.}
|
|
13
|
+
|
|
14
|
+
### Accomplished
|
|
15
|
+
- ✅ {Task 1 completed}
|
|
16
|
+
- ✅ {Task 2 completed}
|
|
17
|
+
- {Sub-detail if needed}
|
|
18
|
+
- ✅ {Task 3 completed}
|
|
19
|
+
|
|
20
|
+
### Verification
|
|
21
|
+
- [x] {Verification check 1}
|
|
22
|
+
- [x] {Verification check 2}
|
|
23
|
+
- [ ] {Verification pending}
|
|
24
|
+
|
|
25
|
+
### Blockers Encountered
|
|
26
|
+
- {Blocker 1 and how it was resolved}
|
|
27
|
+
- {Blocker 2 — still open}
|
|
28
|
+
|
|
29
|
+
### Handoff Notes
|
|
30
|
+
- {Important context for next session}
|
|
31
|
+
- {Files that need attention}
|
|
32
|
+
- {Decisions that need to be made}
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Session: YYYY-MM-DD HH:MM
|
|
37
|
+
|
|
38
|
+
### Objective
|
|
39
|
+
{Previous session objective.}
|
|
40
|
+
|
|
41
|
+
### Accomplished
|
|
42
|
+
- ✅ {Completed items}
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
*Last updated: <!-- date -->*
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# Milestone Template
|
|
2
|
+
|
|
3
|
+
Template for `.gsd/milestones/{name}/MILESTONE.md` — milestone definition and tracking.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## File Template
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
---
|
|
11
|
+
name: {milestone-name}
|
|
12
|
+
version: {semantic version, e.g., v1.0}
|
|
13
|
+
status: planning | active | complete | archived
|
|
14
|
+
created: [ISO timestamp]
|
|
15
|
+
target_date: [optional target]
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
# Milestone: {name}
|
|
19
|
+
|
|
20
|
+
## Vision
|
|
21
|
+
|
|
22
|
+
{What this milestone achieves — one paragraph}
|
|
23
|
+
|
|
24
|
+
## Must-Haves
|
|
25
|
+
|
|
26
|
+
Non-negotiable deliverables for this milestone:
|
|
27
|
+
|
|
28
|
+
- [ ] {Must-have 1}
|
|
29
|
+
- [ ] {Must-have 2}
|
|
30
|
+
- [ ] {Must-have 3}
|
|
31
|
+
|
|
32
|
+
## Nice-to-Haves
|
|
33
|
+
|
|
34
|
+
If time permits:
|
|
35
|
+
|
|
36
|
+
- [ ] {Nice-to-have 1}
|
|
37
|
+
- [ ] {Nice-to-have 2}
|
|
38
|
+
|
|
39
|
+
## Phases
|
|
40
|
+
|
|
41
|
+
| Phase | Name | Status | Objective |
|
|
42
|
+
|-------|------|--------|-----------|
|
|
43
|
+
| 1 | {name} | ⬜ Not Started | {objective} |
|
|
44
|
+
| 2 | {name} | ⬜ Not Started | {objective} |
|
|
45
|
+
| 3 | {name} | ⬜ Not Started | {objective} |
|
|
46
|
+
|
|
47
|
+
## Success Criteria
|
|
48
|
+
|
|
49
|
+
How we know milestone is complete:
|
|
50
|
+
|
|
51
|
+
- [ ] {Measurable criterion 1}
|
|
52
|
+
- [ ] {Measurable criterion 2}
|
|
53
|
+
|
|
54
|
+
## Architecture Decisions
|
|
55
|
+
|
|
56
|
+
Key technical decisions for this milestone:
|
|
57
|
+
|
|
58
|
+
| Decision | Choice | Rationale |
|
|
59
|
+
|----------|--------|-----------|
|
|
60
|
+
| {decision} | {choice} | {why} |
|
|
61
|
+
|
|
62
|
+
## Risks
|
|
63
|
+
|
|
64
|
+
| Risk | Likelihood | Impact | Mitigation |
|
|
65
|
+
|------|------------|--------|------------|
|
|
66
|
+
| {risk} | Low/Med/High | Low/Med/High | {action} |
|
|
67
|
+
|
|
68
|
+
## Progress Log
|
|
69
|
+
|
|
70
|
+
| Date | Event | Notes |
|
|
71
|
+
|------|-------|-------|
|
|
72
|
+
| {date} | Milestone started | — |
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## Lifecycle
|
|
78
|
+
|
|
79
|
+
1. **Creation:** `/new-milestone` creates this file
|
|
80
|
+
2. **Active:** Updated as phases complete
|
|
81
|
+
3. **Complete:** `/complete-milestone` moves to archive
|
|
82
|
+
4. **Archived:** Read-only reference
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## Guidelines
|
|
87
|
+
|
|
88
|
+
- One active milestone at a time
|
|
89
|
+
- 3-5 phases per milestone
|
|
90
|
+
- Must-haves should be testable
|
|
91
|
+
- Success criteria should be measurable
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Phase {N} Summary
|
|
2
|
+
|
|
3
|
+
> **Status**: Complete
|
|
4
|
+
> **Completed**: YYYY-MM-DD
|
|
5
|
+
|
|
6
|
+
## Objective
|
|
7
|
+
{What this phase set out to accomplish.}
|
|
8
|
+
|
|
9
|
+
## Deliverables
|
|
10
|
+
|
|
11
|
+
| Deliverable | Status | Notes |
|
|
12
|
+
|-------------|--------|-------|
|
|
13
|
+
| {Deliverable 1} | ✅ | {Any relevant notes} |
|
|
14
|
+
| {Deliverable 2} | ✅ | {Any relevant notes} |
|
|
15
|
+
| {Deliverable 3} | ✅ | {Any relevant notes} |
|
|
16
|
+
|
|
17
|
+
## Tasks Completed
|
|
18
|
+
|
|
19
|
+
### Plan {N}.1: {Plan Name}
|
|
20
|
+
- [x] {Task 1}
|
|
21
|
+
- [x] {Task 2}
|
|
22
|
+
|
|
23
|
+
### Plan {N}.2: {Plan Name}
|
|
24
|
+
- [x] {Task 1}
|
|
25
|
+
- [x] {Task 2}
|
|
26
|
+
|
|
27
|
+
## Verification Results
|
|
28
|
+
|
|
29
|
+
| Check | Result | Evidence |
|
|
30
|
+
|-------|--------|----------|
|
|
31
|
+
| {Verification 1} | ✅ Pass | {Command output / screenshot path} |
|
|
32
|
+
| {Verification 2} | ✅ Pass | {Command output / screenshot path} |
|
|
33
|
+
|
|
34
|
+
## Commits
|
|
35
|
+
|
|
36
|
+
| Hash | Message |
|
|
37
|
+
|------|---------|
|
|
38
|
+
| `abc123` | feat(phase-N): {description} |
|
|
39
|
+
| `def456` | feat(phase-N): {description} |
|
|
40
|
+
|
|
41
|
+
## Lessons Learned
|
|
42
|
+
- {What went well}
|
|
43
|
+
- {What could be improved}
|
|
44
|
+
- {Unexpected discoveries}
|
|
45
|
+
|
|
46
|
+
## Next Steps
|
|
47
|
+
- {What the next phase should address}
|
|
48
|
+
- {Any deferred items}
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
*Completed: YYYY-MM-DD*
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# Project Template
|
|
2
|
+
|
|
3
|
+
Template for `.gsd/SPEC.md` (or PROJECT.md) — project specification.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## File Template
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
---
|
|
11
|
+
status: DRAFT | FINALIZED
|
|
12
|
+
created: [ISO timestamp]
|
|
13
|
+
finalized: [ISO timestamp when status changed]
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# SPEC.md — Project Specification
|
|
17
|
+
|
|
18
|
+
## Vision
|
|
19
|
+
|
|
20
|
+
{One paragraph describing what this project is and why it matters}
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Goals
|
|
25
|
+
|
|
26
|
+
1. **{Primary Goal}**
|
|
27
|
+
{Brief description}
|
|
28
|
+
|
|
29
|
+
2. **{Secondary Goal}**
|
|
30
|
+
{Brief description}
|
|
31
|
+
|
|
32
|
+
3. **{Tertiary Goal}**
|
|
33
|
+
{Brief description}
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Non-Goals (Out of Scope)
|
|
38
|
+
|
|
39
|
+
Explicitly NOT part of this project:
|
|
40
|
+
|
|
41
|
+
- {Non-goal 1}
|
|
42
|
+
- {Non-goal 2}
|
|
43
|
+
- {Non-goal 3}
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Users
|
|
48
|
+
|
|
49
|
+
**Primary User:** {Who}
|
|
50
|
+
- {How they'll use it}
|
|
51
|
+
- {What they need}
|
|
52
|
+
|
|
53
|
+
**Secondary User:** {Who} (if applicable)
|
|
54
|
+
- {How they'll use it}
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Constraints
|
|
59
|
+
|
|
60
|
+
### Technical
|
|
61
|
+
- {Technical constraint 1}
|
|
62
|
+
- {Technical constraint 2}
|
|
63
|
+
|
|
64
|
+
### Timeline
|
|
65
|
+
- {Timeline constraint}
|
|
66
|
+
|
|
67
|
+
### Other
|
|
68
|
+
- {Budget, resources, etc.}
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Success Criteria
|
|
73
|
+
|
|
74
|
+
How we know the project is successful:
|
|
75
|
+
|
|
76
|
+
- [ ] {Measurable outcome 1}
|
|
77
|
+
- [ ] {Measurable outcome 2}
|
|
78
|
+
- [ ] {Measurable outcome 3}
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Prior Art
|
|
83
|
+
|
|
84
|
+
Existing solutions or inspiration:
|
|
85
|
+
|
|
86
|
+
| Solution | Pros | Cons | Relevance |
|
|
87
|
+
|----------|------|------|-----------|
|
|
88
|
+
| {solution} | {pros} | {cons} | {how it relates} |
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## Open Questions
|
|
93
|
+
|
|
94
|
+
Questions to resolve during planning:
|
|
95
|
+
|
|
96
|
+
- [ ] {Question 1}
|
|
97
|
+
- [ ] {Question 2}
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Decisions
|
|
102
|
+
|
|
103
|
+
Key decisions made during specification:
|
|
104
|
+
|
|
105
|
+
| Decision | Choice | Rationale | Date |
|
|
106
|
+
|----------|--------|-----------|------|
|
|
107
|
+
| {decision} | {choice} | {why} | {date} |
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## Status Flow
|
|
113
|
+
|
|
114
|
+
1. **DRAFT** — Being written, not ready for planning
|
|
115
|
+
2. **FINALIZED** — Approved, planning can begin
|
|
116
|
+
|
|
117
|
+
**Planning Lock:** Cannot create plans until status is FINALIZED.
|
|
118
|
+
|
|
119
|
+
## Guidelines
|
|
120
|
+
|
|
121
|
+
- Keep vision to one paragraph
|
|
122
|
+
- Goals should be achievable in one milestone
|
|
123
|
+
- Non-goals are as important as goals
|
|
124
|
+
- Success criteria must be measurable
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Requirements Template
|
|
2
|
+
|
|
3
|
+
Template for `.gsd/REQUIREMENTS.md` — formal requirements tracking with traceability.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## File Template
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
---
|
|
11
|
+
milestone: {name}
|
|
12
|
+
updated: [ISO timestamp]
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# Requirements
|
|
16
|
+
|
|
17
|
+
## Overview
|
|
18
|
+
|
|
19
|
+
Requirements derived from SPEC.md for traceability and coverage tracking.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Functional Requirements
|
|
24
|
+
|
|
25
|
+
| ID | Requirement | Source | Phase | Status |
|
|
26
|
+
|----|-------------|--------|-------|--------|
|
|
27
|
+
| REQ-01 | {requirement description} | SPEC Goal 1 | 1 | Pending |
|
|
28
|
+
| REQ-02 | {requirement description} | SPEC Goal 1 | 1 | Pending |
|
|
29
|
+
| REQ-03 | {requirement description} | SPEC Goal 2 | 2 | Pending |
|
|
30
|
+
| REQ-04 | {requirement description} | SPEC Goal 2 | 2 | Pending |
|
|
31
|
+
| REQ-05 | {requirement description} | SPEC Goal 3 | 3 | Pending |
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Non-Functional Requirements
|
|
36
|
+
|
|
37
|
+
| ID | Requirement | Category | Phase | Status |
|
|
38
|
+
|----|-------------|----------|-------|--------|
|
|
39
|
+
| NFR-01 | Response time < 200ms | Performance | 4 | Pending |
|
|
40
|
+
| NFR-02 | Mobile responsive | UX | All | Pending |
|
|
41
|
+
| NFR-03 | 99% uptime | Reliability | 4 | Pending |
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Constraints
|
|
46
|
+
|
|
47
|
+
| ID | Constraint | Source | Impact |
|
|
48
|
+
|----|------------|--------|--------|
|
|
49
|
+
| CON-01 | {constraint} | SPEC | {affected areas} |
|
|
50
|
+
| CON-02 | {constraint} | Technical | {affected areas} |
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Traceability Matrix
|
|
55
|
+
|
|
56
|
+
| Requirement | Plans | Tests | Status |
|
|
57
|
+
|-------------|-------|-------|--------|
|
|
58
|
+
| REQ-01 | 1.1, 1.2 | TC-01 | — |
|
|
59
|
+
| REQ-02 | 1.2 | TC-02, TC-03 | — |
|
|
60
|
+
| REQ-03 | 2.1 | TC-04 | — |
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Status Definitions
|
|
65
|
+
|
|
66
|
+
| Status | Meaning |
|
|
67
|
+
|--------|---------|
|
|
68
|
+
| Pending | Not yet started |
|
|
69
|
+
| In Progress | Being implemented |
|
|
70
|
+
| Complete | Implemented and verified |
|
|
71
|
+
| Blocked | Cannot proceed |
|
|
72
|
+
| Deferred | Moved to later milestone |
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## Guidelines
|
|
78
|
+
|
|
79
|
+
**Requirement IDs:**
|
|
80
|
+
- REQ-XX: Functional requirements
|
|
81
|
+
- NFR-XX: Non-functional requirements
|
|
82
|
+
- CON-XX: Constraints
|
|
83
|
+
|
|
84
|
+
**Good requirements are:**
|
|
85
|
+
- Testable
|
|
86
|
+
- Specific
|
|
87
|
+
- Traceable to SPEC goals
|
|
88
|
+
|
|
89
|
+
**Update when:**
|
|
90
|
+
- Phase completes (mark requirements satisfied)
|
|
91
|
+
- Scope changes (add/defer requirements)
|
|
92
|
+
- Verification passes (update status)
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# Roadmap Template
|
|
2
|
+
|
|
3
|
+
Template for `.gsd/ROADMAP.md` — phase structure and progress tracking.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## File Template
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
---
|
|
11
|
+
milestone: {name}
|
|
12
|
+
version: {semantic version}
|
|
13
|
+
updated: [ISO timestamp]
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# Roadmap
|
|
17
|
+
|
|
18
|
+
> **Current Phase:** {N} - {name}
|
|
19
|
+
> **Status:** {planning | executing | verifying}
|
|
20
|
+
|
|
21
|
+
## Must-Haves (from SPEC)
|
|
22
|
+
|
|
23
|
+
- [ ] {Must-have 1}
|
|
24
|
+
- [ ] {Must-have 2}
|
|
25
|
+
- [ ] {Must-have 3}
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Phases
|
|
30
|
+
|
|
31
|
+
### Phase 1: {Foundation}
|
|
32
|
+
**Status:** ⬜ Not Started | 🔄 In Progress | ✅ Complete
|
|
33
|
+
**Objective:** {What this phase delivers}
|
|
34
|
+
**Requirements:** REQ-01, REQ-02
|
|
35
|
+
|
|
36
|
+
**Plans:**
|
|
37
|
+
- [ ] Plan 1.1: {name}
|
|
38
|
+
- [ ] Plan 1.2: {name}
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
### Phase 2: {Core Feature}
|
|
43
|
+
**Status:** ⬜ Not Started
|
|
44
|
+
**Objective:** {What this phase delivers}
|
|
45
|
+
**Depends on:** Phase 1
|
|
46
|
+
|
|
47
|
+
**Plans:**
|
|
48
|
+
- [ ] Plan 2.1: {name}
|
|
49
|
+
- [ ] Plan 2.2: {name}
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
### Phase 3: {Integration}
|
|
54
|
+
**Status:** ⬜ Not Started
|
|
55
|
+
**Objective:** {What this phase delivers}
|
|
56
|
+
**Depends on:** Phase 2
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
### Phase 4: {Polish/Launch}
|
|
61
|
+
**Status:** ⬜ Not Started
|
|
62
|
+
**Objective:** {Final touches and deployment}
|
|
63
|
+
**Depends on:** Phase 3
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## Progress Summary
|
|
68
|
+
|
|
69
|
+
| Phase | Status | Plans | Complete |
|
|
70
|
+
|-------|--------|-------|----------|
|
|
71
|
+
| 1 | ⬜ | 0/2 | — |
|
|
72
|
+
| 2 | ⬜ | 0/2 | — |
|
|
73
|
+
| 3 | ⬜ | 0/1 | — |
|
|
74
|
+
| 4 | ⬜ | 0/1 | — |
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Timeline
|
|
79
|
+
|
|
80
|
+
| Phase | Started | Completed | Duration |
|
|
81
|
+
|-------|---------|-----------|----------|
|
|
82
|
+
| 1 | — | — | — |
|
|
83
|
+
| 2 | — | — | — |
|
|
84
|
+
| 3 | — | — | — |
|
|
85
|
+
| 4 | — | — | — |
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Status Icons
|
|
91
|
+
|
|
92
|
+
- ⬜ Not Started
|
|
93
|
+
- 🔄 In Progress
|
|
94
|
+
- ✅ Complete
|
|
95
|
+
- ⏸️ Paused
|
|
96
|
+
- ❌ Blocked
|
|
97
|
+
|
|
98
|
+
## Guidelines
|
|
99
|
+
|
|
100
|
+
- 3-5 phases per milestone
|
|
101
|
+
- Each phase has clear deliverable
|
|
102
|
+
- Dependencies flow forward
|
|
103
|
+
- Update status as work progresses
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# SPEC.md — Project Specification
|
|
2
|
+
|
|
3
|
+
> **Status**: `DRAFT` | `FINALIZED`
|
|
4
|
+
>
|
|
5
|
+
> ⚠️ **Planning Lock**: No code may be written until this spec is marked `FINALIZED`.
|
|
6
|
+
|
|
7
|
+
## Vision
|
|
8
|
+
{One paragraph describing what this project is and why it exists.}
|
|
9
|
+
|
|
10
|
+
## Goals
|
|
11
|
+
1. **{Goal 1}** — {Brief description}
|
|
12
|
+
2. **{Goal 2}** — {Brief description}
|
|
13
|
+
3. **{Goal 3}** — {Brief description}
|
|
14
|
+
|
|
15
|
+
## Non-Goals (Out of Scope)
|
|
16
|
+
- {What this project explicitly will NOT do}
|
|
17
|
+
- {Features that are intentionally excluded}
|
|
18
|
+
- {Scope boundaries}
|
|
19
|
+
|
|
20
|
+
## Constraints
|
|
21
|
+
- {Technical constraint 1}
|
|
22
|
+
- {Business constraint 1}
|
|
23
|
+
- {Timeline constraint 1}
|
|
24
|
+
|
|
25
|
+
## Success Criteria
|
|
26
|
+
- [ ] {Measurable outcome 1}
|
|
27
|
+
- [ ] {Measurable outcome 2}
|
|
28
|
+
- [ ] {Measurable outcome 3}
|
|
29
|
+
- [ ] {Measurable outcome 4}
|
|
30
|
+
|
|
31
|
+
## User Stories (Optional)
|
|
32
|
+
|
|
33
|
+
### As a {user type}
|
|
34
|
+
- I want to {action}
|
|
35
|
+
- So that {benefit}
|
|
36
|
+
|
|
37
|
+
### As a {user type}
|
|
38
|
+
- I want to {action}
|
|
39
|
+
- So that {benefit}
|
|
40
|
+
|
|
41
|
+
## Technical Requirements (Optional)
|
|
42
|
+
|
|
43
|
+
| Requirement | Priority | Notes |
|
|
44
|
+
|-------------|----------|-------|
|
|
45
|
+
| {Requirement 1} | Must-have | {Details} |
|
|
46
|
+
| {Requirement 2} | Should-have | {Details} |
|
|
47
|
+
| {Requirement 3} | Nice-to-have | {Details} |
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
*Last updated: <!-- date -->*
|