mcpField
S
sdk-onboarding-integration-review

sdk-onboarding-integration-review

github.com/sylphxai開発142 回インストール今日更新
リポジトリ

sdk-onboarding-integration-review について

SDK のオンボーディングや連携フローを設計するチーム向けのスキルです。ドキュメント、認証、サンプル、エラー、バージョン管理、テレメトリーの課題を、担当者や指標、復旧策を含む計画にまとめます。

主な機能

  1. 01初回 API 呼び出し成功までの経路整理
  2. 02ドキュメントとサンプルの要件定義
  3. 03認証、サンドボックス、エラー対応の計画
  4. 04連携ジャーニーと決定表の作成
  5. 05指標、担当者、復旧手順の追加

活用シーン

  1. 01SDK クイックスタートのレビュー
  2. 02サンドボックスと認証情報の設定計画
  3. 03連携エラーメッセージの改善
  4. 04バージョン変更と移行ガイドの準備

インストール

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

$npx skills add https://github.com/sylphxai/skills --skill sdk-onboarding-integration-review

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

同梱ファイルagents/openai.yamlreferences/sdk-onboarding-integration-patterns.md

詳細

SDK オンボーディング・インテグレーションレビュー

このスキルを使って、SDK のオンボーディング、インテグレーションの成功、クイックスタート、認証キー、サンプル、エラー、バージョニング、開発者テレメトリに関する質問を、担当者、ゲート、指標、復旧方法を含む具体的な成果物に変換します。

ワークフロー

  1. 対象となる開発者、インテグレーションの目的、サポート対象言語、認証モデル、最初の成功イベント、サンドボックスの要件、よくある失敗ポイントを特定します。
  2. references/sdk-onboarding-integration-patterns.md を読みます。
  3. 発見から最初の API 呼び出し／Webhook／イベントの成功、さらに本番運用の準備までの経路をマッピングします。
  4. ドキュメントの情報アーキテクチャ、サンプル、環境設定、キー、モック／サンドボックスデータ、エラー分類、オブザーバビリティ、移行／バージョニング、サポートへの引き継ぎを定義します。
  5. インテグレーションのジャーニー、状態遷移図、意思決定表、イベントスキーマ、クイックスタートのチェックリスト、障害モードへの対処方法を作成します。

使用しない場合

  • このスキル固有の成果物要件がなくてもベースモデルで対応できる一般的なアドバイスには使用しないでください。

ガードレール

  • 初回成功までの時間ではなく、ドキュメントの量を最適化しないでください。
  • 安全なクイックスタートの完了に、本番用の認証情報や実際の資金／データを必要としないでください。
  • リクエスト ID、再試行の可否、設定ミスの原因を隠す SDK エラーをリリースしないでください。
  • バージョニング、変更履歴、移行ガイド、互換性テストなしに既存のインテグレーションを破壊しないでください。

出力形式

Developer context:
Integration job / language / first success event:

SDK onboarding plan:
| Area | Decision | Evidence | Risk | Owner |
| --- | --- | --- | --- | --- |

Docs, samples, and errors:
- <item> -> <policy, metric, edge case, support note>

Versioning and migration policy:
- <trigger> -> <action, communication, owner>

コメント

Markdown 対応