ACE MCP Server

--- description: Quick documentation approach for Level 1 Quick Bug Fix tasks globs: "**/level1/**", "**/documentation/**" alwaysApply: false --- # QUICK DOCUMENTATION FOR LEVEL 1 TASKS > **TL;DR:** This document outlines a quick documentation approach for Level 1 (Quick Bug Fix) tasks, ensuring that essential information is captured with minimal overhead. ## 🔍 QUICK DOCUMENTATION OVERVIEW ```mermaid graph TD FixComplete["Bug Fix<br>Complete"] --> Document["Document<br>Solution"] Document --> UpdateTasks["Update<br>tasks.md"] UpdateTasks --> MinimalUpdates["Make Minimal<br>Memory Bank Updates"] MinimalUpdates --> CrossReference["Create Simple<br>Cross-References"] CrossReference --> Complete["Documentation<br>Complete"] ``` Level 1 tasks require efficient documentation that captures essential information without unnecessary detail. This approach ensures that critical knowledge is preserved while maintaining speed and efficiency. ## 📋 DOCUMENTATION PRINCIPLES 1. **Conciseness**: Keep documentation brief but complete 2. **Focus**: Document only what's necessary to understand the fix 3. **Context**: Provide sufficient context to understand the issue 4. **Solution**: Clearly describe what was changed and why 5. **Findability**: Ensure the fix can be easily found later ## 📋 QUICK FIX DOCUMENTATION TEMPLATE ```markdown # Quick Fix: [Issue Title] ## Issue [Brief description of the problem - 1-2 sentences] ## Root Cause [Concise description of what caused the issue - 1-2 sentences] ## Solution [Brief description of the fix implemented - 2-3 sentences] ## Files Changed - [File path 1] - [File path 2] ## Verification [How the fix was tested/verified - 1-2 sentences] ## Notes [Any additional information that might be helpful - optional] ``` ## 📋 TASKS.MD UPDATES For Level 1 tasks, update tasks.md with this format: ```markdown ## Completed Bug Fixes - [X] [Level 1] Fixed: [Issue title] (Completed: YYYY-MM-DD) - Issue: [One-line description] - Root Cause: [One-line description] - Solution: [One-line description] - Files: [File paths] ``` For in-progress tasks: ```markdown ## Bug Fixes in Progress - [ ] [Level 1] Fix: [Issue title] (Est: XX mins) - Issue: [One-line description] - Location: [Component/file] ``` ## 📋 MEMORY BANK UPDATES For Level 1 tasks, make these minimal Memory Bank updates: 1. **tasks.md**: - Update with fix details as shown above - Mark task as complete 2. **activeContext.md** (only if relevant): ```markdown ## Recent Fixes - [YYYY-MM-DD] Fixed [issue] in [component/file]. [One-line description of fix] ``` 3. **progress.md** (only if significant): ```markdown ## Bug Fixes - [YYYY-MM-DD] Fixed [issue] in [component/file]. ``` Other Memory Bank files typically do not need updates for Level 1 tasks unless the fix reveals important system information. ## 📋 COMMON BUG CATEGORIES Categorize bugs to improve documentation consistency: 1. **Logic Error**: - Example: "Fixed incorrect conditional logic in user validation" 2. **UI/Display Issue**: - Example: "Fixed misaligned button in mobile view" 3. **Performance Issue**: - Example: "Fixed slow loading of user profile data" 4. **Data Handling Error**: - Example: "Fixed incorrect parsing of date format" 5. **Configuration Issue**: - Example: "Fixed incorrect environment variable setting" ## 📋 QUICK DOCUMENTATION PROCESS Follow these steps for efficient documentation: 1. **Immediately After Fix**: - Document while the fix is fresh in your mind - Focus on what, why, and how - Be specific about changes made 2. **Update Task Tracking**: - Update tasks.md with fix details - Use consistent format for easy reference 3. **Minimal Cross-References**: - Create only essential cross-references - Ensure fix can be found in the future 4. **Check Completeness**: - Verify all essential information is captured - Ensure another developer could understand the fix ## 📋 EXAMPLES: GOOD VS. INSUFFICIENT DOCUMENTATION ### ❌ Insufficient Documentation ```markdown Fixed the login bug. ``` ### ✅ Good Documentation ```markdown # Quick Fix: User Login Failure with Special Characters ## Issue Users with special characters in email addresses (e.g., +, %) couldn't log in. ## Root Cause The email validation regex was incorrectly escaping special characters. ## Solution Updated the email validation regex in AuthValidator.js to properly handle special characters according to RFC 5322. ## Files Changed - src/utils/AuthValidator.js ## Verification Tested login with various special characters in email addresses (test+user@example.com, user%123@example.com). ``` ## 📋 DOCUMENTATION VERIFICATION CHECKLIST ``` ✓ DOCUMENTATION VERIFICATION - Issue clearly described? [YES/NO] - Root cause identified? [YES/NO] - Solution explained? [YES/NO] - Files changed listed? [YES/NO] - Verification method described? [YES/NO] - tasks.md updated? [YES/NO] - Memory Bank minimally updated? [YES/NO] → If all YES: Documentation complete → If any NO: Complete missing information ``` ## 📋 MINIMAL MODE DOCUMENTATION For minimal mode, use this ultra-compact format: ``` ✓ FIX: [Issue title] ✓ CAUSE: [One-line root cause] ✓ SOLUTION: [One-line fix description] ✓ FILES: [File paths] ✓ VERIFIED: [How verified] ``` ## 🔄 DOCUMENTATION INTEGRATION Quick documentation integrates with other systems: ```mermaid graph TD QuickDoc["Quick Fix<br>Documentation"] --> TasksMD["tasks.md<br>Update"] QuickDoc --> FixDetails["Fix Details<br>Documentation"] TasksMD --> Tracking["Task<br>Tracking"] FixDetails --> Knowledge["Knowledge<br>Preservation"] Tracking & Knowledge --> Future["Future<br>Reference"] ``` ## 🚨 DOCUMENTATION EFFICIENCY PRINCIPLE Remember: ``` ┌─────────────────────────────────────────────────────┐ │ Document ONLY what's needed to understand the fix. │ │ Focus on ESSENTIAL information that would help │ │ someone who encounters the same issue in the future.│ └─────────────────────────────────────────────────────┘ ``` This ensures that Level 1 tasks are documented efficiently without unnecessary overhead while preserving critical knowledge.