mirror of
https://github.com/pacnpal/thrillwiki_laravel.git
synced 2025-12-22 21:31:11 -05:00
feat: enhance documentation system with Handoffs integration and structured guidelines
This commit is contained in:
40
handoffs/0-instructions/0-intro.md
Normal file
40
handoffs/0-instructions/0-intro.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Handoffs System Introduction
|
||||
|
||||
The Handoffs System complements our Memory Bank by providing chronological documentation of development progress and enabling clean context transitions between LLM sessions.
|
||||
|
||||
## System Components
|
||||
|
||||
1. Sequential Handoff Documents
|
||||
- Capture daily development progress
|
||||
- Document specific work completed
|
||||
- Flag work-in-progress items
|
||||
- Note discoveries and solutions
|
||||
|
||||
2. Milestone Documents
|
||||
- Consolidate multiple handoffs
|
||||
- Summarize completed project phases
|
||||
- Document lessons learned
|
||||
- Store reusable patterns
|
||||
|
||||
## Usage Guidelines
|
||||
|
||||
### When to Create Handoffs
|
||||
- After completing significant project segments
|
||||
- When context becomes ~30% irrelevant
|
||||
- After 10+ conversation exchanges
|
||||
- During extended debugging sessions
|
||||
|
||||
### When to Create Milestones
|
||||
- After major feature completion
|
||||
- When 3-5 handoffs accumulate
|
||||
- At stable/deployable states
|
||||
- After solving critical problems
|
||||
|
||||
## Integration with Memory Bank
|
||||
|
||||
The Handoffs System complements our Memory Bank by:
|
||||
1. Preserving chronological development history
|
||||
2. Maintaining detailed context without loss
|
||||
3. Enabling selective context loading
|
||||
4. Providing clear project timeline
|
||||
5. Facilitating clean context switches
|
||||
29
handoffs/0-instructions/H-handoff-prompt.md
Normal file
29
handoffs/0-instructions/H-handoff-prompt.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Handoff Document Processing Instructions
|
||||
|
||||
Please read through all handoff documents chronologically. After reading, provide a summary that includes:
|
||||
|
||||
1. Current Project State
|
||||
- Implemented features
|
||||
- Work in progress
|
||||
- Known issues
|
||||
- Current priorities
|
||||
|
||||
2. Key Technical Insights
|
||||
- Architectural decisions
|
||||
- Implementation patterns
|
||||
- Problem solutions
|
||||
- Performance considerations
|
||||
|
||||
3. Development Context
|
||||
- Current phase objectives
|
||||
- Dependencies and requirements
|
||||
- Integration points
|
||||
- Testing considerations
|
||||
|
||||
4. Next Steps
|
||||
- Immediate tasks
|
||||
- Upcoming milestones
|
||||
- Required preparations
|
||||
- Potential challenges
|
||||
|
||||
After processing, respond with "HANDOFF PROCESSED" followed by your summary to confirm you've integrated the context.
|
||||
29
handoffs/0-instructions/M-milestone-prompt.md
Normal file
29
handoffs/0-instructions/M-milestone-prompt.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Milestone Document Processing Instructions
|
||||
|
||||
Please process all milestone summary documents (0-prefixed files in milestone directories) to build comprehensive project context. After reading, provide a high-level overview that includes:
|
||||
|
||||
1. Project Evolution
|
||||
- Completed project phases
|
||||
- Major features implemented
|
||||
- Architectural changes
|
||||
- Technical debt addressed
|
||||
|
||||
2. System Architecture
|
||||
- Core components
|
||||
- Integration points
|
||||
- Data flows
|
||||
- Performance characteristics
|
||||
|
||||
3. Lessons Learned
|
||||
- Technical insights
|
||||
- Implementation patterns
|
||||
- Avoided pitfalls
|
||||
- Performance optimizations
|
||||
|
||||
4. Project Health
|
||||
- Code quality metrics
|
||||
- Test coverage
|
||||
- Documentation status
|
||||
- Technical debt status
|
||||
|
||||
After processing, respond with "MILESTONE CONTEXT INTEGRATED" followed by your summary to confirm you've absorbed the project context.
|
||||
Reference in New Issue
Block a user