「注释与文档字符串」是开发者的高频任务。它的输入通常是源码文件，期望得到的是补充后的代码。这类有固定流程、又需要一点判断力的工作，很适合封装成智能体 Skill。

背景（虚构）

Mia是一名开发者，每周都要做几次注释与文档字符串。过去靠复制粘贴提示词，结果不稳定。这次团队把它做成了技能，下面记录一次完整运行。

1. 发出请求

Mia在代码仓库与终端中输入：

这是今天的源码文件，按团队的注释与文档字符串流程处理一下。

2. 技能被触发

智能体根据技能描述判断任务匹配，加载「注释与文档字符串」的完整指令。它不需要外部工具，直接按指令处理。

3. 找出无文档的公共接口

“找出无文档的公共接口”是最容易出错的环节，技能里专门写了要求，所以智能体给出了清楚的结果与理由。

4. 根据实现写说明

“根据实现写说明”是最容易出错的环节，技能里专门写了要求，所以智能体给出了清楚的结果与理由。

5. 包含参数、返回值与异常

智能体完成“包含参数、返回值与异常”，并在中间结果里注明依据，方便Mia回看。

6. 保持既有风格

智能体完成“保持既有风格”，并在中间结果里注明依据，方便Mia回看。

7. 交付与复核

智能体交付补充后的代码，末尾列出两条需人工确认的内容。Mia对照原始源码文件抽查关键信息，修正一处表述后采用。

复盘：这次做对了什么

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

可以改进的地方

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

准备一份好范例

在技能的参考资料里放一份你认可的补充后的代码范例，往往比多写十条规则更有效。好范例应当：

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

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

每一步要产出什么

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

  1. 找出无文档的公共接口：产出一段简短的中间结果，并注明依据来自源码文件的哪一部分
  2. 根据实现写说明：产出一段简短的中间结果，并注明依据来自源码文件的哪一部分
  3. 包含参数、返回值与异常：产出一段简短的中间结果，并注明依据来自源码文件的哪一部分
  4. 保持既有风格：产出一段简短的中间结果，并注明依据来自源码文件的哪一部分

最后一步之后，再把这些中间结果汇总成补充后的代码。中间结果可以折叠或省略展示，但在技能指令中要求智能体“先完成再汇总”，能明显减少遗漏。

延伸阅读

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