81 lines
3.7 KiB
Markdown
81 lines
3.7 KiB
Markdown
|
# MarkiTect Todofile System
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
MarkiTect uses the **Keep a Todofile V0.0.1** format for task management and development coordination. This replaces the previous NEXT.md approach with a standardized todofile system that provides better structure for maintaining coding flow and AI assistant coordination.
|
||
|
|
|
||
|
|
## Location and Format
|
||
|
|
|
||
|
|
- **Main Todofile**: `TODO.md` in the project root
|
||
|
|
- **Format**: [Keep a Todofile V0.0.1](https://coulomb.social/open/KeepaTodofile)
|
||
|
|
- **Agent Support**: Managed by the `agent-keepaTodofile` agent in the kaizen-agentic framework
|
||
|
|
|
||
|
|
## Structure
|
||
|
|
|
||
|
|
The todofile is organized by **impact type** rather than arbitrary priority:
|
||
|
|
|
||
|
|
### [Unreleased] - Active Vibe-Coding State 💡
|
||
|
|
- **To Add**: New features, capabilities, or functionality
|
||
|
|
- **To Refactor**: Code improvements and restructuring
|
||
|
|
- **To Fix**: Bug fixes and error corrections
|
||
|
|
- **To Remove**: Features or code to eliminate
|
||
|
|
|
||
|
|
### [Version] - Planned Increments
|
||
|
|
Organized by planned version/milestone with the same impact categories:
|
||
|
|
- **To Add**: Planned new functionality
|
||
|
|
- **To Fix**: Scheduled bug fixes
|
||
|
|
- **To Refactor**: Planned code improvements
|
||
|
|
- **To Deprecate**: Features marked for future removal
|
||
|
|
- **To Secure**: Security improvements
|
||
|
|
- **To Remove**: Planned removals
|
||
|
|
|
||
|
|
## Integration with Project Workflow
|
||
|
|
|
||
|
|
### Task Management
|
||
|
|
- Use `TODO.md` for active development tasks and immediate next steps
|
||
|
|
- Link to Gitea issues for longer-term planning: `Related to issue #123`
|
||
|
|
- Update during development sessions to maintain context
|
||
|
|
|
||
|
|
### AI Assistant Coordination
|
||
|
|
- The todofile serves as a **shared source of truth** between human developers and AI assistants
|
||
|
|
- Helps maintain context during interruptions and session transfers
|
||
|
|
- Enables consistent progress tracking and decision-making
|
||
|
|
|
||
|
|
### Development Best Practices
|
||
|
|
1. **Update Regularly**: Maintain current state during active development
|
||
|
|
2. **Focus on Immediate**: Keep [Unreleased] section for current work
|
||
|
|
3. **Plan Versions**: Use version sections for commit boundaries
|
||
|
|
4. **Archive Completed**: Move completed items to archive sections
|
||
|
|
5. **Link Issues**: Connect todofile items to Gitea issues for full context
|
||
|
|
|
||
|
|
## Agent Integration
|
||
|
|
|
||
|
|
The `agent-keepaTodofile` agent provides specialized support for:
|
||
|
|
- Creating and maintaining TODO.md files following the official format
|
||
|
|
- Organizing tasks by impact type (Add, Fix, Refactor, etc.)
|
||
|
|
- Integrating with issue tracking and TDD workflows
|
||
|
|
- Maintaining coding flow and context preservation
|
||
|
|
- Converting between task management formats
|
||
|
|
|
||
|
|
## Migration from NEXT.md
|
||
|
|
|
||
|
|
The previous NEXT.md file has been archived to `history/NEXT_archived_YYYYMMDD.md`. All relevant content has been migrated to the new TODO.md format while preserving:
|
||
|
|
- Strategic development priorities
|
||
|
|
- Capability management workflows
|
||
|
|
- Session success criteria
|
||
|
|
- Development milestones
|
||
|
|
|
||
|
|
## Related Documentation
|
||
|
|
|
||
|
|
- **Agent Definition**: `agents/agent-keepaTodofile.md` - Specialized todofile management agent
|
||
|
|
- **Context Documentation**: `capabilities/kaizen-agentic/context/KeepaTodofile.md` - Detailed format specification
|
||
|
|
- **Capability Integration**: `CAPABILITY_INCLUSION_GUIDE.md` - How todofile fits with capability discovery
|
||
|
|
- **Project Management**: `agents/agent-project-management.md` - Overall project coordination
|
||
|
|
|
||
|
|
## Benefits
|
||
|
|
|
||
|
|
1. **Standardized Format**: Follows established Keep a Todofile conventions
|
||
|
|
2. **Better Organization**: Impact-based categorization aligns with changelog structure
|
||
|
|
3. **AI Assistant Ready**: Designed for human-AI collaboration in coding sessions
|
||
|
|
4. **Context Preservation**: Maintains coding flow across interruptions
|
||
|
|
5. **Integration Ready**: Works with existing issue management and TDD workflows
|