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

「代码讲解」技能出问题时,先别急着重写。按下面的表格对号入座,大部分问题都能在几分钟内定位。

症状对照表

症状常见原因处理办法
技能完全不触发描述没写触发条件;文件位置或文件名不对;平台未重新加载补写“当用户……时使用”;核对目录;新开会话
不该触发时触发描述过于宽泛缩小描述范围,写明不适用的情况
跳过步骤步骤写成段落,或步骤之间缺少依赖说明改成编号列表,写明每步产出
输出格式每次不同没有给出固定结构给出标题或表头模板,附一份范例
内容有编造没要求缺信息时提问;没要求标注依据加上“不确定标注需人工确认”
脚本或工具调用失败运行环境缺依赖、路径错误、权限不足单独运行脚本或工具排查,把错误原文反馈给智能体
越用越偏对话过长,早期指令被稀释新开会话,或把关键约束放在技能最前面

排查顺序

  1. 确认技能是否被加载(大多数平台会在回复或日志中显示使用了哪些规则或技能)
  2. 用标准样例复现问题
  3. 检查最近一次修改,必要时回退
  4. 一次只改一处,改完重跑测试用例

针对这个技能的特别检查

  • 输入是否真的是模块路径,格式差异会导致后续步骤失败
  • “先给模块一句话职责”这一步是否有足够信息
  • 是否混入了与本技能冲突的其他规则
  • 风险较低,但输出仍需快速过目再使用

什么时候该求助

如果确认是平台本身的问题(例如更新后入口变化、规则不再读取),查阅平台的官方文档与更新说明,比反复改技能更有效。

常见变体

同一个技能可以按使用场景派生出几个变体:

  • 简版:只保留核心步骤(先给模块一句话职责、列出常见修改入口),适合快速过一遍
  • 详版:每一步都写出理由与依据,适合交给他人复核或留档
  • 批量版:一次处理多份模块路径,输出汇总表,适合定期集中处理

变体之间共享同一套约束,只在步骤详略和输出格式上有差异。可以在一个技能里用参数区分,也可以拆成几个名称明确的技能。

什么时候用这个技能

  • 手头有模块路径,需要在较短时间内得到分层讲解文档
  • 同类任务每周出现多次,希望每次处理方式一致
  • 结果要交给同事或上级复核,需要统一的结构和清楚的依据
  • 新人接手这类工作,需要一个可以照着做的标准流程

反过来,如果只是偶尔做一次,或者任务高度依赖现场判断,直接和代码仓库与终端里的智能体对话即可,不必专门封装成技能。

延伸阅读

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