TRAE 绿皮书
官方功能教程 / 使用技巧|让 AI 功能更好用

技巧|如何写好一个 Skill

提示

之前带大家了解了 Skill 的原理和应用,本文继续带领大家从“能用”到“会用”,如何写好一个 Skill 至关重要。

本文为 Skill 设计与开发的一站式最佳实践指南,可助力你:

什么是 Skill ?

定义

一个 Skill 是一份清晰、严谨、可执行的指令文档,用于明确告诉模型——在什么条件下(When),按照哪些步骤(How),产出什么结果(What)。

常见认知误区

在编写 Skill 之前,建议先了解以下几个常见误区。这些问题往往会直接导致 Skill 难以被正确触发,或在执行过程中表现不稳定。

Skill 的设计标准与原则

以下标准是构建高命中率、高稳定性 Skill 的基础。可将其作为设计与评审 Skill 时的检查清单。

精准的元数据内容

Skill 的元数据(name 和 description)是模型发现和识别 Skill 的入口,其设计直接影响触发准确率。

元数据字段

规范

示例

name

用于识别 Skill。应遵循以下规范:

  • 简洁、唯一的标识符
  • 使用小写字母、数字和连字符(-
  • 推荐使用动名词(Gerund form)
  • 长度不超过 64 个字符
  • 好的示例:
    • running-tests
    • deploy-microservice
    • database-migration
  • 坏的示例:
    • test-helper(语义模糊)
    • data-skill-v2(冗余且含版本信息)
    • deployService(命名不规范)

description

用于描述 Skill 的能力及适用场景。应遵循以下规范:

  • 使用第三人称,从模型视角描述
  • 包含核心功能与触发时机的关键词
  • 长度不超过 1024 个字符
  • 好的示例

    “Review code for quality, correctness, and maintainability. Use when evaluating pull requests, refactoring existing code, or when the user asks for feedback on implementation details, edge cases, or potential bugs”。

  • 坏的示例:
    • “I can help you review code”(第一人称)
    • “Helps with code review”(缺乏触发时机)

指导方式的自由度分级

根据任务复杂度与容错要求,合理控制对模型的约束强度。

自由度等级

适用场景

指导方式

示例

  • 存在多种有效方法
  • 模型的决策依赖上下文

提供启发式策略(给原则)

代码审查:先看安全性,再看可读性

YAML
---
name: code-review
description: 当用户需要对代码进行审核时,基于代码实现与通用开发规范,分析逻辑正确性、可维护性和潜在风险,并给出改进建议。

  • 存在首选模式
  • 允许一定程度的变通
  • 行为受配置参数影响

提供模板/伪代码(给框架)

报告生成:按"摘要-分析-建议"结构

YAML
---
name: report-generator
description: 当用户需要生成报告时,按照“摘要-分析-建议”的结构整理信息,输出清晰、条理化的报告内容
template: |
  摘要:
  - 简要概述核心信息或问题点

  分析:
  - 详细分析背景、原因、数据或逻辑
  - 列出关键发现和关联因素

  建议:
  - 针对分析结果提出具体可行的改进方案或行动建议
  - 如有优先级或风险提示,可附上

  • 操作脆弱且易错。
  • 一致性至关重要。
  • 必须遵循特定序列。

提供可执行的脚本(给代码)

数据库迁移:按固定顺序执行脚本

YAML
---
name: database-migration
description: 当用户需要执行数据库迁移时,按预定义顺序执行 SQL 或迁移脚本,确保数据和结构一致性
template: |
  迁移计划:
  1. 准备阶段:
     - 备份现有数据库
     - 验证目标环境配置
  2. 执行阶段(按顺序执行脚本):
     - 脚本 001_create_users_table.sql:创建用户表
     - 脚本 002_add_email_index.sql:为用户表添加邮箱索引
     - 脚本 003_update_roles.sql:更新角色字段数据
  3. 验证阶段:
     - 检查数据完整性
     - 验证关键功能是否正常
  4. 回滚(可选):
     - 如出现异常,按回滚方案恢复数据库

五个核心标准

标准

描述

示例

边界明确

模型最容易犯的错误不是“不知道怎么做”,而是“不知道什么时候该做”。Skill 的触发必须有明确的正向条件和负向条件,否则命中率会很低。

边界不清晰:

Use this skill when:

  • 用户想让流水线跑一下测试。
  • PR 有代码改动或文档改动。

Do NOT use this skill when:

  • 用户只是在看 PR。

边界清晰:

Use this skill when:

  • 用户意图是触发 CI/CD 流水线执行单元测试。
  • PR 状态为“待合并”,需要执行自动检查或 lint 校验。

Do NOT use this skill when:

  • 用户只是查看测试报告或 CI/CD 状态。
  • PR 内容没有代码改动,仅修改文档或注释。

输入输出结构化

与模型沟通时,需要定义双方都能理解的“共同语言”,避免模糊描述。推荐用类似函数签名的方式明确 Input 和 Output,保证可解析性。

模糊描述:

“帮用户跑测试并返回结果。”


结构化定义:

YAML
Input:
- prId: string       # PR 编号
- branch: string     # 分支名称
- runTests: boolean  # 是否执行单元测试
Output:
- success: boolean           # 是否成功执行
- testReport?: object[]      # 测试报告(可选)
- errorMessage?: string      # 错误信息(失败时返回)

步骤明确可执行

Skill 的核心是“步骤”,必须是指令式、具体动作,而不是概括性描述,确保模型可以按步骤执行。

描述性语言:

“检查 PR,运行测试,然后更新状态。”


指令式步骤:

YAML
Steps:
1. Validate PR: 检查 prId 和 branch 是否有效。
2. Checkout branch: 切换到指定分支。
3. Run tests: 根据 runTests 参数执行单元测试。
4. Collect results: 收集测试结果。
5. Update PR status: 将测试状态回写到 PR。
6. Notify user: 若测试失败,返回错误信息。

失败策略完备

模型在失败时容易自由发挥,可能产生不可预期的行为。必须明确定义“失败路径”,告诉模型在不同失败情况下如何处理。

失败策略示例:

YAML
On Failure:
- Validation fails: 返回 400 Bad Request,并附上具体错误信息。
- Test execution fails: 自动重试一次,仍失败则返回 “单元测试未通过,请检查日志”。
- CI/CD 服务不可用: 重试最多 3 次,仍失败则记录日志并通知管理员。

职责绝对单一

每个 Skill 只做一件事,对应一个核心动作动词。避免把多个功能捆绑在一个 Skill 中,否则复杂性和不确定性会增加,模型难以准确理解。

功能捆绑:

一个 Skill 同时完成“运行测试 + 更新 PR 状态 + 发送通知 + 执行 lint 校验”。


单一职责:

  • running-unit-tests: 只负责执行单元测试
  • updating-pr-status: 只负责更新 PR 状态
  • sending-notification: 只负责发送通知
  • running-lint-check: 只负责执行 lint 校验

让 Skill 可维护与可拓展

为了确保 Skill 在长期运行中保持稳定、易用且可持续拓展,需要从信息结构、工作流设计和脚本可靠性三个维度进行规划。

渐进式披露

SKILL.md 应当作为 Skill 的入口和导航,而不是一个包罗万象的大文件。详细的参考资料、示例、脚本或文档应拆分成独立文件,从而减轻模型初次加载的负担,让信息按需流动。

工作流与反馈闭环

对于包含多个步骤、且中间结果会影响最终质量的复杂任务,仅提供最终目标是不够的。必须显式定义工作流(Workflow)和 检查清单(Checklist),引导模型按步骤执行,并在关键节点建立 “验证 → 修正 → 再验证” 的反馈闭环。

工作流负责约束任务执行顺序,检查清单负责追踪任务的执行状态和质量。两者结合可以显著降低遗漏和跑偏的风险。

可执行脚本的加固原则

当 Skill 依赖可执行脚本时,脚本的健壮性应始终优先于代码的巧妙性。

Skill 本身不会理解或阅读你的代码逻辑,它只感知输入与输出。一旦脚本行为不可预测,模型就只能猜测,最终导致不稳定或错误的调用结果。因此,脚本必须做到:失败可预期、输出可理解、参数可解释。

构建与迭代 Skill 的最佳流程

Skill 的开发是一个以失败为起点、评测为牵引,持续迭代优化的工程化过程。

评测并非事后的验证环节,而是 Skill 设计的前提;Skill 也非基于假设的规则集合,而是针对已暴露问题的最小化解决方案。

遵循 “评测驱动、失败优先” 的原则,能确保 Skill 在实际使用场景中拥有清晰的能力边界、稳定的运行表现,以及可回归的质量保障体系。

第一步:建立无 Skill 基线,识别真实问题

在编写任何 Skill 之前,应先不使用 Skill,直接让模型执行目标任务,作为基线对照。

重点观察并记录以下问题:

这些失败点和不确定行为,本质上就是 Skill 需要解决的真实能力缺口,也是后续评测用例的来源。

第二步:以“失败优先”为原则,定义评测用例

明确核心问题后,需优先编写评测用例,而非直接开发 Skill。评测是约束,Skill 是落地实现。脱离评测约束的 Skill,本质上是在放大模型的行为不确定性。

评测的核心作用是约束 Skill 的行为边界,明确以下信息:

推荐做法:

第三步:编写最小化 Skill,明确最短成功路径

在评测已经存在的前提下,开始编写 Skill。

此阶段不追求覆盖所有情况,而是只编写刚好能够通过当前评测的最小规则集合,重点关注三个要素:

这一阶段的 Skill,是评测结果的直接产物,而非凭经验预判的方案。

第四步:补充边界条件与结构化示例

当最短成功路径能稳定通过评测后,再逐步扩展 Skill 的适用范围。

完成以下三项核心工作:

核心原则:所有新增规则,均需对应新增或已有评测用例,避免在无评测支撑的情况下将 Skill 复杂化。

第五步:评测回归与持续迭代

Skill 的迭代,需始终与评测结果强绑定,遵循以下规则:

通过持续对比模型在 “无 Skill 基线” 与 “当前 Skill + 评测” 中的表现,可验证该 Skill 是否真正提升了模型执行目标任务的成功率与稳定性。

第六步:结合真实使用路径进行校准

评测仅能覆盖已知问题,在真实场景中使用 Skill 时,可能会暴露更多新的问题。

在 Skill 实际使用过程中,需持续观察以下情况:

上述这些信号,均需作为新的评测输入,重新进入 Step 2,形成 Skill 迭代的闭环。

巧妙使用 AI 来创建和迭代 Skill

在创建和迭代 Skill 的过程中,可以多用 AI。你负责定义问题和验收结果,AI 负责反复试错、总结规律并封装成可复用的 Skill。

阶段一:初次创建(从具体任务中抽象)

让 AI 从真实任务中抽象出创建 Skill 所需的信息,然后创建初版 Skill。

  1. 让 AI 直接执行真实任务
    提供完整目标与上下文,让 AI 自行尝试完成任务。执行过程中的追问、走偏和修正,本质上就是一次“隐式评测”。
  2. 引导 AI 进行结构化复盘

    任务完成后,要求 AI 从以下维度复盘:

    • 成功执行任务的完整步骤;
    • 任务执行过程中的不确定性与失败点;
    • 可抽象的固定流程与判断逻辑;
    • 该流程和判断逻辑的适用场景与不适用场景。
  3. 基于复盘生成 Skill 初稿

    要求 AI 按 Skill 规范生成 SKILL.md,明确:触发条件(When)、如何执行(How)、输出结果(What)、预设失败策略。

  4. 人工快速评审并入库

    你只需关注边界是否合理、步骤是否可执行,其余交由 AI 完成。确认后,让 AI 调用 skills-creator 正式创建该 Skill 并添加至你的项目。

阶段二:持续迭代(从使用反馈中优化)

当 Skill 在使用中暴露新问题时,对其进行优化。

  1. 对齐偏差来源

    引导 AI 分析问题源自 When / What / How 中的哪一部分。

  2. 直接修改 Skill 并验证回归

    更新 SKILL.md,并同时验证:

    • 确保本次迭代未破坏原有的“黄金路径”。
    • 确保新发现的错误场景已被覆盖。

在 TRAE 中创建 Skill 的其他方式

除了通过 AI 对话创建 Skill 外,你还以手动创建或导入外部 Skill。详细说明参考《技能》。

附录:反模式检查清单

本表列出了在 Skill 开发中常见的反模式(Anti-Patterns),以及相应的原因、正确示例和错误示例。通过遵循这些规范,可以提升 Skill 的稳定性、可维护性和跨平台兼容性,避免模型误用或运行失败。

该 Checklist 可作为开发、评审和迭代 Skill 时的快速参考指南。

反模式

原因

正确示例

错误示例

使用 Windows 风格路径

跨平台兼容性差,Unix/Linux 系统会报错。

configs/deploy.yaml

configs\deploy.yaml

提供过多选择

过多选项会令模型困惑,增加决策成本与不确定性。

当存在多个选项时,Skill 必须指明一个“默认路径”。

"默认使用 PostgreSQL 作为数据库(适用于常规生产和测试环境)。仅在对兼容性有特殊要求或客户已有 MySQL 环境时,才使用 MySQL"。

"你可以用 PostgreSQL,或者 MySQL,或者 SQLite,或者 Oracle…"。

包含时效性信息

信息容易过期,导致 Skill 不可用。

将旧版本配置放入 deprecated/ 文件夹,并注明“不再推荐使用”。

"如果在 2025 年 8 月之前,请使用旧 API;之后请使用新 API。"

术语不一致

增加模型的理解成本,降低 Skill 可用性。

始终使用 "Service Endpoint"。

混用 "Service Endpoint", "API URL", "Endpoint Path"。

参考资料

https://platform.claude.com/docs/zh-CN/agents-and-tools/agent-skills/best-practices