如果你在文档仓库与文档站里反复做接口文档编写,可以考虑把经验沉淀为一个 Skill:写清触发条件、步骤、输出格式和边界,让智能体代劳重复部分,人只负责把关。

单个技能解决一个环节,把几个技能串起来,才能覆盖一整段工作。本文示范「接口文档编写」与三个相关技能的组合。

组合方案

顺序技能作用交给下一步的东西
1更新日志生成根据提交记录生成面向用户的更新日志更新日志
2接口文档编写根据路由代码生成接口文档接口文档
3版本发布公告把版本更新写成对外发布公告发布公告
4合并请求描述为合并请求生成描述、测试说明与截图提示PR 描述

交接格式是关键

技能之间靠“上一步的输出就是下一步的输入”衔接。建议约定:

  • 每个技能的输出都带固定标题,便于下一个技能定位内容
  • 不确定项统一放在“需人工确认”小节,后续技能不得把它当作确定事实
  • 「接口文档编写」接收的是服务代码,如果上一步给的格式不同,先做一次转换

怎么编排

有三种常见方式:

  1. 人工串联:每一步结束后由人确认,再触发下一个技能,最稳妥
  2. 编排指令:写一个总技能,列出调用顺序与交接要求,由智能体依次执行
  3. 工作流平台:在 Dify、扣子、n8n 等平台中把每个技能做成节点,用条件分支处理异常

编排指令示例(示意)

# 组合流程:更新日志生成 → 接口文档编写 → 版本发布公告 → 合并请求描述
1. 调用 changelog-writer,保存输出为 step1
2. 以 step1 为输入调用 api-doc-writer,保存为 step2
3. 以 step2 为输入调用 release-announcement
4. 调用 pr-description 做收尾
- 任一步出现“需人工确认”时暂停,等待用户回复后再继续

注意事项

  • 链条越长,错误越容易被放大,关键节点要有人看
  • 风险较低,但输出仍需快速过目再使用
  • 每个技能单独测试通过后再组合

相关技能

智能体与人的分工

技能不是把工作全部交出去,而是把重复、机械的部分交给智能体,人把住判断和责任:

步骤智能体负责人负责
列出路由按指令完成并给出依据抽查关键处,确认无误
整理参数与返回按指令完成并给出依据抽查关键处,确认无误
补充错误码按指令完成并给出依据抽查关键处,确认无误
写调用示例按指令完成并给出依据抽查关键处,确认无误
最终交付整理接口文档决定是否采用、是否对外

风险较低,但输出仍需快速过目再使用。

准备一份好范例

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

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

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

延伸阅读

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