Specification
- Skill ID
- aj-geddes/useful-ai-prompts/troubleshooting-guide
- Publisher
- aj-geddes
- Repository
- useful-ai-prompts
- Installs
- 0
- Files
- 8
- Synced
- Sep 23, 2026
How to use it
Open any RiverX project, open the Skills panel in the chat, and search for this identifier. The files are fetched from the source repository at install time.
aj-geddes/useful-ai-prompts/troubleshooting-guideInstalls these files- SKILL.md
- references/issue-authentication-failed.md
- references/issue-connection-timeout.md
- references/issue-invalid-json-response.md
- references/issue-rate-limit-exceeded.md
- references/issue-slow-performance.md
- scripts/validate-api.sh
- templates/api-scaffold.yaml
What this skill tells the agent
Troubleshooting Guide
Table of Contents
- Overview
- When to Use
- Quick Start
- Reference Guides
- Best Practices
Overview
Create structured troubleshooting documentation that helps users and support teams quickly diagnose and resolve common issues.
When to Use
- FAQ documentation
- Common error messages
- Debug guides
- Known issues lists
- Error code reference
- Performance troubleshooting
- Configuration issues
- Installation problems
Quick Start
- Installation problems
# Troubleshooting Guide
## Quick Diagnosis
### Is the Service Working?
Check our [Status Page](https://status.example.com) first.
### Quick Health Checks
1. Check service is running
curl https://api.example.com/health
2. Check your API key
curl -H "Authorization: Bearer YOUR_API_KEY" \ https://api.example.com/api/v1/status
3. Check network connectivity
ping api.example.com
4. Check DNS resolution
nslookup api.example.com
## Reference Guides
Detailed implementations in the `references/` directory:
| Guide | Contents |
|---|---|
| [Issue: "Authentication Failed"](references/issue-authentication-failed.md) | Issue: "Authentication Failed" |
| [Issue: "Rate Limit Exceeded"](references/issue-rate-limit-exceeded.md) | Issue: "Rate Limit Exceeded" |
| [Issue: "Connection Timeout"](references/issue-connection-timeout.md) | Issue: "Connection Timeout" |
| [Issue: "Invalid JSON Response"](references/issue-invalid-json-response.md) | Issue: "Invalid JSON Response" |
| [Issue: "Slow Performance"](references/issue-slow-performance.md) | Issue: "Slow Performance" |
## Best Practices
### ✅ DO
- Start with most common issues
- Include error messages verbatim
- Provide step-by-step diagnostics
- Show expected vs actual output
- Include code examples
- Document error codes
- Add screenshots/videos
- Link to related documentation
- Keep solutions up-to-date
- Include workarounds
- Test all solutions
### ❌ DON'T
- Use vague descriptions
- Skip diagnostic steps
- Forget to show examples
- Assume technical knowledge
- Skip verification steps
- Forget edge casesMore from aj-geddes
Use this skill in a project
Open any RiverX project, search the Skills panel for aj-geddes/useful-ai-prompts/troubleshooting-guide, and install it in one click.