@accelerationguy/accel 1.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/CLAUDE.md +19 -0
- package/LICENSE +33 -0
- package/README.md +275 -0
- package/bin/install.js +661 -0
- package/docs/getting-started.md +164 -0
- package/docs/module-guide.md +139 -0
- package/modules/drive/LICENSE +21 -0
- package/modules/drive/PAUL-VS-GSD.md +171 -0
- package/modules/drive/README.md +555 -0
- package/modules/drive/assets/terminal.svg +67 -0
- package/modules/drive/bin/install.js +210 -0
- package/modules/drive/integration.js +76 -0
- package/modules/drive/package.json +38 -0
- package/modules/drive/src/commands/add-phase.md +36 -0
- package/modules/drive/src/commands/apply.md +83 -0
- package/modules/drive/src/commands/assumptions.md +37 -0
- package/modules/drive/src/commands/audit.md +57 -0
- package/modules/drive/src/commands/complete-milestone.md +36 -0
- package/modules/drive/src/commands/config.md +175 -0
- package/modules/drive/src/commands/consider-issues.md +41 -0
- package/modules/drive/src/commands/discover.md +48 -0
- package/modules/drive/src/commands/discuss-milestone.md +33 -0
- package/modules/drive/src/commands/discuss.md +34 -0
- package/modules/drive/src/commands/flows.md +73 -0
- package/modules/drive/src/commands/handoff.md +201 -0
- package/modules/drive/src/commands/help.md +525 -0
- package/modules/drive/src/commands/init.md +54 -0
- package/modules/drive/src/commands/map-codebase.md +34 -0
- package/modules/drive/src/commands/milestone.md +34 -0
- package/modules/drive/src/commands/pause.md +44 -0
- package/modules/drive/src/commands/plan-fix.md +216 -0
- package/modules/drive/src/commands/plan.md +36 -0
- package/modules/drive/src/commands/progress.md +138 -0
- package/modules/drive/src/commands/register.md +29 -0
- package/modules/drive/src/commands/remove-phase.md +37 -0
- package/modules/drive/src/commands/research-phase.md +209 -0
- package/modules/drive/src/commands/research.md +47 -0
- package/modules/drive/src/commands/resume.md +49 -0
- package/modules/drive/src/commands/status.md +78 -0
- package/modules/drive/src/commands/unify.md +87 -0
- package/modules/drive/src/commands/verify.md +60 -0
- package/modules/drive/src/references/checkpoints.md +234 -0
- package/modules/drive/src/references/context-management.md +219 -0
- package/modules/drive/src/references/git-strategy.md +206 -0
- package/modules/drive/src/references/loop-phases.md +254 -0
- package/modules/drive/src/references/plan-format.md +263 -0
- package/modules/drive/src/references/quality-principles.md +152 -0
- package/modules/drive/src/references/research-quality-control.md +247 -0
- package/modules/drive/src/references/sonarqube-integration.md +244 -0
- package/modules/drive/src/references/specialized-workflow-integration.md +186 -0
- package/modules/drive/src/references/subagent-criteria.md +179 -0
- package/modules/drive/src/references/tdd.md +219 -0
- package/modules/drive/src/references/work-units.md +161 -0
- package/modules/drive/src/rules/commands.md +108 -0
- package/modules/drive/src/rules/references.md +107 -0
- package/modules/drive/src/rules/style.md +123 -0
- package/modules/drive/src/rules/templates.md +51 -0
- package/modules/drive/src/rules/workflows.md +133 -0
- package/modules/drive/src/templates/CONTEXT.md +88 -0
- package/modules/drive/src/templates/DEBUG.md +164 -0
- package/modules/drive/src/templates/DISCOVERY.md +148 -0
- package/modules/drive/src/templates/HANDOFF.md +77 -0
- package/modules/drive/src/templates/ISSUES.md +93 -0
- package/modules/drive/src/templates/MILESTONES.md +167 -0
- package/modules/drive/src/templates/PLAN.md +328 -0
- package/modules/drive/src/templates/PROJECT.md +219 -0
- package/modules/drive/src/templates/RESEARCH.md +130 -0
- package/modules/drive/src/templates/ROADMAP.md +328 -0
- package/modules/drive/src/templates/SPECIAL-FLOWS.md +70 -0
- package/modules/drive/src/templates/STATE.md +210 -0
- package/modules/drive/src/templates/SUMMARY.md +221 -0
- package/modules/drive/src/templates/UAT-ISSUES.md +139 -0
- package/modules/drive/src/templates/codebase/architecture.md +259 -0
- package/modules/drive/src/templates/codebase/concerns.md +329 -0
- package/modules/drive/src/templates/codebase/conventions.md +311 -0
- package/modules/drive/src/templates/codebase/integrations.md +284 -0
- package/modules/drive/src/templates/codebase/stack.md +190 -0
- package/modules/drive/src/templates/codebase/structure.md +287 -0
- package/modules/drive/src/templates/codebase/testing.md +484 -0
- package/modules/drive/src/templates/config.md +181 -0
- package/modules/drive/src/templates/milestone-archive.md +236 -0
- package/modules/drive/src/templates/milestone-context.md +190 -0
- package/modules/drive/src/templates/paul-json.md +147 -0
- package/modules/drive/src/vector-config/PAUL +26 -0
- package/modules/drive/src/vector-config/PAUL.manifest +11 -0
- package/modules/drive/src/workflows/apply-phase.md +393 -0
- package/modules/drive/src/workflows/audit-plan.md +344 -0
- package/modules/drive/src/workflows/complete-milestone.md +479 -0
- package/modules/drive/src/workflows/configure-special-flows.md +283 -0
- package/modules/drive/src/workflows/consider-issues.md +172 -0
- package/modules/drive/src/workflows/create-milestone.md +268 -0
- package/modules/drive/src/workflows/debug.md +292 -0
- package/modules/drive/src/workflows/discovery.md +187 -0
- package/modules/drive/src/workflows/discuss-milestone.md +245 -0
- package/modules/drive/src/workflows/discuss-phase.md +231 -0
- package/modules/drive/src/workflows/init-project.md +698 -0
- package/modules/drive/src/workflows/map-codebase.md +459 -0
- package/modules/drive/src/workflows/pause-work.md +259 -0
- package/modules/drive/src/workflows/phase-assumptions.md +181 -0
- package/modules/drive/src/workflows/plan-phase.md +385 -0
- package/modules/drive/src/workflows/quality-gate.md +263 -0
- package/modules/drive/src/workflows/register-manifest.md +107 -0
- package/modules/drive/src/workflows/research.md +241 -0
- package/modules/drive/src/workflows/resume-project.md +200 -0
- package/modules/drive/src/workflows/roadmap-management.md +334 -0
- package/modules/drive/src/workflows/transition-phase.md +368 -0
- package/modules/drive/src/workflows/unify-phase.md +290 -0
- package/modules/drive/src/workflows/verify-work.md +241 -0
- package/modules/forge/README.md +281 -0
- package/modules/forge/bin/install.js +200 -0
- package/modules/forge/package.json +32 -0
- package/modules/forge/skillsmith/rules/checklists-rules.md +42 -0
- package/modules/forge/skillsmith/rules/context-rules.md +43 -0
- package/modules/forge/skillsmith/rules/entry-point-rules.md +44 -0
- package/modules/forge/skillsmith/rules/frameworks-rules.md +43 -0
- package/modules/forge/skillsmith/rules/tasks-rules.md +52 -0
- package/modules/forge/skillsmith/rules/templates-rules.md +43 -0
- package/modules/forge/skillsmith/skillsmith.md +82 -0
- package/modules/forge/skillsmith/tasks/audit.md +277 -0
- package/modules/forge/skillsmith/tasks/discover.md +145 -0
- package/modules/forge/skillsmith/tasks/distill.md +276 -0
- package/modules/forge/skillsmith/tasks/scaffold.md +349 -0
- package/modules/forge/specs/checklists.md +193 -0
- package/modules/forge/specs/context.md +223 -0
- package/modules/forge/specs/entry-point.md +320 -0
- package/modules/forge/specs/frameworks.md +228 -0
- package/modules/forge/specs/rules.md +245 -0
- package/modules/forge/specs/tasks.md +344 -0
- package/modules/forge/specs/templates.md +335 -0
- package/modules/forge/terminal.svg +70 -0
- package/modules/ignition/README.md +245 -0
- package/modules/ignition/bin/install.js +184 -0
- package/modules/ignition/checklists/planning-quality.md +55 -0
- package/modules/ignition/data/application/config.md +21 -0
- package/modules/ignition/data/application/guide.md +51 -0
- package/modules/ignition/data/application/skill-loadout.md +11 -0
- package/modules/ignition/data/campaign/config.md +18 -0
- package/modules/ignition/data/campaign/guide.md +36 -0
- package/modules/ignition/data/campaign/skill-loadout.md +10 -0
- package/modules/ignition/data/client/config.md +18 -0
- package/modules/ignition/data/client/guide.md +36 -0
- package/modules/ignition/data/client/skill-loadout.md +11 -0
- package/modules/ignition/data/utility/config.md +18 -0
- package/modules/ignition/data/utility/guide.md +31 -0
- package/modules/ignition/data/utility/skill-loadout.md +8 -0
- package/modules/ignition/data/workflow/config.md +19 -0
- package/modules/ignition/data/workflow/guide.md +41 -0
- package/modules/ignition/data/workflow/skill-loadout.md +10 -0
- package/modules/ignition/integration.js +54 -0
- package/modules/ignition/package.json +35 -0
- package/modules/ignition/seed.md +81 -0
- package/modules/ignition/tasks/add-type.md +164 -0
- package/modules/ignition/tasks/graduate.md +182 -0
- package/modules/ignition/tasks/ideate.md +221 -0
- package/modules/ignition/tasks/launch.md +137 -0
- package/modules/ignition/tasks/status.md +71 -0
- package/modules/ignition/templates/planning-application.md +193 -0
- package/modules/ignition/templates/planning-campaign.md +138 -0
- package/modules/ignition/templates/planning-client.md +149 -0
- package/modules/ignition/templates/planning-utility.md +112 -0
- package/modules/ignition/templates/planning-workflow.md +125 -0
- package/modules/ignition/terminal.svg +74 -0
- package/modules/mission-control/CONTEXT-CONTINUITY-SPEC.md +293 -0
- package/modules/mission-control/CONTEXT-ENGINEERING-GUIDE.md +282 -0
- package/modules/mission-control/README.md +91 -0
- package/modules/mission-control/assets/terminal.svg +80 -0
- package/modules/mission-control/examples/entities.example.json +133 -0
- package/modules/mission-control/examples/projects.example.json +318 -0
- package/modules/mission-control/examples/state.example.json +183 -0
- package/modules/mission-control/examples/vector.example.json +245 -0
- package/modules/mission-control/mission-control/checklists/install-verification.md +46 -0
- package/modules/mission-control/mission-control/frameworks/framework-registry.md +83 -0
- package/modules/mission-control/mission-control/mission-control.md +83 -0
- package/modules/mission-control/mission-control/tasks/insights.md +73 -0
- package/modules/mission-control/mission-control/tasks/install.md +194 -0
- package/modules/mission-control/mission-control/tasks/status.md +125 -0
- package/modules/mission-control/schemas/entities.schema.json +89 -0
- package/modules/mission-control/schemas/projects.schema.json +221 -0
- package/modules/mission-control/schemas/state.schema.json +108 -0
- package/modules/mission-control/schemas/vector.schema.json +200 -0
- package/modules/momentum/README.md +678 -0
- package/modules/momentum/bin/install.js +563 -0
- package/modules/momentum/integration.js +131 -0
- package/modules/momentum/package.json +42 -0
- package/modules/momentum/schemas/entities.schema.json +89 -0
- package/modules/momentum/schemas/projects.schema.json +221 -0
- package/modules/momentum/schemas/state.schema.json +108 -0
- package/modules/momentum/src/commands/audit-claude-md.md +31 -0
- package/modules/momentum/src/commands/audit.md +33 -0
- package/modules/momentum/src/commands/groom.md +35 -0
- package/modules/momentum/src/commands/history.md +27 -0
- package/modules/momentum/src/commands/pulse.md +33 -0
- package/modules/momentum/src/commands/scaffold.md +33 -0
- package/modules/momentum/src/commands/status.md +28 -0
- package/modules/momentum/src/commands/surface-convert.md +35 -0
- package/modules/momentum/src/commands/surface-create.md +34 -0
- package/modules/momentum/src/commands/surface-list.md +27 -0
- package/modules/momentum/src/commands/vector-hygiene.md +33 -0
- package/modules/momentum/src/framework/context/momentum-principles.md +71 -0
- package/modules/momentum/src/framework/frameworks/audit-strategies.md +53 -0
- package/modules/momentum/src/framework/frameworks/satellite-registration.md +44 -0
- package/modules/momentum/src/framework/tasks/audit-claude-md.md +68 -0
- package/modules/momentum/src/framework/tasks/audit.md +64 -0
- package/modules/momentum/src/framework/tasks/groom.md +164 -0
- package/modules/momentum/src/framework/tasks/history.md +34 -0
- package/modules/momentum/src/framework/tasks/pulse.md +83 -0
- package/modules/momentum/src/framework/tasks/scaffold.md +202 -0
- package/modules/momentum/src/framework/tasks/status.md +35 -0
- package/modules/momentum/src/framework/tasks/surface-convert.md +143 -0
- package/modules/momentum/src/framework/tasks/surface-create.md +184 -0
- package/modules/momentum/src/framework/tasks/surface-list.md +42 -0
- package/modules/momentum/src/framework/tasks/vector-hygiene.md +160 -0
- package/modules/momentum/src/framework/templates/workspace-json.md +96 -0
- package/modules/momentum/src/hooks/_template.py +129 -0
- package/modules/momentum/src/hooks/active-hook.py +178 -0
- package/modules/momentum/src/hooks/backlog-hook.py +115 -0
- package/modules/momentum/src/hooks/mission-control-insights.py +169 -0
- package/modules/momentum/src/hooks/momentum-pulse-check.py +351 -0
- package/modules/momentum/src/hooks/operator.py +53 -0
- package/modules/momentum/src/hooks/psmm-injector.py +67 -0
- package/modules/momentum/src/hooks/satellite-detection.py +248 -0
- package/modules/momentum/src/packages/momentum-mcp/index.js +119 -0
- package/modules/momentum/src/packages/momentum-mcp/package.json +10 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/entities.js +226 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/operator.js +106 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/projects.js +322 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/psmm.js +206 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/state.js +199 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/surfaces.js +404 -0
- package/modules/momentum/src/skill/momentum.md +111 -0
- package/modules/momentum/src/tasks/groom.md +164 -0
- package/modules/momentum/src/templates/operator.json +66 -0
- package/modules/momentum/src/templates/workspace.json +111 -0
- package/modules/momentum/terminal.svg +77 -0
- package/modules/radar/README.md +1552 -0
- package/modules/radar/commands/audit.md +233 -0
- package/modules/radar/commands/guardrails.md +194 -0
- package/modules/radar/commands/init.md +207 -0
- package/modules/radar/commands/playbook.md +176 -0
- package/modules/radar/commands/remediate.md +156 -0
- package/modules/radar/commands/report.md +172 -0
- package/modules/radar/commands/resume.md +176 -0
- package/modules/radar/commands/status.md +148 -0
- package/modules/radar/commands/transform.md +205 -0
- package/modules/radar/commands/validate.md +177 -0
- package/modules/radar/docs/ARCHITECTURE.md +336 -0
- package/modules/radar/docs/GETTING-STARTED.md +287 -0
- package/modules/radar/docs/standards/agents.md +197 -0
- package/modules/radar/docs/standards/commands.md +250 -0
- package/modules/radar/docs/standards/domains.md +191 -0
- package/modules/radar/docs/standards/personas.md +211 -0
- package/modules/radar/docs/standards/rules.md +218 -0
- package/modules/radar/docs/standards/runtime.md +445 -0
- package/modules/radar/docs/standards/schemas.md +269 -0
- package/modules/radar/docs/standards/tools.md +273 -0
- package/modules/radar/docs/standards/workflows.md +254 -0
- package/modules/radar/docs/terminal.svg +72 -0
- package/modules/radar/docs/validation/convention-compliance-report.md +183 -0
- package/modules/radar/docs/validation/cross-reference-report.md +195 -0
- package/modules/radar/docs/validation/validation-summary.md +118 -0
- package/modules/radar/docs/validation/version-manifest.yaml +363 -0
- package/modules/radar/install.sh +711 -0
- package/modules/radar/integration.js +53 -0
- package/modules/radar/src/core/agents/architect.md +25 -0
- package/modules/radar/src/core/agents/compliance-officer.md +25 -0
- package/modules/radar/src/core/agents/data-engineer.md +25 -0
- package/modules/radar/src/core/agents/devils-advocate.md +22 -0
- package/modules/radar/src/core/agents/performance-engineer.md +25 -0
- package/modules/radar/src/core/agents/principal-engineer.md +23 -0
- package/modules/radar/src/core/agents/reality-gap-analyst.md +22 -0
- package/modules/radar/src/core/agents/security-engineer.md +25 -0
- package/modules/radar/src/core/agents/senior-app-engineer.md +25 -0
- package/modules/radar/src/core/agents/sre.md +25 -0
- package/modules/radar/src/core/agents/staff-engineer.md +23 -0
- package/modules/radar/src/core/agents/test-engineer.md +25 -0
- package/modules/radar/src/core/personas/architect.md +111 -0
- package/modules/radar/src/core/personas/compliance-officer.md +104 -0
- package/modules/radar/src/core/personas/data-engineer.md +113 -0
- package/modules/radar/src/core/personas/devils-advocate.md +105 -0
- package/modules/radar/src/core/personas/performance-engineer.md +119 -0
- package/modules/radar/src/core/personas/principal-engineer.md +119 -0
- package/modules/radar/src/core/personas/reality-gap-analyst.md +111 -0
- package/modules/radar/src/core/personas/security-engineer.md +108 -0
- package/modules/radar/src/core/personas/senior-app-engineer.md +111 -0
- package/modules/radar/src/core/personas/sre.md +117 -0
- package/modules/radar/src/core/personas/staff-engineer.md +109 -0
- package/modules/radar/src/core/personas/test-engineer.md +109 -0
- package/modules/radar/src/core/workflows/disagreement-resolution.md +183 -0
- package/modules/radar/src/core/workflows/phase-0-context.md +148 -0
- package/modules/radar/src/core/workflows/phase-1-reconnaissance.md +169 -0
- package/modules/radar/src/core/workflows/phase-2-domain-audits.md +190 -0
- package/modules/radar/src/core/workflows/phase-3-cross-domain.md +177 -0
- package/modules/radar/src/core/workflows/phase-4-adversarial-review.md +165 -0
- package/modules/radar/src/core/workflows/phase-5-report.md +189 -0
- package/modules/radar/src/core/workflows/phase-checkpoint.md +222 -0
- package/modules/radar/src/core/workflows/session-handoff.md +152 -0
- package/modules/radar/src/domains/00-context.md +201 -0
- package/modules/radar/src/domains/01-architecture.md +248 -0
- package/modules/radar/src/domains/02-data.md +224 -0
- package/modules/radar/src/domains/03-correctness.md +230 -0
- package/modules/radar/src/domains/04-security.md +274 -0
- package/modules/radar/src/domains/05-compliance.md +228 -0
- package/modules/radar/src/domains/06-testing.md +228 -0
- package/modules/radar/src/domains/07-reliability.md +246 -0
- package/modules/radar/src/domains/08-performance.md +247 -0
- package/modules/radar/src/domains/09-maintainability.md +271 -0
- package/modules/radar/src/domains/10-operability.md +250 -0
- package/modules/radar/src/domains/11-change-risk.md +246 -0
- package/modules/radar/src/domains/12-team-risk.md +221 -0
- package/modules/radar/src/domains/13-risk-synthesis.md +202 -0
- package/modules/radar/src/rules/agent-boundaries.md +78 -0
- package/modules/radar/src/rules/disagreement-protocol.md +76 -0
- package/modules/radar/src/rules/epistemic-hygiene.md +78 -0
- package/modules/radar/src/schemas/confidence.md +185 -0
- package/modules/radar/src/schemas/disagreement.md +238 -0
- package/modules/radar/src/schemas/finding.md +287 -0
- package/modules/radar/src/schemas/report-section.md +150 -0
- package/modules/radar/src/schemas/signal.md +108 -0
- package/modules/radar/src/tools/checkov.md +463 -0
- package/modules/radar/src/tools/git-history.md +581 -0
- package/modules/radar/src/tools/gitleaks.md +447 -0
- package/modules/radar/src/tools/grype.md +611 -0
- package/modules/radar/src/tools/semgrep.md +378 -0
- package/modules/radar/src/tools/sonarqube.md +550 -0
- package/modules/radar/src/tools/syft.md +539 -0
- package/modules/radar/src/tools/trivy.md +439 -0
- package/modules/radar/src/transform/agents/change-risk-modeler.md +24 -0
- package/modules/radar/src/transform/agents/execution-validator.md +24 -0
- package/modules/radar/src/transform/agents/guardrail-generator.md +24 -0
- package/modules/radar/src/transform/agents/pedagogy-agent.md +24 -0
- package/modules/radar/src/transform/agents/remediation-architect.md +24 -0
- package/modules/radar/src/transform/personas/change-risk-modeler.md +95 -0
- package/modules/radar/src/transform/personas/execution-validator.md +95 -0
- package/modules/radar/src/transform/personas/guardrail-generator.md +103 -0
- package/modules/radar/src/transform/personas/pedagogy-agent.md +105 -0
- package/modules/radar/src/transform/personas/remediation-architect.md +95 -0
- package/modules/radar/src/transform/rules/change-risk-rules.md +87 -0
- package/modules/radar/src/transform/rules/safety-governance.md +87 -0
- package/modules/radar/src/transform/schemas/change-risk.md +139 -0
- package/modules/radar/src/transform/schemas/intervention-level.md +207 -0
- package/modules/radar/src/transform/schemas/playbook.md +205 -0
- package/modules/radar/src/transform/schemas/verification-plan.md +134 -0
- package/modules/radar/src/transform/workflows/phase-6-remediation.md +148 -0
- package/modules/radar/src/transform/workflows/phase-7-risk-validation.md +161 -0
- package/modules/radar/src/transform/workflows/phase-8-execution-planning.md +159 -0
- package/modules/radar/src/transform/workflows/transform-safety.md +158 -0
- package/modules/vector/.vector-template/sessions/.gitkeep +0 -0
- package/modules/vector/.vector-template/vector.json +72 -0
- package/modules/vector/AUDIT-CLAUDEMD.md +154 -0
- package/modules/vector/INSTALL.md +185 -0
- package/modules/vector/LICENSE +21 -0
- package/modules/vector/README.md +409 -0
- package/modules/vector/VECTOR-BLOCK.md +57 -0
- package/modules/vector/assets/terminal.svg +68 -0
- package/modules/vector/bin/install.js +455 -0
- package/modules/vector/bin/migrate-v1-to-v2.sh +492 -0
- package/modules/vector/commands/help.md +46 -0
- package/modules/vector/hooks/vector-hook.py +775 -0
- package/modules/vector/mcp/index.js +118 -0
- package/modules/vector/mcp/package.json +10 -0
- package/modules/vector/mcp/tools/decisions.js +269 -0
- package/modules/vector/mcp/tools/domains.js +361 -0
- package/modules/vector/mcp/tools/staging.js +252 -0
- package/modules/vector/mcp/tools/vector-json.js +647 -0
- package/modules/vector/package.json +38 -0
- package/modules/vector/schemas/vector.schema.json +237 -0
- package/package.json +39 -0
- package/shared/branding/branding.js +70 -0
- package/shared/config/defaults.json +59 -0
- package/shared/events/README.md +175 -0
- package/shared/events/event-bus.js +134 -0
- package/shared/events/event_bus.py +255 -0
- package/shared/events/integrations.js +161 -0
- package/shared/events/schemas/audit-complete.schema.json +21 -0
- package/shared/events/schemas/phase-progress.schema.json +23 -0
- package/shared/events/schemas/plan-created.schema.json +21 -0
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
# PROJECT.md Template
|
|
2
|
+
|
|
3
|
+
Template for `.drive/PROJECT.md` — the project's business context and requirements.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Define what we're building, why it matters, and constraints. This is the "brief" that informs all planning. Init populates this from a type-adapted requirements walkthrough — instead of leaving placeholders, because plans built against real requirements produce better output.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# [Project Name]
|
|
13
|
+
|
|
14
|
+
## What This Is
|
|
15
|
+
|
|
16
|
+
[One paragraph describing what we're building. Be specific about the product/feature, not the technology.]
|
|
17
|
+
|
|
18
|
+
## Core Value
|
|
19
|
+
|
|
20
|
+
[Single sentence: What problem does this solve for whom? This is THE thing that matters.]
|
|
21
|
+
|
|
22
|
+
## Current State
|
|
23
|
+
|
|
24
|
+
| Attribute | Value |
|
|
25
|
+
|-----------|-------|
|
|
26
|
+
| Type | [Application / Campaign / Workflow / Other] |
|
|
27
|
+
| Version | [current version] |
|
|
28
|
+
| Status | [Prototype / MVP / Beta / Production] |
|
|
29
|
+
| Last Updated | [YYYY-MM-DD] |
|
|
30
|
+
|
|
31
|
+
**Production URLs:** (if applicable)
|
|
32
|
+
- [URL 1]: [Description]
|
|
33
|
+
- [URL 2]: [Description]
|
|
34
|
+
|
|
35
|
+
## Requirements
|
|
36
|
+
|
|
37
|
+
### Core [Features / Deliverables / Automation Scope]
|
|
38
|
+
|
|
39
|
+
<!-- Label adapts by project type:
|
|
40
|
+
Application: "Core Features" — the 3-5 things users do in this app
|
|
41
|
+
Campaign: "Core Deliverables" — landing pages, emails, ad copy, etc.
|
|
42
|
+
Workflow: "Automation Scope" — what this automates and what triggers it
|
|
43
|
+
Other: "Core Deliverables" — primary outputs of this project -->
|
|
44
|
+
|
|
45
|
+
- [item 1]
|
|
46
|
+
- [item 2]
|
|
47
|
+
- [item 3]
|
|
48
|
+
|
|
49
|
+
### Validated (Shipped)
|
|
50
|
+
|
|
51
|
+
[Requirements that have been implemented and proven]
|
|
52
|
+
|
|
53
|
+
- [x] [Requirement 1] — [version shipped]
|
|
54
|
+
|
|
55
|
+
### Active (In Progress)
|
|
56
|
+
|
|
57
|
+
[Requirements currently being worked on]
|
|
58
|
+
|
|
59
|
+
- [ ] [Requirement 1] — [status/notes]
|
|
60
|
+
|
|
61
|
+
### Planned (Next)
|
|
62
|
+
|
|
63
|
+
[Requirements queued for upcoming work]
|
|
64
|
+
|
|
65
|
+
- [ ] [Requirement 1]
|
|
66
|
+
|
|
67
|
+
### Out of Scope
|
|
68
|
+
|
|
69
|
+
[Explicitly excluded requirements — important for preventing scope creep]
|
|
70
|
+
|
|
71
|
+
- [Excluded feature 1] — [reason]
|
|
72
|
+
|
|
73
|
+
## Target Users
|
|
74
|
+
|
|
75
|
+
**Primary:** [Who is the main user]
|
|
76
|
+
- [Key characteristic 1]
|
|
77
|
+
- [Key characteristic 2]
|
|
78
|
+
- [Their main goal/need]
|
|
79
|
+
|
|
80
|
+
**Secondary:** [Other users, if applicable]
|
|
81
|
+
- [Characteristics]
|
|
82
|
+
|
|
83
|
+
## Context
|
|
84
|
+
|
|
85
|
+
**Business Context:**
|
|
86
|
+
[Relevant business information — market, partners, strategy]
|
|
87
|
+
|
|
88
|
+
**Technical Context:**
|
|
89
|
+
[Relevant technical information — existing systems, integrations, constraints]
|
|
90
|
+
|
|
91
|
+
## Constraints
|
|
92
|
+
|
|
93
|
+
### Technical Constraints
|
|
94
|
+
|
|
95
|
+
<!-- Type-adapted examples:
|
|
96
|
+
Application: deployment platform limits, framework constraints, auth requirements, external API dependencies
|
|
97
|
+
Campaign: platform limitations, character limits, image specs, automation constraints
|
|
98
|
+
Workflow: rate limits, API auth requirements, platform-specific restrictions, error handling needs -->
|
|
99
|
+
|
|
100
|
+
- [Constraint 1]
|
|
101
|
+
- [Constraint 2]
|
|
102
|
+
|
|
103
|
+
### Business Constraints
|
|
104
|
+
|
|
105
|
+
<!-- Type-adapted examples:
|
|
106
|
+
Application: budget, timeline, team skills, compliance requirements
|
|
107
|
+
Campaign: budget, timeline, brand guidelines, approval chains, legal review
|
|
108
|
+
Workflow: SLAs, uptime requirements, data handling policies, vendor contracts -->
|
|
109
|
+
|
|
110
|
+
- [Constraint 1]
|
|
111
|
+
- [Constraint 2]
|
|
112
|
+
|
|
113
|
+
### Compliance Constraints
|
|
114
|
+
- [Constraint 1: e.g., "GDPR data handling required"]
|
|
115
|
+
|
|
116
|
+
## Key Decisions
|
|
117
|
+
|
|
118
|
+
| Decision | Rationale | Date | Status |
|
|
119
|
+
|----------|-----------|------|--------|
|
|
120
|
+
| [What was decided] | [Why] | [YYYY-MM-DD] | Active / Superseded |
|
|
121
|
+
|
|
122
|
+
## Success Metrics
|
|
123
|
+
|
|
124
|
+
<!-- Type-adapted examples:
|
|
125
|
+
Application: test coverage, uptime, response time, user adoption, error rate
|
|
126
|
+
Campaign: conversion rate, open rate, click-through rate, ROAS, lead volume, cost per lead
|
|
127
|
+
Workflow: execution success rate, processing time, error rate, throughput, data accuracy -->
|
|
128
|
+
|
|
129
|
+
| Metric | Target | Current | Status |
|
|
130
|
+
|--------|--------|---------|--------|
|
|
131
|
+
| [Metric 1] | [Target value] | [Current value] | [On track / At risk / Achieved] |
|
|
132
|
+
|
|
133
|
+
## Tech Stack / Tools
|
|
134
|
+
|
|
135
|
+
<!-- Adapts by project type:
|
|
136
|
+
Application: framework, frontend, database, hosting, auth, payments
|
|
137
|
+
Campaign: platform (GHL, ClickFunnels), ad platforms (Meta, Google), email tool, analytics
|
|
138
|
+
Workflow: integration platform (Zapier, Make, custom), APIs, scheduler, monitoring
|
|
139
|
+
Other: whatever tools/platforms are involved -->
|
|
140
|
+
|
|
141
|
+
| Layer | Technology | Notes |
|
|
142
|
+
|-------|------------|-------|
|
|
143
|
+
| [Layer/Category] | [Tool/Technology] | [Why this choice] |
|
|
144
|
+
|
|
145
|
+
## Links
|
|
146
|
+
|
|
147
|
+
| Resource | URL |
|
|
148
|
+
|----------|-----|
|
|
149
|
+
| Repository | [URL] |
|
|
150
|
+
| Production | [URL] |
|
|
151
|
+
| Documentation | [URL] |
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
*PROJECT.md — Updated when requirements or context change*
|
|
155
|
+
*Last updated: [YYYY-MM-DD]*
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
## Section Specifications
|
|
161
|
+
|
|
162
|
+
### What This Is
|
|
163
|
+
**Purpose:** Concrete description of the product/feature.
|
|
164
|
+
**Length:** One paragraph.
|
|
165
|
+
**Focus:** What it is, not how it's built.
|
|
166
|
+
|
|
167
|
+
### Core Value
|
|
168
|
+
**Purpose:** The ONE thing that matters. Used to guide all decisions.
|
|
169
|
+
**Format:** Single sentence answering "What problem for whom?"
|
|
170
|
+
**Example:** "Attorneys can make informed accept/reject decisions on cases in under 2 minutes without reading raw documents."
|
|
171
|
+
|
|
172
|
+
### Core Features / Deliverables / Automation Scope
|
|
173
|
+
**Purpose:** The 3-5 primary capabilities or outputs this project delivers. Populated during init walkthrough.
|
|
174
|
+
**Type-adaptive label:**
|
|
175
|
+
- Application → "Core Features"
|
|
176
|
+
- Campaign → "Core Deliverables"
|
|
177
|
+
- Workflow → "Automation Scope"
|
|
178
|
+
- Other → "Core Deliverables"
|
|
179
|
+
**Why:** Plans that reference specific features produce better acceptance criteria than plans referencing "[To be defined]" placeholders.
|
|
180
|
+
|
|
181
|
+
### Requirements
|
|
182
|
+
**Purpose:** Track feature state across development.
|
|
183
|
+
**Categories:**
|
|
184
|
+
- **Core [Features/Deliverables]:** Top-level project capabilities (populated during init)
|
|
185
|
+
- **Validated:** Shipped and proven
|
|
186
|
+
- **Active:** Currently being implemented
|
|
187
|
+
- **Planned:** Queued for future
|
|
188
|
+
- **Out of Scope:** Explicitly excluded (prevents scope creep)
|
|
189
|
+
|
|
190
|
+
### Target Users
|
|
191
|
+
**Purpose:** Who we're building for.
|
|
192
|
+
**Include:** Characteristics, goals, needs.
|
|
193
|
+
**Why:** Prevents building for imaginary users.
|
|
194
|
+
**Note:** For campaigns, this is the target audience. For workflows, this may be internal team or system consumers.
|
|
195
|
+
|
|
196
|
+
### Constraints
|
|
197
|
+
**Purpose:** Hard limits on solutions.
|
|
198
|
+
**Categories:**
|
|
199
|
+
- Technical (platform, technology requirements)
|
|
200
|
+
- Business (partnerships, integrations, budget)
|
|
201
|
+
- Compliance (legal, regulatory, security)
|
|
202
|
+
**Type-adaptive:** Comments in template show relevant examples per project type.
|
|
203
|
+
|
|
204
|
+
### Key Decisions
|
|
205
|
+
**Purpose:** Record of significant decisions.
|
|
206
|
+
**Include:** What, why, when, status (Active/Superseded).
|
|
207
|
+
**Integration:** Can sync with decision-logger MCP.
|
|
208
|
+
**Note:** Init walkthrough may capture early decisions (tech stack, platform choice, approach). These are pre-populated if gathered.
|
|
209
|
+
|
|
210
|
+
### Success Metrics
|
|
211
|
+
**Purpose:** Measurable outcomes.
|
|
212
|
+
**Include:** Target values and current state.
|
|
213
|
+
**Type-adaptive:** Application metrics differ from campaign metrics differ from workflow metrics. Comments show relevant examples per type.
|
|
214
|
+
**Why:** Objective success criteria prevent endless scope expansion.
|
|
215
|
+
|
|
216
|
+
### Tech Stack / Tools
|
|
217
|
+
**Purpose:** What technologies and platforms are involved.
|
|
218
|
+
**Type-adaptive:** "Tech Stack" for applications, "Platforms & Tools" for campaigns, "Integration Stack" for workflows. The table format accommodates all types.
|
|
219
|
+
**Note:** Populated during init walkthrough when user discusses their stack/tools/platforms.
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# RESEARCH.md Template
|
|
2
|
+
|
|
3
|
+
Template for `.drive/research/{topic-slug}.md` - research findings from subagent discovery.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Captures research findings for main session review. Created by `/drive:research` or `/drive:research-phase`.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Research: {Topic}
|
|
13
|
+
|
|
14
|
+
**Generated:** {date}
|
|
15
|
+
**Status:** Draft | Reviewed | Integrated
|
|
16
|
+
**Agent Type:** Explore | general-purpose
|
|
17
|
+
**Spawn Time:** {timestamp}
|
|
18
|
+
|
|
19
|
+
## Topic
|
|
20
|
+
|
|
21
|
+
{Original research question or topic}
|
|
22
|
+
|
|
23
|
+
## Sources
|
|
24
|
+
|
|
25
|
+
{List of sources consulted}
|
|
26
|
+
- [Source 1](url) - {brief description}
|
|
27
|
+
- [Source 2](url) - {brief description}
|
|
28
|
+
- Codebase: {file paths examined}
|
|
29
|
+
|
|
30
|
+
## Findings
|
|
31
|
+
|
|
32
|
+
### Key Points
|
|
33
|
+
|
|
34
|
+
{Main findings as bullets}
|
|
35
|
+
- Finding 1
|
|
36
|
+
- Finding 2
|
|
37
|
+
- Finding 3
|
|
38
|
+
|
|
39
|
+
### Details
|
|
40
|
+
|
|
41
|
+
{Detailed findings, organized by subtopic}
|
|
42
|
+
|
|
43
|
+
#### {Subtopic 1}
|
|
44
|
+
|
|
45
|
+
{Details, code examples, patterns found}
|
|
46
|
+
|
|
47
|
+
#### {Subtopic 2}
|
|
48
|
+
|
|
49
|
+
{Details, code examples, patterns found}
|
|
50
|
+
|
|
51
|
+
## Recommendations
|
|
52
|
+
|
|
53
|
+
{Actionable recommendations based on findings}
|
|
54
|
+
- Recommendation 1: {what to do and why}
|
|
55
|
+
- Recommendation 2: {what to do and why}
|
|
56
|
+
|
|
57
|
+
## Open Questions
|
|
58
|
+
|
|
59
|
+
{Items that need further investigation}
|
|
60
|
+
- Question 1
|
|
61
|
+
- Question 2
|
|
62
|
+
|
|
63
|
+
## Subagent Metadata
|
|
64
|
+
|
|
65
|
+
| Field | Value |
|
|
66
|
+
|-------|-------|
|
|
67
|
+
| Agent Type | {Explore \| general-purpose} |
|
|
68
|
+
| Spawned | {timestamp} |
|
|
69
|
+
| Duration | {approximate} |
|
|
70
|
+
| Token Estimate | {rough estimate if available} |
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
*Created by /drive:research. Review before integrating.*
|
|
75
|
+
*Status should be updated when findings are reviewed or integrated.*
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## Field Descriptions
|
|
81
|
+
|
|
82
|
+
| Field | Purpose |
|
|
83
|
+
|-------|---------|
|
|
84
|
+
| `Topic` | Original research question |
|
|
85
|
+
| `Status` | Draft (new), Reviewed (vetted), Integrated (used) |
|
|
86
|
+
| `Agent Type` | Which subagent performed research |
|
|
87
|
+
| `Sources` | Documentation, URLs, or files consulted |
|
|
88
|
+
| `Findings` | Key points and detailed findings |
|
|
89
|
+
| `Recommendations` | Actionable next steps |
|
|
90
|
+
| `Open Questions` | Items needing more research |
|
|
91
|
+
| `Subagent Metadata` | Tracking info for research task |
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## Status Lifecycle
|
|
96
|
+
|
|
97
|
+
```
|
|
98
|
+
Draft ──▶ Reviewed ──▶ Integrated
|
|
99
|
+
│ │ │
|
|
100
|
+
│ │ └── Findings used in plan/code
|
|
101
|
+
│ └── Main session vetted findings
|
|
102
|
+
└── Fresh from subagent
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
**Draft:** Subagent just completed research
|
|
106
|
+
**Reviewed:** Main session has vetted and confirmed findings
|
|
107
|
+
**Integrated:** Findings have been incorporated into plans or code
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## Usage Pattern
|
|
112
|
+
|
|
113
|
+
1. User runs `/drive:research <topic>`
|
|
114
|
+
2. Workflow spawns appropriate subagent
|
|
115
|
+
3. Subagent researches and returns findings
|
|
116
|
+
4. RESEARCH.md created with status: Draft
|
|
117
|
+
5. Main session reviews findings
|
|
118
|
+
6. Status updated to Reviewed when vetted
|
|
119
|
+
7. Status updated to Integrated when used
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## Relationship to Other Files
|
|
124
|
+
|
|
125
|
+
| File | Relationship |
|
|
126
|
+
|------|--------------|
|
|
127
|
+
| CONTEXT.md | May inform discussion or result from questions |
|
|
128
|
+
| PLAN.md | May reference research findings |
|
|
129
|
+
| RESEARCH.md | This file (research output) |
|
|
130
|
+
| subagent-criteria.md | Validates when to spawn research |
|
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
# ROADMAP.md Template
|
|
2
|
+
|
|
3
|
+
Template for `.drive/ROADMAP.md` — the project's phase structure.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Define milestones and phases. Provides structure, not detailed tasks.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Milestone Status Legend
|
|
10
|
+
|
|
11
|
+
| Emoji | Status | Meaning |
|
|
12
|
+
|-------|--------|---------|
|
|
13
|
+
| ✅ | Shipped | Milestone complete and archived |
|
|
14
|
+
| 🚧 | In Progress | Active development |
|
|
15
|
+
| 📋 | Planned | Defined but not started |
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## File Template (Initial v1.0)
|
|
20
|
+
|
|
21
|
+
```markdown
|
|
22
|
+
# Roadmap: [Project Name]
|
|
23
|
+
|
|
24
|
+
## Overview
|
|
25
|
+
|
|
26
|
+
[One paragraph describing the journey from start to finish]
|
|
27
|
+
|
|
28
|
+
## Current Milestone
|
|
29
|
+
|
|
30
|
+
**[Milestone Name]** ([version])
|
|
31
|
+
Status: [Not started | In progress | Complete]
|
|
32
|
+
Phases: [X] of [Y] complete
|
|
33
|
+
|
|
34
|
+
## Phases
|
|
35
|
+
|
|
36
|
+
**Phase Numbering:**
|
|
37
|
+
- Integer phases (1, 2, 3): Planned milestone work
|
|
38
|
+
- Decimal phases (2.1, 2.2): Urgent insertions (marked with [INSERTED])
|
|
39
|
+
|
|
40
|
+
Phases execute in numeric order: 1 → 2 → 2.1 → 2.2 → 3 → 3.1 → 4
|
|
41
|
+
|
|
42
|
+
| Phase | Name | Plans | Status | Completed |
|
|
43
|
+
|-------|------|-------|--------|-----------|
|
|
44
|
+
| 1 | [Name] | [N] | Not started | - |
|
|
45
|
+
| 2 | [Name] | [N] | Not started | - |
|
|
46
|
+
| 3 | [Name] | [N] | Not started | - |
|
|
47
|
+
| 4 | [Name] | [N] | Not started | - |
|
|
48
|
+
|
|
49
|
+
## Phase Details
|
|
50
|
+
|
|
51
|
+
### Phase 1: [Name]
|
|
52
|
+
|
|
53
|
+
**Goal:** [What this phase delivers - specific outcome]
|
|
54
|
+
**Depends on:** Nothing (first phase)
|
|
55
|
+
**Research:** [Unlikely | Likely] ([reason])
|
|
56
|
+
|
|
57
|
+
**Scope:**
|
|
58
|
+
- [Deliverable 1]
|
|
59
|
+
- [Deliverable 2]
|
|
60
|
+
- [Deliverable 3]
|
|
61
|
+
|
|
62
|
+
**Plans:**
|
|
63
|
+
- [ ] 01-01: [Brief description]
|
|
64
|
+
- [ ] 01-02: [Brief description]
|
|
65
|
+
- [ ] 01-03: [Brief description]
|
|
66
|
+
|
|
67
|
+
### Phase 2: [Name]
|
|
68
|
+
|
|
69
|
+
**Goal:** [What this phase delivers]
|
|
70
|
+
**Depends on:** Phase 1 ([specific dependency])
|
|
71
|
+
**Research:** [Unlikely | Likely] ([reason])
|
|
72
|
+
**Research topics:** [If Likely - what needs investigating]
|
|
73
|
+
|
|
74
|
+
**Scope:**
|
|
75
|
+
- [Deliverable 1]
|
|
76
|
+
- [Deliverable 2]
|
|
77
|
+
|
|
78
|
+
**Plans:**
|
|
79
|
+
- [ ] 02-01: [Brief description]
|
|
80
|
+
- [ ] 02-02: [Brief description]
|
|
81
|
+
|
|
82
|
+
### Phase 2.1: [Name] [INSERTED]
|
|
83
|
+
|
|
84
|
+
**Goal:** [Urgent work inserted between phases]
|
|
85
|
+
**Depends on:** Phase 2
|
|
86
|
+
**Reason:** [Why this was inserted]
|
|
87
|
+
|
|
88
|
+
**Plans:**
|
|
89
|
+
- [ ] 02.1-01: [Description]
|
|
90
|
+
|
|
91
|
+
### Phase 3: [Name]
|
|
92
|
+
|
|
93
|
+
**Goal:** [What this phase delivers]
|
|
94
|
+
**Depends on:** Phase 2 ([specific dependency])
|
|
95
|
+
**Research:** [Unlikely | Likely]
|
|
96
|
+
|
|
97
|
+
**Scope:**
|
|
98
|
+
- [Deliverable 1]
|
|
99
|
+
- [Deliverable 2]
|
|
100
|
+
|
|
101
|
+
**Plans:**
|
|
102
|
+
- [ ] 03-01: [Brief description]
|
|
103
|
+
- [ ] 03-02: [Brief description]
|
|
104
|
+
|
|
105
|
+
### Phase 4: [Name]
|
|
106
|
+
|
|
107
|
+
**Goal:** [What this phase delivers]
|
|
108
|
+
**Depends on:** Phase 3
|
|
109
|
+
**Research:** Unlikely (internal patterns)
|
|
110
|
+
|
|
111
|
+
**Scope:**
|
|
112
|
+
- [Deliverable 1]
|
|
113
|
+
|
|
114
|
+
**Plans:**
|
|
115
|
+
- [ ] 04-01: [Brief description]
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
*Roadmap created: [YYYY-MM-DD]*
|
|
119
|
+
*Last updated: [YYYY-MM-DD]*
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## File Template (After v1.0 Ships)
|
|
125
|
+
|
|
126
|
+
After completing first milestone, reorganize with milestone groupings:
|
|
127
|
+
|
|
128
|
+
```markdown
|
|
129
|
+
# Roadmap: [Project Name]
|
|
130
|
+
|
|
131
|
+
## Milestones
|
|
132
|
+
|
|
133
|
+
| Version | Name | Phases | Status | Completed |
|
|
134
|
+
|---------|------|--------|--------|-----------|
|
|
135
|
+
| v1.0 | MVP | 1-4 | ✅ Shipped | YYYY-MM-DD |
|
|
136
|
+
| v1.1 | [Name] | 5-6 | 🚧 In Progress | - |
|
|
137
|
+
| v2.0 | [Name] | 7-10 | 📋 Planned | - |
|
|
138
|
+
|
|
139
|
+
## 🚧 Active Milestone: v1.1 [Name]
|
|
140
|
+
|
|
141
|
+
**Goal:** [What v1.1 delivers]
|
|
142
|
+
**Status:** Phase [X] of [Y]
|
|
143
|
+
**Progress:** [██████░░░░] 60%
|
|
144
|
+
|
|
145
|
+
### Phase 5: [Name]
|
|
146
|
+
|
|
147
|
+
**Goal:** [What this phase delivers]
|
|
148
|
+
**Depends on:** Phase 4
|
|
149
|
+
|
|
150
|
+
**Plans:**
|
|
151
|
+
- [x] 05-01: [Completed plan]
|
|
152
|
+
- [ ] 05-02: [In progress or pending]
|
|
153
|
+
|
|
154
|
+
### Phase 6: [Name]
|
|
155
|
+
|
|
156
|
+
**Goal:** [What this phase delivers]
|
|
157
|
+
**Depends on:** Phase 5
|
|
158
|
+
|
|
159
|
+
**Plans:**
|
|
160
|
+
- [ ] 06-01: [Brief description]
|
|
161
|
+
|
|
162
|
+
## 📋 Planned Milestone: v2.0 [Name]
|
|
163
|
+
|
|
164
|
+
**Goal:** [What v2.0 delivers]
|
|
165
|
+
**Prerequisite:** v1.1 complete
|
|
166
|
+
**Estimated phases:** [N]
|
|
167
|
+
|
|
168
|
+
[Phase outlines without detailed plans — detail added when milestone begins]
|
|
169
|
+
|
|
170
|
+
| Phase | Focus | Research |
|
|
171
|
+
|-------|-------|----------|
|
|
172
|
+
| 7 | [Focus] | Unlikely |
|
|
173
|
+
| 8 | [Focus] | Likely |
|
|
174
|
+
| 9 | [Focus] | Unlikely |
|
|
175
|
+
| 10 | [Focus] | Unlikely |
|
|
176
|
+
|
|
177
|
+
## ✅ Completed Milestones
|
|
178
|
+
|
|
179
|
+
<details>
|
|
180
|
+
<summary>v1.0 MVP (Phases 1-4) — Shipped YYYY-MM-DD</summary>
|
|
181
|
+
|
|
182
|
+
### Phase 1: [Name]
|
|
183
|
+
**Goal:** [What was delivered]
|
|
184
|
+
**Plans:** 3 complete
|
|
185
|
+
|
|
186
|
+
- [x] 01-01: [Description]
|
|
187
|
+
- [x] 01-02: [Description]
|
|
188
|
+
- [x] 01-03: [Description]
|
|
189
|
+
|
|
190
|
+
### Phase 2: [Name]
|
|
191
|
+
**Goal:** [What was delivered]
|
|
192
|
+
**Plans:** 2 complete
|
|
193
|
+
|
|
194
|
+
- [x] 02-01: [Description]
|
|
195
|
+
- [x] 02-02: [Description]
|
|
196
|
+
|
|
197
|
+
### Phase 3: [Name]
|
|
198
|
+
**Goal:** [What was delivered]
|
|
199
|
+
**Plans:** 1 complete
|
|
200
|
+
|
|
201
|
+
- [x] 03-01: [Description]
|
|
202
|
+
|
|
203
|
+
### Phase 4: [Name]
|
|
204
|
+
**Goal:** [What was delivered]
|
|
205
|
+
**Plans:** 1 complete
|
|
206
|
+
|
|
207
|
+
- [x] 04-01: [Description]
|
|
208
|
+
|
|
209
|
+
**Milestone archive:** See [milestones/v1.0-mvp.md](milestones/v1.0-mvp.md)
|
|
210
|
+
|
|
211
|
+
</details>
|
|
212
|
+
|
|
213
|
+
---
|
|
214
|
+
*Last updated: [YYYY-MM-DD]*
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
---
|
|
218
|
+
|
|
219
|
+
## Section Specifications
|
|
220
|
+
|
|
221
|
+
### Overview
|
|
222
|
+
**Purpose:** High-level journey description.
|
|
223
|
+
**Length:** One paragraph.
|
|
224
|
+
**Update:** When project direction changes significantly.
|
|
225
|
+
|
|
226
|
+
### Current Milestone
|
|
227
|
+
**Purpose:** Quick reference to active milestone.
|
|
228
|
+
**Contains:** Name, version, status, phase progress.
|
|
229
|
+
**Update:** After each phase completion.
|
|
230
|
+
|
|
231
|
+
### Phases Table
|
|
232
|
+
**Purpose:** At-a-glance view of all phases.
|
|
233
|
+
**Contains:** Phase number, name, plan count, status, completion date.
|
|
234
|
+
**Update:** After each plan/phase completion.
|
|
235
|
+
|
|
236
|
+
### Phase Details
|
|
237
|
+
**Purpose:** Detailed breakdown of each phase.
|
|
238
|
+
**Contains:**
|
|
239
|
+
- **Goal:** Specific deliverable outcome
|
|
240
|
+
- **Depends on:** Phase dependencies with reason
|
|
241
|
+
- **Research:** Likely/Unlikely with justification
|
|
242
|
+
- **Scope:** Bullet list of deliverables
|
|
243
|
+
- **Plans:** Checklist with brief descriptions
|
|
244
|
+
|
|
245
|
+
**Update:** During planning; status after completion.
|
|
246
|
+
|
|
247
|
+
---
|
|
248
|
+
|
|
249
|
+
## Phase Numbering
|
|
250
|
+
|
|
251
|
+
**Integer phases (1, 2, 3):** Planned work from roadmap creation.
|
|
252
|
+
|
|
253
|
+
**Decimal phases (2.1, 2.2):** Urgent insertions.
|
|
254
|
+
- Insert between consecutive integers
|
|
255
|
+
- Mark with [INSERTED] tag
|
|
256
|
+
- Include reason for insertion
|
|
257
|
+
- Filesystem sorts correctly: 2 < 2.1 < 2.2 < 3
|
|
258
|
+
|
|
259
|
+
**Validation for decimal insertion:**
|
|
260
|
+
- Integer X must exist and be complete
|
|
261
|
+
- Integer X+1 must exist in roadmap
|
|
262
|
+
- Decimal X.Y must not already exist
|
|
263
|
+
- Y >= 1
|
|
264
|
+
|
|
265
|
+
---
|
|
266
|
+
|
|
267
|
+
## Depth Configuration
|
|
268
|
+
|
|
269
|
+
Phase count depends on project depth:
|
|
270
|
+
|
|
271
|
+
| Depth | Typical Phases | Plans/Phase |
|
|
272
|
+
|-------|----------------|-------------|
|
|
273
|
+
| Quick | 3-5 | 1-3 |
|
|
274
|
+
| Standard | 5-8 | 3-5 |
|
|
275
|
+
| Comprehensive | 8-12 | 5-10 |
|
|
276
|
+
|
|
277
|
+
**Key principle:** Derive phases from actual work. Depth determines compression tolerance, not a target to hit.
|
|
278
|
+
|
|
279
|
+
---
|
|
280
|
+
|
|
281
|
+
## Research Flags
|
|
282
|
+
|
|
283
|
+
- **Unlikely:** Internal patterns, CRUD operations, established conventions
|
|
284
|
+
- **Likely:** External APIs, new libraries, architectural decisions
|
|
285
|
+
|
|
286
|
+
When `Research: Likely`:
|
|
287
|
+
- Include `Research topics:` field
|
|
288
|
+
- Consider research phase before implementation
|
|
289
|
+
- Discovery may be required during planning
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
## Status Values
|
|
294
|
+
|
|
295
|
+
| Status | Meaning |
|
|
296
|
+
|--------|---------|
|
|
297
|
+
| Not started | Phase hasn't begun |
|
|
298
|
+
| In progress | Actively working |
|
|
299
|
+
| Complete | All plans done (add date) |
|
|
300
|
+
| Deferred | Pushed to later (add reason) |
|
|
301
|
+
|
|
302
|
+
---
|
|
303
|
+
|
|
304
|
+
## Milestone Sections
|
|
305
|
+
|
|
306
|
+
### Active Milestone
|
|
307
|
+
**Purpose:** Currently executing milestone with full phase details.
|
|
308
|
+
**Contains:**
|
|
309
|
+
- Goal and status summary
|
|
310
|
+
- Progress bar visualization
|
|
311
|
+
- All phases with plan checklists
|
|
312
|
+
- Research flags where applicable
|
|
313
|
+
|
|
314
|
+
### Planned Milestone
|
|
315
|
+
**Purpose:** Defined but not started milestone.
|
|
316
|
+
**Contains:**
|
|
317
|
+
- Goal and prerequisites
|
|
318
|
+
- Phase table (focus areas, research likelihood)
|
|
319
|
+
- NOT detailed plans (added when milestone begins)
|
|
320
|
+
|
|
321
|
+
### Completed Milestones
|
|
322
|
+
**Purpose:** Historical record in collapsible sections.
|
|
323
|
+
**Contains:**
|
|
324
|
+
- Summary header with ship date
|
|
325
|
+
- Phase details (collapsed by default)
|
|
326
|
+
- Link to full milestone archive
|
|
327
|
+
|
|
328
|
+
**Key principle:** Completed work should not consume visual space — collapse it.
|