开发者与技术写作者经常要做「SDK 快速开始」这类事:为 SDK 写五分钟快速开始文档。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。

这篇是最短路径:不追求完美,只求在 10 分钟内让「SDK 快速开始」第一次跑通。

准备(2 分钟)

  • 一份真实但已脱敏的SDK 代码
  • 一个支持技能或自定义指令的智能体工具(如 Claude Code、Cursor、GPTs、扣子等任一)
  • 一份你认可的快速开始文档范例(可选,但很有帮助)

第 1 步:写最小指令(3 分钟)

任务:SDK 快速开始
输入:SDK 代码
步骤:
1. 写安装命令
2. 写认证配置
3. 给出最小调用
4. 说明下一步阅读
输出:快速开始文档,末尾列出需人工确认的内容。
信息不足时先提问,不要编造。

第 2 步:放到工具里(2 分钟)

把上面的内容放进所用工具的规则或技能位置:Claude Code 放进 .claude/skills/sdk-quickstart/SKILL.md(前面补上 name 与 description),Cursor 放进 .cursor/rules/,GPTs 放进 Instructions。具体位置见各平台版本的文章。

第 3 步:跑一次(2 分钟)

用一句自然语言发出请求,例如:

这是今天的SDK 代码,按团队的SDK 快速开始流程处理一下。

观察智能体是否按步骤执行,输出结构是否符合预期。

第 4 步:修一处(1 分钟)

找出输出中最不满意的一点,只改对应的那一句指令,再跑一次。不要一次改很多处,否则不知道是哪处起了作用。

跑通之后

  • 用测试用例覆盖边界情况
  • 用检查清单确认上线前事项
  • 风险较低,但输出仍需快速过目再使用

准备一份好范例

在技能的参考资料里放一份你认可的快速开始文档范例,往往比多写十条规则更有效。好范例应当:

  • 来自真实工作,但已去除个人信息和敏感数据
  • 体现团队习惯的结构、措辞和详略程度
  • 包含一处“需人工确认”的标注示范,让智能体学会如何表达不确定
  • 篇幅适中,不要比平时的产出长太多

范例不必多,一到两份即可;太多范例反而会让智能体机械模仿某一份的细节。

每一步要产出什么

把每一步的中间产出写清楚,智能体就不容易跳步,人也方便定位问题:

  1. 写安装命令:产出一段简短的中间结果,并注明依据来自SDK 代码的哪一部分
  2. 写认证配置:产出一段简短的中间结果,并注明依据来自SDK 代码的哪一部分
  3. 给出最小调用:产出一段简短的中间结果,并注明依据来自SDK 代码的哪一部分
  4. 说明下一步阅读:产出一段简短的中间结果,并注明依据来自SDK 代码的哪一部分

最后一步之后,再把这些中间结果汇总成快速开始文档。中间结果可以折叠或省略展示,但在技能指令中要求智能体“先完成再汇总”,能明显减少遗漏。

领域注意事项

「SDK 快速开始」属于技术文档领域,使用者多是开发者与技术写作者,工作环境通常是文档仓库与文档站。这个领域最重要的一条底线是:文中的命令和接口要与当前代码逐一核对。

建议把这条底线原样写进技能的约束部分,而不是指望智能体自己意识到。同时,在团队内部明确:智能体给出的快速开始文档只是初稿或建议,最终由谁签字确认、出了问题由谁负责。

延伸阅读

说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。