dbdd9c6676
The new names better reflect the compounding engineering philosophy: each documented solution compounds your team's knowledge. - /codify → /compound (old command shows deprecation notice) - codify-docs → compound-docs skill - Updated all docs, philosophy sections, and references 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
94 lines
3.1 KiB
Markdown
94 lines
3.1 KiB
Markdown
---
|
|
module: [Module name or "CORA" for system-wide]
|
|
date: [YYYY-MM-DD]
|
|
problem_type: [build_error|test_failure|runtime_error|performance_issue|database_issue|security_issue|ui_bug|integration_issue|logic_error]
|
|
component: [rails_model|rails_controller|rails_view|service_object|background_job|database|frontend_stimulus|hotwire_turbo|email_processing|brief_system|assistant|authentication|payments]
|
|
symptoms:
|
|
- [Observable symptom 1 - specific error message or behavior]
|
|
- [Observable symptom 2 - what user actually saw/experienced]
|
|
root_cause: [missing_association|missing_include|missing_index|wrong_api|scope_issue|thread_violation|async_timing|memory_leak|config_error|logic_error|test_isolation|missing_validation|missing_permission]
|
|
rails_version: [7.1.2 - optional]
|
|
resolution_type: [code_fix|migration|config_change|test_fix|dependency_update|environment_setup]
|
|
severity: [critical|high|medium|low]
|
|
tags: [keyword1, keyword2, keyword3]
|
|
---
|
|
|
|
# Troubleshooting: [Clear Problem Title]
|
|
|
|
## Problem
|
|
[1-2 sentence clear description of the issue and what the user experienced]
|
|
|
|
## Environment
|
|
- Module: [Name or "CORA system"]
|
|
- Rails Version: [e.g., 7.1.2]
|
|
- Affected Component: [e.g., "Email Processing model", "Brief System service", "Authentication controller"]
|
|
- Date: [YYYY-MM-DD when this was solved]
|
|
|
|
## Symptoms
|
|
- [Observable symptom 1 - what the user saw/experienced]
|
|
- [Observable symptom 2 - error messages, visual issues, unexpected behavior]
|
|
- [Continue as needed - be specific]
|
|
|
|
## What Didn't Work
|
|
|
|
**Attempted Solution 1:** [Description of what was tried]
|
|
- **Why it failed:** [Technical reason this didn't solve the problem]
|
|
|
|
**Attempted Solution 2:** [Description of second attempt]
|
|
- **Why it failed:** [Technical reason]
|
|
|
|
[Continue for all significant attempts that DIDN'T work]
|
|
|
|
[If nothing else was attempted first, write:]
|
|
**Direct solution:** The problem was identified and fixed on the first attempt.
|
|
|
|
## Solution
|
|
|
|
[The actual fix that worked - provide specific details]
|
|
|
|
**Code changes** (if applicable):
|
|
```ruby
|
|
# Before (broken):
|
|
[Show the problematic code]
|
|
|
|
# After (fixed):
|
|
[Show the corrected code with explanation]
|
|
```
|
|
|
|
**Database migration** (if applicable):
|
|
```ruby
|
|
# Migration change:
|
|
[Show what was changed in the migration]
|
|
```
|
|
|
|
**Commands run** (if applicable):
|
|
```bash
|
|
# Steps taken to fix:
|
|
[Commands or actions]
|
|
```
|
|
|
|
## Why This Works
|
|
|
|
[Technical explanation of:]
|
|
1. What was the ROOT CAUSE of the problem?
|
|
2. Why does the solution address this root cause?
|
|
3. What was the underlying issue (API misuse, configuration error, Rails version issue, etc.)?
|
|
|
|
[Be detailed enough that future developers understand the "why", not just the "what"]
|
|
|
|
## Prevention
|
|
|
|
[How to avoid this problem in future CORA development:]
|
|
- [Specific coding practice, check, or pattern to follow]
|
|
- [What to watch out for]
|
|
- [How to catch this early]
|
|
|
|
## Related Issues
|
|
|
|
[If any similar problems exist in docs/solutions/, link to them:]
|
|
- See also: [another-related-issue.md](../category/another-related-issue.md)
|
|
- Similar to: [related-problem.md](../category/related-problem.md)
|
|
|
|
[If no related issues, write:]
|
|
No related issues documented yet.
|