mcpField
U
update-skills-docs

update-skills-docs

github.com/editframe開発1971 回インストール2 週間前に更新
リポジトリ

update-skills-docs について

update-skills-docsは、コード変更をスキルドキュメントと照合して同期するリポジトリのワークフローです。関連コミットの抽出、対象ドキュメントの修正、同期タグの更新を案内します。

主な機能

  1. 01スキル同期地点の特定
  2. 02ドキュメント関連変更の抽出
  3. 03コード差分とスキル文書の照合
  4. 04対象を絞った文書更新
  5. 05同期タグの更新と公開

活用シーン

  1. 01スキル文書の更新状況を確認
  2. 02文書化が必要なAPI変更を特定
  3. 03更新したスキル文書をエージェント用ディレクトリに同期

インストール

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

$npx skills add https://github.com/editframe/skills --skill update-skills-docs

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

詳細

スキルのドキュメントを更新する

読み込み時：以下の分析を直ちに実行します。前置きは不要です。

ステップ 1：同期ポイントを確認する

git rev-parse skills-sync

タグが存在しない場合は、skills/skills/ に最後に変更を加えたコミットにタグを作成します。

BOOTSTRAP=$(git log --oneline -- skills/skills/ | head -1 | awk '{print $1}')
git tag -a skills-sync $BOOTSTRAP -m "skills synced $(date -I)"
git push skills skills-sync

ステップ 2：同期済みか確認する

git log skills-sync..HEAD --oneline

出力がない場合、タグはすでに HEAD にあります。「スキルのドキュメントは最新です。」と報告して終了します。先に進まないでください。

ステップ 3：ドキュメントに関連するコミットを取得する

git log skills-sync..HEAD --name-only --oneline

変更されたファイルを、ドキュメントに関連するパスだけに絞り込みます。それ以外はすべて無視します。

ドキュメントに関連するパスのプレフィックス
パスのプレフィックススキル
elements/packages/api/src/resources/editframe-api
elements/packages/cli/src/commands/editframe-cli
elements/packages/vite-plugin/src/index.tsvite-plugin
elements/packages/elements/src/elements/composition
elements/packages/elements/src/gui/editor-gui
elements/packages/react/src/gui/editor-gui
elements/packages/react/src/hooks/composition
除外パターン（これらのファイルは完全にスキップ）
  • *.browsertest.ts、*.test.ts
  • src/preview/、src/transcoding/、src/canvas/、src/profiling/ 以下のすべてのパス
  • コミットの件名が ^Bump version に一致するもの
  • ロックファイル、スナップショットファイル、フォーマッターのみのコミット（件名が style: または format: で始まるもの）

ステップ 4：差分を読む

関連するコミット内の、条件に一致した各ファイルについて：

git show <hash> -- <file>

特に以下を確認します。

  • 要素に追加された新しい @property または @attribute デコレーター
  • 削除されたプロパティ／属性
  • 変更されたデフォルト値
  • 新しくエクスポートされた関数、フック、型
  • 変更された関数シグネチャまたはイベント詳細の形式
  • vite プラグインの新規または削除された API エンドポイントのパス
  • API ペイロード型の新しいフィールド（リソースファイル内の z.object(...)）

ステップ 5：対応するスキルのドキュメントを読む

変更されたファイルを上の表を使ってスキルに対応付け、skills/skills/<skill>/references/ にある関連するリファレンスファイルを見つけます。Read ツールで読み取ります。

ステップ 6：不一致を特定する

一致したコミットとスキルのドキュメントの各ペアについて、以下を特定します。

  1. ドキュメント内で現在は誤っている情報（古いエンドポイントのパス、削除された属性、変更されたイベントの形式など）
  2. ドキュメントに記載されていない新しい API サーフェス（新しい属性、新しいフィールド、新しいフックなど）
  3. 既存のドキュメントの説明と矛盾する動作の変更

項目が 3 件を超える場合は、変更を実装する前に具体的な変更点を番号付きリストで提示します。1～3 件の場合は、直ちに実装します。

ステップ 7：更新を実装する

スキルのドキュメントファイルを直接編集します。変更は最小限かつ事実に即したものとし、該当する属性、エンドポイント、型、動作の説明だけを更新します。ドキュメントを再構成しないでください。

ステップ 8：タグを進める

すべての更新が完了したら：

git tag -f -a skills-sync HEAD -m "skills synced $(date -I)"
git push skills skills-sync

次に、内部スキルをエージェントディレクトリに同期し、スキルのドキュメントをプッシュします。

npm run skills:sync
./scripts/push-skills

その後、コミットします。

git add .skills/ skills/skills/ .claude/skills/ .cursor/skills/ .opencode/skills/
git commit -m "sync skills docs to HEAD"

ブートストラップに関する注意

skills-sync タグはモノレポにあり、skills リモートにプッシュされます。モノレポには origin リモートがありません。git push origin skills-sync ではなく、git push skills skills-sync を使用してください。

コメント

Markdown 対応