AI故障排除指南：结构化文档模板与最佳实践，快速诊断常见技术问题

troubleshooting-guide by aj-geddes/useful-ai-prompts

156 周安装量

162 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill troubleshooting-guide

技术文档调试提示工程

🇨🇳中文介绍

故障排除指南

概述

创建结构化的故障排除文档，帮助用户和支持团队快速诊断并解决常见问题。

使用场景

常见问题解答文档
常见错误信息
调试指南
已知问题列表
错误代码参考
性能故障排除
配置问题
安装问题

快速开始

安装问题

故障排除指南

快速诊断

服务是否正常工作？

首先检查我们的状态页面。

快速健康检查

# 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

参考指南

references/ 目录下的详细实现：

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

指南	内容
问题："认证失败"	Issue: "Authentication Failed"
问题："超出速率限制"	Issue: "Rate Limit Exceeded"
问题："连接超时"	Issue: "Connection Timeout"
问题："无效的 JSON 响应"	Issue: "Invalid JSON Response"
问题："性能缓慢"	Issue: "Slow Performance"

🇺🇸English

Troubleshooting Guide

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 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"	Issue: "Authentication Failed"
Issue: "Rate Limit Exceeded"	Issue: "Rate Limit Exceeded"
Issue: "Connection Timeout"	Issue: "Connection Timeout"
Issue: "Invalid JSON Response"	Issue: "Invalid JSON Response"
Issue: "Slow Performance"	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

Weekly Installs

114

Repository

aj-geddes/usefu…-prompts

GitHub Stars

126

First Seen

Jan 21, 2026

Security Audits

Gen Agent Trust HubPass SocketPass SnykPass

Installed on

opencode93

gemini-cli92

codex89

cursor86

claude-code85

github-copilot77

AI故障排除指南：结构化文档模板与最佳实践，快速诊断常见技术问题

🇨🇳中文介绍

故障排除指南

目录

概述

使用场景

快速开始

故障排除指南

快速诊断

服务是否正常工作？

快速健康检查

参考指南

相关 Skills

最佳实践

✅ 建议做法

❌ 避免做法

🇺🇸English

Troubleshooting Guide

Table of Contents

Overview

When to Use

Quick Start

Troubleshooting Guide

Quick Diagnosis

Is the Service Working?

Quick Health Checks

Reference Guides

Best Practices

✅ DO

❌ DON'T

最新 Skills