mcpField
W
write-a-skill

write-a-skill

github.com/dedalus-erp-pasエージェントワークフロー111 回インストール
リポジトリ

write-a-skill について

foundation-skills リポジトリの規約に沿って skill を作成するための手順を示します。要件整理からファイル構成、文書作成、レビューまでを扱います。

主な機能

  1. 01skill の要件整理
  2. 02名前の選定と確認
  3. 03簡潔な SKILL.md の作成
  4. 04フランス語文書の追加
  5. 05規約とバージョンの確認

活用シーン

  1. 01リポジトリ向け skill の起草
  2. 02必須メタデータと構成の確認
  3. 03対応するフランス語文書の準備

インストール

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

$npx skills add https://github.com/dedalus-erp-pas/foundation-skills --skill write-a-skill

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

詳細

スキルを作成する

リポジトリの規約にすべて従って、foundation-skills リポジトリ用の新しいスキルを作成します。

ワークフロー

ステップ 1：要件を確認する

ユーザーに次のことを尋ねます。

  • スキルの対象となるタスクまたは分野は何ですか？
  • 対応するべき具体的なユースケースは何ですか？
  • どのような条件でスキルを有効にしますか？（キーワード、フレーズ、ファイル形式）
  • 含めるべき参考資料はありますか？
ステップ 2：スキル名を決める
  • 小文字のケバブケースを使用します（例：my-new-skill）
  • 短く、内容が分かる名前にします
  • skills/ 内で名前がすでに使われていないことを確認します
ステップ 3：skills/<name>/SKILL.md を作成する

skills/_TEMPLATE/SKILL.md を元にし、次の必須規約を適用します。

フロントマター（YAML）：

---
name: <skill-name>
description: <what it does>. Use when <triggers>.
version: 1.0.0
---
  • name、description、version は必須で、metadata の下ではなくルートレベルに記述します
  • description は最大 1024 文字です。1 文目には機能を記述します。2 文目は「Use when [triggers].」とします。
  • 新しいスキルの version は 1.0.0 から開始します
  • SKILL.md は英語で記述します

本文の規則：

  • SKILL.md は100 行未満にします。簡潔で、実行可能な指示のみを記述します
  • 段階的開示を利用し、詳細な内容は reference/ ファイルに記述します
  • 具体例を含めます
  • 時間の経過とともに古くなる情報は含めません
  • スキルで外部 CLI ツール（例：gh、glab、jq、playwright）が必要な場合は、各ツールのインストールコマンドを記載した ## Prerequisites セクションを追加します。そのツールが skills/setup/reference/setup.sh でまだ扱われていない場合は、そこに追加し、setup のバージョンを上げます（setup スクリプトは手動で管理されています）。
ステップ 4：必要に応じてリファレンスファイルを作成する

内容が 100 行を超える場合や、異なる分野の内容が含まれる場合は、次の場所に分割します。

skills/<name>/
├── SKILL.md
└── reference/
    ├── detailed-guide.md
    └── examples.md

SKILL.md から参照します：See [detailed guide](reference/detailed-guide.md)

ステップ 5：docs/<name>.md を作成する

対応するドキュメントファイルをフランス語で作成します。次の内容を含めます。

  • タイトル（スキル名）
  • 説明セクション
  • 使用例（ユースケース）
  • 起動条件（トリガー）
  • 動作の仕組み
  • 例（英語とフランス語の両方）
  • バージョン番号

スタイルの参考として、docs/ 内の既存ファイルを確認してください。

ステップ 6：レビューチェックリスト
  • skills/<name>/SKILL.md が存在し、有効なフロントマター（ルートに name、description、version）がある
  • 説明にトリガー（「Use when...」）が含まれている
  • 説明が 1024 文字未満である
  • SKILL.md が 100 行未満である
  • SKILL.md が英語で記述されている
  • docs/<name>.md が存在し、フランス語で記述されている
  • 時間の経過とともに古くなる情報がなく、用語が一貫している
  • 具体例が含まれている
  • リファレンスファイルは 1 階層のみである
  • 外部 CLI ツールが必要な場合、インストールコマンドを含む ## Prerequisites セクションがある
  • setup.sh でまだ扱われていない新しい CLI ツールが必要な場合は、skills/setup/reference/setup.sh に追加し、setup のバージョンを上げる

バージョン管理の規則

既存のスキルを変更する場合は、version フィールドの値を上げます。

  • パッチ（1.0.0 -> 1.0.1）：誤字の修正、表現の改善、軽微な説明の補足
  • マイナー（1.0.0 -> 1.1.0）：新機能、新しいセクション、動作に関する重要な変更
  • メジャー（1.0.0 -> 2.0.0）：互換性を損なう変更（スキル名の変更、機能の削除、ワークフローの再構成）

重要な注意事項

  • すべてのスキルは skills/<name>/SKILL.md に、ドキュメントは docs/<name>.md に置きます（フランス語）
  • エージェントがどのスキルを読み込むか選ぶ際に参照するのは、description フィールドだけです。内容をよく練ってください
  • スクリプトの使用は推奨しません。Markdown の指示を優先してください。スクリプトは、処理が決定的である場合にのみ追加します

コメント

Markdown 対応