markitect-main/roadmap/README.md

29 lines
1.1 KiB
Markdown
Raw Normal View History

# MarkiTect Project Roadmap
This roadmap directory contains planning directories for roadmap topics.
- When starting to implement a topic its directory will be timestamped
- If implementing multiple topics in parallel use branches
- Keep current state of what's next to implement in TODO.md
- See ../history directory for closed topics
## Naming Convention
**Directory Format:** `yymmdd-topic-name`
- Use 2-digit year prefix (e.g., `260106-` for 2026-01-06)
- Lowercase topic names with hyphens
- Examples: `260106-semantic-document-validation`, `260105-schema-evolution`
This convention keeps names concise while maintaining chronological sorting.
## Purpose
This planning documentation serves multiple purposes:
1. **Implementation State Awareness**: Allow for recovery after breaks or breakdowns
2. **Minimal Plan-Implement Loop**: Don't complicate agentic coding with issue tracking if unnecessary
3. **Planning Info Analysis**: Keeping the planning info allows for retrospective analyses to optimize
4. **Clean Repo Structure**: Using roadmap/ for planning and TODO.md as current state helps stay organized
xxx