mcpField
T
troubleshooting-guide

troubleshooting-guide

github.com/aj-geddesドキュメント373444 回インストール34 週間前に更新
リポジトリ

troubleshooting-guide について

ユーザーやサポートチーム向けに、体系的なトラブルシューティング文書を作成するスキルです。診断手順、例、解決策を整理し、一般的なエラーや設定、パフォーマンスの問題を扱います。

主な機能

  1. 01体系的な問題ガイド
  2. 02段階的な診断手順
  3. 03エラーメッセージとコードの参照
  4. 04期待値と実際の出力例
  5. 05回避策と確認手順

活用シーン

  1. 01認証失敗の対処方法を文書化
  2. 02レート制限やタイムアウトを説明
  3. 03インストール問題の調査を案内
  4. 04パフォーマンス問題の手順を記録

インストール

コマンドをコピーしてターミナルで実行します。

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

インストール後、Claude Code で/troubleshooting-guideを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
issue-authentication-failed.md
issue-connection-timeout.md
issue-invalid-json-response.md
issue-rate-limit-exceeded.md
issue-slow-performance.md
scripts/
validate-api.sh
templates/
api-scaffold.yaml

詳細

トラブルシューティングガイド

目次

概要

ユーザーやサポートチームが一般的な問題をすばやく診断し、解決できるよう、体系的なトラブルシューティングドキュメントを作成します。

利用する場面

  • FAQ ドキュメント
  • よくあるエラーメッセージ
  • デバッグガイド
  • 既知の問題の一覧
  • エラーコードのリファレンス
  • パフォーマンスのトラブルシューティング
  • 設定に関する問題
  • インストールに関する問題

クイックスタート

  • インストールに関する問題
# 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

コメント

Markdown 対応