example-skill について
ドキュメント化されたスキルの構成例を示すテンプレートで、スキルの書き方や自動化スクリプトのひな型作成を学ぶ人向けです。セットアップ、設定、診断、リファレンス、サンプルスクリプトのプレースホルダーを含みます。
主な機能
- 01スキル文書の構成例
- 02自動・手動セットアップ手順
- 03設定とトラブルシューティングの節
- 04スクリプトとリファレンスの説明
活用シーン
- 01スキル文書の構成方法を学ぶ
- 02自動化スクリプトのテンプレートを作る
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ aws-samples/ sample-well-architected-skills-and-steering --skill example-skillインストール後、Claude Code で/example-skillを入力して読み込まれたか確認します。
同梱ファイルreferences/additional-info.mdscripts/example-script.sh
詳細
スキルテンプレートの例
概要
これは、適切にドキュメント化されたスキルの構造と構成要素を示すテンプレートスキルです。この概要を、スキルの機能と解決する問題を明確に説明する内容に置き換えてください。
使用方法
次の場合にこのスキルを使用してください:
- [具体的なタスク、または解決すべき問題]を達成する必要がある
- [よくあるシナリオ 1]に遭遇する
- [よくあるシナリオ 2]を実行したい
- 「[エラーメッセージの例]」のようなエラーが表示される
手順
基本設定
自動設定: 付属のスクリプトを使用して、設定を簡単に行います:
./scripts/example-script.sh
手動での手順:
# Step 1: Install required tools
echo "Installing dependencies..."
# Step 2: Configure settings
echo "Configuring application..."
# Step 3: Verify installation
echo "Verifying setup..."
前提条件
スキルを開始する前に実行する事前検証ロジックがあれば、このセクションを置き換えてください。
設定
詳細については、references/additional-info.mdを参照してください
主な設定
メインの設定手順に置き換えてください。
代替設定
該当する場合は、別の設定方法に置き換えてください。
機能
設定すると、このスキルでは次のことができます:
- 機能 1:実行内容の説明
- 機能 2:実行内容の説明
- 機能 3:実行内容の説明
トラブルシューティング
自動診断: 診断スクリプトを実行して、よくある問題を確認します:
./scripts/example-script.sh
手動でのトラブルシューティング:
よくある問題 1
ログを確認: 適切なログの場所に置き換えてください
一般的な解決策:
「エラーメッセージの例」
# Solution command
echo "Fix applied"
「別のエラーメッセージ」
- 解決するための手順 1
- 解決するための手順 2
よくある問題 2
「エラーシナリオの例」
- トラブルシューティングの手順 1
- トラブルシューティングの手順 2
関連ファイル
scripts/example-script.sh
次の内容を示すサンプルスクリプトです:
- 基本的なシェルスクリプトの構造
- エラー処理
- ユーザーへのフィードバック
- 簡単な操作
使用方法: ./scripts/example-script.sh
references/additional-info.md
次の内容を含むテンプレートの参考ファイルです:
- 詳細な背景情報
- 詳細な例とシナリオ
- 高度な使用パターン
- 参考表と付録
使用するタイミング: 追加の背景情報や詳細な例が必要な場合に参照してください
決定論的なスクリプト
example-script.sh
基本的な自動化パターンを示すシンプルなサンプルスクリプトです。
使用するタイミング:
- スクリプトの構造を学ぶとき
- 新しい自動化スクリプトのテンプレートとして
- スクリプトの実行をテストするとき
実行内容:
- Hello World メッセージを出力します
- 基本的なシェルスクリプトの作成方法を示します
- エラー処理のパターンを示します
例:
./scripts/example-script.sh
基本概念
概念 1:スキルの領域に関連する重要な概念に置き換えてください。
概念 2:ユーザーが理解すべき、もう 1 つの重要な概念に置き換えてください。
概念 3:実装の詳細やアーキテクチャの概念に置き換えてください。
クイックリファレンス
| タスク | コマンド |
|---|---|
| サンプルスクリプトを実行 | ./scripts/example-script.sh |
| 設定を確認 | echo "Add your check command" |
| ドキュメントを表示 | references/additional-info.mdを参照 |
よくあるパターン
基本的な使用方法:
# Use example script
./scripts/example-script.sh
# Follow up with manual steps if needed
echo "Manual configuration step"
高度な使用方法:
# Check prerequisites
echo "Checking requirements..."
# Run advanced configuration
echo "Advanced setup..."
よくある間違い
間違い 1:ユーザーがよく犯す間違いの説明。 修正方法:この間違いを解決する方法。
間違い 2:別のよくある間違い。 修正方法:この間違いを解決する手順。