文件结构概览
SKILL.md 是 Markdown 格式的配置文件,通常包含以下核心部分:
触发条件
触发条件告诉 Claude「何时使用这个 Skill」。写法要具体、可识别。
推荐写法
Use when the user asks to:
- Review code and generate a report
- 进行代码审查并生成报告
Use when the user mentions:
- "代码审查"、"code review"、"帮我看看这段代码"
避免的写法
- 过于宽泛:「当用户需要帮助时」——几乎总是触发
- 过于狭窄:「当用户说 exactly 'review'」——难以匹配自然表达
能力说明
简要说明该 Skill 能做什么、不能做什么,帮助 Claude 和用户建立正确预期。
## 能力范围
- 支持 Python、JavaScript、TypeScript 的代码审查
- 输出结构化报告:问题列表、严重程度、修复建议
- 不涉及运行测试或部署,仅做静态分析
执行步骤
步骤是 Skill 的「操作手册」,应清晰、可执行。
## 执行步骤
读取用户提供的代码片段或文件路径
按以下维度检查:
- 逻辑正确性
- 代码风格与规范
- 潜在 Bug 与边界情况
- 性能与可维护性
对每个问题标注:文件、行号、严重程度、建议
输出 Markdown 格式报告,包含摘要与详细列表
示例
示例能显著提升 Claude 的理解准确度。建议包含:
- 输入示例:用户可能怎么说、提供什么
- 输出示例:期望的格式、长度、风格
## 示例
输入
用户:帮我审查这段 Python 代码
[附代码片段]
输出
代码审查报告
摘要
发现 3 个问题:1 个高优先级,2 个建议改进。
详细列表
[高] 第 15 行:未处理除零异常...
[建议] 第 8 行:变量命名可更具描述性...
约束与注意事项
明确边界,避免 Skill 被误用或过度使用。
## 约束
- 单次审查代码量建议不超过 500 行
- 不执行代码,不修改文件,仅输出报告
- 涉及安全审计时,建议配合专业工具
小结
良好的 SKILL.md 应具备:明确的触发条件、清晰的能力说明、可执行的步骤、有代表性的示例,以及必要的约束。遵循这些规范,能显著提升 Skill 的可用性和稳定性。