このトピックでは、`SKILL.md` ファイルのフォーマット仕様とスキルディレクトリの構造について説明します。
スキルディレクトリ構造
完全なスキルは 1 つのフォルダに格納されます。フォルダ名はスキル識別子として機能します。ディレクトリ構造は次のとおりです。
├── SKILL.md # 必須:コア命令ファイル
├── references/ # オプション:参考ドキュメントディレクトリ
├── assets/ # オプション:テンプレートとリソースのディレクトリ
└── scripts/ # オプション:実行可能スクリプトのディレクトリディレクトリの説明
ディレクトリ | 必須 | 説明 | 一般的なユースケース |
SKILL.md | はい | スキルのコア定義ファイル。メタデータと実行命令が含まれます。 | スキル名、説明、実行ステップ、出力フォーマットを定義します。 |
references/ | いいえ | 参考ドキュメントと仕様を格納します。 | コーディング規約、ベストプラクティス、チェックリスト、API リファレンスなど。 |
assets/ | いいえ | テンプレートファイルと静的リソースを格納します。 | 出力テンプレート、コードテンプレート、構成テンプレート、サンプルファイルなど。 |
scripts/ | いいえ | 実行可能スクリプトを格納します (現在サポートされていません)。 |
references ディレクトリ
references/ ディレクトリには、スキルの実行時に必要なドキュメントが格納されます。デジタル・エンプロイーは、SKILL.md ファイルで指定された通りに、これらのドキュメントを必要に応じて読み込みます。
ユースケース:
リリースチェックリストと変更管理ガイドライン。
インシデント対応のためのランブック。
アラート処理プロシージャとエスカレーションパス。
CI/CD パイプライン構成ガイド。
サービス依存関係と SLO 定義。
構造例:
references/
├── release-checklist.md # リリースチェックリスト
├── rollback-runbook.md # ロールバックランブック
└── alert-handling.md # アラート処理ガイドライン`SKILL.md` での参照:
## 実行ステップ
1. `references/release-checklist.md` を使用して、リリース前チェックを実行します。
2. `references/rollback-runbook.md` を使用して、ロールバックが必要かどうかを評価します。assets ディレクトリ
assets/ ディレクトリには、テンプレートファイルと静的リソースが格納されています。 これらのリソースは、出力フォーマットのリファレンス、またはコンテンツを生成するためのベーステンプレートとして使用できます。
ユースケース:
事後分析レポートのテンプレート。
リリース通知と変更レコードのテンプレート。
CI/CD パイプライン構成テンプレート。
監視およびアラートルールのテンプレート。
構造例:
assets/
├── incident-report.md # 事後分析レポートテンプレート
├── deploy-summary.md # リリース通知テンプレート
└── pipeline-config.yaml # CI/CD パイプライン構成テンプレート`SKILL.md` での参照:
## 出力フォーマット
`assets/incident-report.md` で定義されたフォーマットで事後分析レポートを出力します。
## リリース通知
リリース完了通知のコンテンツ構造として `assets/deploy-summary.md` を使用します。scripts ディレクトリ
scripts/ ディレクトリには、実行可能なスクリプトが格納されています。デジタル・エンプロイーは、これらのスクリプトを呼び出して、コード検査、データ処理、およびファイル変換などのタスクを自動化できます。
注:現在、デジタル従業員スキルではスクリプト実行はサポートされていません。このディレクトリは将来の使用のために予約されています。
ユースケース:
サービスヘルスチェックのスクリプト。
ログ収集と分析のスクリプト。
CI/CD パイプラインのトリガーとステータスクエリのスクリプト。
インフラストラクチャ検査のスクリプト。
構造例:
scripts/
├── health-check.sh # サービスヘルスチェック スクリプト
├── log-analyzer.py # ログ分析スクリプト
└── pipeline-trigger.sh # CI/CD パイプライン トリガースクリプトスクリプト作成のガイドライン:
スクリプトはコマンドライン引数を受け入れる必要があります。
出力は、デジタル従業員が簡単に解析できるように、構造化テキストである必要があります。
エラー処理と使用方法の説明を含めてください。
最初の行にシェバンを追加します(例:
#!/bin/bashまたは#!/usr/bin/env python3)。
SKILL.md ファイルの構造
`SKILL.md` ファイルは 2 つの部分で構成されます:
YAML フロントマター:ファイルの先頭にあるメタデータ構成。
Markdown 本文:スキルの具体的な命令と説明。
メタデータフィールド
フィールド | 必須 | 説明 | 制約 |
name | はい | 一意のスキル識別子 | 小文字、数字、ハイフンのみ。最大 64 文字。 |
description | はい | 機能説明とトリガーシナリオ | 最大 512 文字。 |
完全な例
---
name: release-readiness-checker
description: サービスリリースの前に準備状況のチェックを実行します。ヘルスステータス、トラフィック、依存サービスの準備状況を評価します。
---
# リリース準備チェッカー
## 概要
サービスリリースの前に、主要なメトリックを自動的にチェックして、リリースの基準を満たしていることを確認します。リリース準備レポートを出力して、リリースリスクを低減します。
## 実行ステップ
1. 対象サービスのエラー率、レイテンシー、QPS の現在のベースラインをクエリします。
2. 依存サービス (データベース、キャッシュ、ダウンストリーム API) のヘルスステータスをチェックします。
3. 最新の CI/CD パイプラインのビルドが成功したこと (単体テストと統合テスト) を確認します。
4. 現在のトラフィックレベルを評価して、ピーク営業時間内であるかどうかを判断します。
5. フラグが立てられたリスク項目を含むリリース準備レポートを出力します。
## 出力フォーマット
以下を含む構造化されたリリース準備レポートを出力します:
- 全体的な準備状況の結論 (✅ リリース可能 / ⚠️ 注意して続行 / ❌ 推奨しません)
- 各チェック項目のステータスと詳細
- リスク項目の説明と推奨アクション
## 注意事項
- メトリックが取得できない場合は、「データ欠落」としてマークしてスキップします。他のチェックは続行されます。
- ピーク営業時間 (平日 10:00–12:00 および 14:00–18:00) 中のリリースには、追加の確認が必要です。ベストプラクティス
説明は正確に記述する:
descriptionフィールドは、デジタル・エンプロイーがスキルを有効化するかどうかを判断する際に役立ちます。明確なトリガー キーワードを含めてください。明確なステップ:番号付きリストを使用して実行ステップを記述します。これにより、デジタル従業員が理解し、従いやすくなります。
例の提供:期待される動作を明確にするために、具体的な入力例と出力例を含めてください。
出力フォーマットの定義:一貫した結果を保証するために、必要な出力フォーマットを指定してください。