如果你在代码仓库与终端里反复做注释与文档字符串，可以考虑把经验沉淀为一个 Skill：写清触发条件、步骤、输出格式和边界，让智能体代劳重复部分，人只负责把关。

一句话说明

「注释与文档字符串」技能让智能体为缺少文档的公共函数补充文档字符串。你提供源码文件，它按固定步骤处理，交付补充后的代码。

项目说明
技能注释与文档字符串（docstring-writer）
作用为缺少文档的公共函数补充文档字符串
输入源码文件
输出补充后的代码
形态纯提示词
风险低
适用人群开发者

它解决什么问题

没有技能时，开发者每次都要重新描述要求，智能体的输出时详时略、格式不一，关键的检查步骤也经常被跳过。把流程写成技能后：

  • 每次都按同样的顺序执行：找出无文档的公共接口→根据实现写说明→包含参数、返回值与异常→保持既有风格
  • 输出结构固定，便于复核和归档
  • 领域规矩（如「改动前确认有测试与版本控制，一次只改一类问题」）写在技能里，不靠临时提醒

适合与不适合

适合：经常处理源码文件、希望结果格式统一、愿意花十分钟把流程写清楚的开发者。

不适合：一次性的临时任务；需要大量现场判断、无法写成步骤的工作；以及没有人复核就要直接对外使用的场景。

可以在哪些平台实现

同一个技能的思路可以落在不同平台上，常见选择有：

怎么开始

建议先用纯提示词版本在日常对话助手里试几次，确认步骤合理；再按SKILL.md 写法封装成技能；最后用测试用例验收。

这个技能纯指令型，不需要额外脚本或外部连接，复制到大多数平台都能用；风险较低，但输出仍需快速过目再使用。

智能体与人的分工

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

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

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

准备一份好范例

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

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

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

延伸阅读

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