A structured system for maintaining AI-friendly codebase documentation with phased implementation tracking, system reference files, and incremental development workflow for Cursor IDE.
A structured workflow system for maintaining AI-optimized codebase documentation and ensuring consistent, context-aware code generation in Cursor IDE.
This skill establishes a comprehensive documentation framework that helps AI assistants understand your codebase through System Reference Files (SRF). It implements a phased development workflow with the "Rule of Seven" methodology to ensure all code changes align with existing architecture and are properly documented.
1. **Create System Reference Files (SRF)** in your `CodeBase_Docs/` directory:
- `Cursor_System_Architecture.md` - Phased restructuring plan with implementation priorities
- `Cursor_System_Integration.md` - Current state architecture reference
- `System_Directory_Tree.md` - Complete outline of your codebase structure
- `System_Development_History.md` - Comprehensive history of development decisions
- `Scratchpad.md` - Task tracking and implementation context
Follow these seven steps for every code implementation task:
1. **Review Scratchpad**: Check current task and plan implementation steps
2. **Search SRF**: Look for existing implementations in System Reference Files; adjust plan accordingly
3. **Take Action**: Execute the task implementation
4. **Review Dependencies**: Check for missing implementations required by recent changes
5. **Identify Gaps**: Document any implementation gaps and plan necessary steps
6. **Update System Docs**: Maintain consistency in `Cursor_System_Architecture.md` and `Cursor_System_Integration.md`
7. **Update Scratchpad**: Record progress and next steps
Before generating any code:
1. Always check `System_Directory_Tree.md` for codebase structure
2. Review relevant System Reference Files for existing patterns
3. If context is unclear, search `CodeBase_Context.md` using grep or file search
4. **Ask the user** before creating new implementations if existing patterns aren't found
Maintain task progress in `Scratchpad.md` using this format:
```markdown
[X] Task 1 - Description of completed task
[X] Subtask 1.1 - Completed subtask
[ ] Task 2 - Next task to work on
[ ] Subtask 2.1 - Pending subtask
```
Update markers as work progresses to maintain clear context across sessions.
**User Request**: "Add user authentication to the API"
**AI Response**:
1. ✓ Review Scratchpad - Current focus: API development phase
2. ✓ Search SRF - Found existing auth patterns in `Cursor_System_Integration.md`
3. → Implementing JWT-based auth following existing pattern...
4. ✓ Review - Auth requires middleware integration in routes
5. → Planning middleware implementation steps...
6. ✓ Update System Docs - Added auth implementation to architecture doc
7. ✓ Update Scratchpad:
```
[X] Add user authentication to API
[X] JWT token generation
[X] Auth middleware
[ ] Route protection implementation
```
Leave a review
No reviews yet. Be the first to review this skill!
# Download SKILL.md from killerskills.ai/api/skills/cursor-codebase-context-system/raw