Updated readme with recommendations
This commit is contained in:
@@ -80,39 +80,34 @@ This structured approach ensures Claude performs methodical groundwork before ex
|
|||||||
|
|
||||||
## Usage Examples
|
## Usage Examples
|
||||||
|
|
||||||
**Basic Error Debugging:**
|
**Error Debugging:**
|
||||||
```
|
```
|
||||||
"Debug this TypeError: 'NoneType' object has no attribute 'split' in my parser.py"
|
Debug this TypeError: 'NoneType' object has no attribute 'split' in my parser.py
|
||||||
```
|
```
|
||||||
|
|
||||||
**With Stack Trace:**
|
**With Stack Trace:**
|
||||||
```
|
```
|
||||||
"Use gemini to debug why my API returns 500 errors with this stack trace: [paste full traceback]"
|
Use gemini to debug why my API returns 500 errors with this stack trace: [paste full traceback]
|
||||||
```
|
```
|
||||||
|
|
||||||
**With File Context:**
|
**With File Context:**
|
||||||
```
|
```
|
||||||
"Debug the authentication failure in auth.py and user_model.py with o3"
|
Debug without using external model, the authentication failure in auth.py and user_model.py
|
||||||
```
|
```
|
||||||
|
|
||||||
**Performance Debugging:**
|
**Performance Debugging:**
|
||||||
```
|
```
|
||||||
"Use pro to debug why my application is consuming excessive memory during bulk operations"
|
Debug without using external model to find out why the app is consuming excessive memory during bulk edit operations
|
||||||
```
|
|
||||||
|
|
||||||
**With Visual Context:**
|
|
||||||
```
|
|
||||||
"Debug this crash using the error screenshot and the related crash_report.log"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**Runtime Environment Issues:**
|
**Runtime Environment Issues:**
|
||||||
```
|
```
|
||||||
"Debug deployment issues with server startup failures, here's the runtime info: [environment details]"
|
Debug deployment issues with server startup failures, here's the runtime info: [environment details]
|
||||||
```
|
```
|
||||||
|
|
||||||
## Investigation Methodology
|
## Investigation Methodology
|
||||||
|
|
||||||
The debug tool enforces a structured investigation process:
|
The debug tool enforces a thorough, structured investigation process:
|
||||||
|
|
||||||
**Step-by-Step Investigation (Claude-Led):**
|
**Step-by-Step Investigation (Claude-Led):**
|
||||||
1. **Initial Problem Description:** Claude describes the issue and begins thinking about possible causes, side-effects, and contributing factors
|
1. **Initial Problem Description:** Claude describes the issue and begins thinking about possible causes, side-effects, and contributing factors
|
||||||
@@ -122,7 +117,7 @@ The debug tool enforces a structured investigation process:
|
|||||||
5. **Iterative Refinement:** Claude can backtrack and revise previous steps as understanding evolves
|
5. **Iterative Refinement:** Claude can backtrack and revise previous steps as understanding evolves
|
||||||
6. **Investigation Completion:** Claude signals when sufficient evidence has been gathered
|
6. **Investigation Completion:** Claude signals when sufficient evidence has been gathered
|
||||||
|
|
||||||
**Expert Analysis Phase (AI Model):**
|
**Expert Analysis Phase (Another AI Model When Used):**
|
||||||
Once investigation is complete, the selected AI model performs:
|
Once investigation is complete, the selected AI model performs:
|
||||||
- **Root Cause Analysis:** Deep analysis of all investigation findings and evidence
|
- **Root Cause Analysis:** Deep analysis of all investigation findings and evidence
|
||||||
- **Solution Recommendations:** Specific fixes with implementation guidance
|
- **Solution Recommendations:** Specific fixes with implementation guidance
|
||||||
|
|||||||
Reference in New Issue
Block a user