开发者经常要做「注释与文档字符串」这类事：为缺少文档的公共函数补充文档字符串。每次都从头写提示词，结果时好时坏；把它做成智能体 Skill，就能让智能体每次按同一套步骤执行，输出结构也更稳定。

这篇是最短路径：不追求完美，只求在 10 分钟内让「注释与文档字符串」第一次跑通。

准备（2 分钟）

  • 一份真实但已脱敏的源码文件
  • 一个支持技能或自定义指令的智能体工具（如 Claude Code、Cursor、GPTs、扣子等任一）
  • 一份你认可的补充后的代码范例（可选，但很有帮助）

第 1 步：写最小指令（3 分钟）

任务：注释与文档字符串
输入：源码文件
步骤：
1. 找出无文档的公共接口
2. 根据实现写说明
3. 包含参数、返回值与异常
4. 保持既有风格
输出：补充后的代码，末尾列出需人工确认的内容。
信息不足时先提问，不要编造。

第 2 步：放到工具里（2 分钟）

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

第 3 步：跑一次（2 分钟）

用一句自然语言发出请求，例如：

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

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

第 4 步：修一处（1 分钟）

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

跑通之后

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

交付物结构示例

建议把补充后的代码固定成下面的结构（示意），方便复核与归档：

## 结论
一句话说明最重要的发现或结果

## 主要内容
- 找出无文档的公共接口：……
- 根据实现写说明：……
- 包含参数、返回值与异常：……
- 保持既有风格：……

## 依据
- 引用输入中的具体位置或数据

## 需人工确认
- ……（没有则写“无”）

结构固定之后，复核的人只要先看“结论”和“需人工确认”两部分，就能快速判断结果能否使用。

平台选择建议

同一个「注释与文档字符串」技能可以落在不同平台上，选择时主要看你在哪里工作、要不要执行代码、要不要接外部系统：

  • Gemini CLI：Gemini CLI 会读取项目中的 GEMINI.md 作为长期上下文。详见Gemini CLI 版
  • Function Calling：Function Calling（工具调用）是主流大模型 API 的通用能力：你用 JSON Schema 描述函数。详见Function Calling 版
  • 扣子（Coze）智能体与工作流：扣子（Coze）是字节跳动推出的智能体开发平台。详见扣子（Coze）智能体与工作流 版

这个技能纯指令型，不需要额外脚本或外部连接，复制到大多数平台都能用，可据此排除不支持相应能力的平台。

智能体与人的分工

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

步骤智能体负责人负责
找出无文档的公共接口按指令完成并给出依据抽查关键处，确认无误
根据实现写说明按指令完成并给出依据抽查关键处，确认无误
包含参数、返回值与异常按指令完成并给出依据抽查关键处，确认无误
保持既有风格按指令完成并给出依据抽查关键处，确认无误
最终交付整理补充后的代码决定是否采用、是否对外

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

延伸阅读

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