接口文档编写 Skill 实战演练:从请求到交付的全过程
如果你在文档仓库与文档站里反复做接口文档编写,可以考虑把经验沉淀为一个 Skill:写清触发条件、步骤、输出格式和边界,让智能体代劳重复部分,人只负责把关。
背景(虚构)
小唐是一名开发者,每周都要做几次接口文档编写。过去靠复制粘贴提示词,结果不稳定。这次团队把它做成了技能,下面记录一次完整运行。
1. 发出请求
小唐在文档仓库与文档站中输入:
用接口文档编写技能处理这份服务代码,输出接口文档。
2. 技能被触发
智能体根据技能描述判断任务匹配,加载「接口文档编写」的完整指令。它不需要外部工具,直接按指令处理。
3. 列出路由
智能体完成“列出路由”,并在中间结果里注明依据,方便小唐回看。
4. 整理参数与返回
这一步的产出会作为下一步的输入。智能体在“整理参数与返回”时遇到一处含糊的信息,没有自行猜测,而是标注出来等待确认。
5. 补充错误码
智能体完成“补充错误码”,并在中间结果里注明依据,方便小唐回看。
6. 写调用示例
智能体完成“写调用示例”,并在中间结果里注明依据,方便小唐回看。
7. 交付与复核
智能体交付接口文档,末尾列出两条需人工确认的内容。小唐对照原始服务代码抽查关键信息,修正一处表述后采用。
复盘:这次做对了什么
- 步骤写在技能里,没有遗漏
- 不确定处被标出,而不是被编造
- 遵守了「文中的命令和接口要与当前代码逐一核对」
- 风险较低,但输出仍需快速过目再使用
可以改进的地方
小唐发现智能体对团队内部术语理解不一致,于是在技能目录中加了一份术语表(reference.md),并在 SKILL.md 中写明“遇到术语先查表”。更多改法见定制指南。
常见变体
同一个技能可以按使用场景派生出几个变体:
- 简版:只保留核心步骤(列出路由、写调用示例),适合快速过一遍
- 详版:每一步都写出理由与依据,适合交给他人复核或留档
- 批量版:一次处理多份服务代码,输出汇总表,适合定期集中处理
变体之间共享同一套约束,只在步骤详略和输出格式上有差异。可以在一个技能里用参数区分,也可以拆成几个名称明确的技能。
什么时候用这个技能
- 手头有服务代码,需要在较短时间内得到接口文档
- 同类任务每周出现多次,希望每次处理方式一致
- 结果要交给同事或上级复核,需要统一的结构和清楚的依据
- 新人接手这类工作,需要一个可以照着做的标准流程
反过来,如果只是偶尔做一次,或者任务高度依赖现场判断,直接和文档仓库与文档站里的智能体对话即可,不必专门封装成技能。
延伸阅读
- 接口文档编写 · SKILL.md 写法
- 接口文档编写 · 组合用法
- 接口文档编写 · 故障排查
- 新人上手指南 · 场景实录
- 图表即代码 · 场景实录
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。