开发者经常要做「代码讲解」这类事:为新人逐层讲解一个模块:职责、数据流、关键函数。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。

背景(虚构)

老陈是一名开发者,每周都要做几次代码讲解。过去靠复制粘贴提示词,结果不稳定。这次团队把它做成了技能,下面记录一次完整运行。

1. 发出请求

老陈在代码仓库与终端中输入:

帮我做一下代码讲解,材料是附上的模块路径。

2. 技能被触发

智能体根据技能描述判断任务匹配,加载「代码讲解」的完整指令。它不需要外部工具,直接按指令处理。

3. 先给模块一句话职责

“先给模块一句话职责”是最容易出错的环节,技能里专门写了要求,所以智能体给出了清楚的结果与理由。

4. 画出数据流

“画出数据流”是最容易出错的环节,技能里专门写了要求,所以智能体给出了清楚的结果与理由。

5. 逐个讲关键函数

“逐个讲关键函数”是最容易出错的环节,技能里专门写了要求,所以智能体给出了清楚的结果与理由。

6. 列出常见修改入口

智能体完成“列出常见修改入口”,并在中间结果里注明依据,方便老陈回看。

7. 交付与复核

智能体交付分层讲解文档,末尾列出两条需人工确认的内容。老陈对照原始模块路径抽查关键信息,修正一处表述后采用。

复盘:这次做对了什么

  • 步骤写在技能里,没有遗漏
  • 不确定处被标出,而不是被编造
  • 遵守了「改动前确认有测试与版本控制,一次只改一类问题」
  • 风险较低,但输出仍需快速过目再使用

可以改进的地方

老陈发现智能体对团队内部术语理解不一致,于是在技能目录中加了一份术语表(reference.md),并在 SKILL.md 中写明“遇到术语先查表”。更多改法见定制指南。

准备一份好范例

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

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

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

每一步要产出什么

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

  1. 先给模块一句话职责:产出一段简短的中间结果,并注明依据来自模块路径的哪一部分
  2. 画出数据流:产出一段简短的中间结果,并注明依据来自模块路径的哪一部分
  3. 逐个讲关键函数:产出一段简短的中间结果,并注明依据来自模块路径的哪一部分
  4. 列出常见修改入口:产出一段简短的中间结果,并注明依据来自模块路径的哪一部分

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

延伸阅读

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