troubleshooting-guide
Create comprehensive troubleshooting guides, FAQ documents, known issues lists, and debug guides. Use when documenting common problems, error messages, or debugging procedures.
How do I install this agent skill?
npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill troubleshooting-guideIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The troubleshooting guide skill provides templates for diagnosing API and network issues. It processes external diagnostic data like logs and error messages and uses environment variables for API keys in shell commands, which presents surfaces for indirect prompt injection and potential exposure of sensitive information in logs.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerpass
1/1 file flagged
- ZeroLeakspass
Score: 93/100 · 2 sections analyzed
What does this agent skill do?
Troubleshooting Guide
Table of Contents
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
```bash
# 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 cases
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/aj-geddes/useful-ai-prompts/troubleshooting-guide">View troubleshooting-guide on skillZs</a>