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. 01评审 SDK 快速入门
  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