Plans Directory โ
This directory contains forward-looking implementation plans, roadmaps, and architectural decisions.
Purpose โ
Plans document what to do next, while worklogs document what was done:
- Plans โ Future work, implementation strategy, roadmaps
- Worklogs โ Historical record, outcomes, what was completed
Naming Convention โ
YYYY-MM-DD_{FEATURE}_plan.mdExamples:
2026-02-06_12-week-roadmap.md- Multi-week development roadmap2026-02-10_mobile-app_plan.md- Implementation plan for mobile app2026-03-01_api-refactor_plan.md- API refactoring strategy
When to Create a Plan โ
Create a plan document when:
- โ Starting major feature work (multiple PRs, weeks of effort)
- โ Making architectural decisions that affect multiple areas
- โ Planning multi-week or multi-month roadmaps
- โ Designing complex system interactions
Don't create a plan for:
- โ Simple bug fixes or single-file changes
- โ Routine maintenance tasks
- โ Work that's already documented in issues
Plan Structure โ
A good plan should include:
- Context - Why this work is needed
- Goals - What we're trying to achieve
- Approach - How we'll implement it
- Work Breakdown - Specific tasks and phases
- Critical Files - Key files that will be modified
- Verification - How to test the implementation
- Dependencies - What needs to happen first
- Timeline - Estimated duration
Keeping Plans Current โ
Plans are living documents:
- โ Update as priorities shift
- โ Mark sections complete as work progresses
- โ Add "Status" and "Last Updated" fields
- โ Archive or mark as "Superseded" when outdated
Related Documentation โ
- ../worklog/ - Historical record of completed work
- ../engineering/guides/DIRECTORY_DEFINITIONS.md - Codebase structure guide
- ../../CLAUDE.md - Project guidelines for Claude Code