name: skill-creator description: 当用户想要“创建技能”、“编写新技能”、“改进技能描述”、“组织技能内容”，或需要关于技能结构、渐进式披露或技能开发最佳实践的指导时，应使用此技能。

技能创建器

此技能提供创建有效技能的指南。

关于技能

技能是模块化、自包含的包，通过提供专门的知识、工作流程和工具来扩展OpenHands的能力。将它们视为特定领域或任务的“入门指南”——它们将OpenHands从通用代理转变为具备程序性知识的专业代理，这些知识是任何模型都无法完全掌握的。

技能提供的内容

专门工作流程 - 针对特定领域的多步骤程序
工具集成 - 用于处理特定文件格式或API的指令
领域专业知识 - 公司特定知识、架构、业务逻辑
捆绑资源 - 用于复杂和重复任务的脚本、参考资料和资产

技能的结构

每个技能包括一个必需的SKILL.md文件和可选的捆绑资源：

skill-name/
├── SKILL.md（必需）
│   ├── YAML前注元数据（必需）
│   │   ├── name:（必需）
│   │   └── description:（必需）
│   └── Markdown指令（必需）
└── 捆绑资源（可选）
    ├── scripts/          - 可执行代码（Python/Bash等）
    ├── references/       - 根据需要加载到上下文中的文档
    └── assets/           - 用于输出的文件（模板、图标、字体等）

SKILL.md（必需）

元数据质量： YAML前注中的name和description决定了OpenHands何时使用该技能。具体说明技能的功能和使用时机。使用第三人称（例如，“此技能应在…时使用”，而不是“在…时使用此技能”）。

捆绑资源（可选）

脚本（`scripts/`）

用于需要确定性可靠性或反复重写任务的可执行代码（Python/Bash等）。

何时包含： 当相同代码被反复重写或需要确定性可靠性时
示例： scripts/rotate_pdf.py 用于PDF旋转任务
好处： 令牌高效、确定性、可能无需加载到上下文中执行
注意： 脚本可能仍需OpenHands读取以进行修补或环境特定调整

参考资料（`references/`）

旨在根据需要加载到上下文中以通知OpenHands过程和思考的文档和参考材料。

何时包含： 用于OpenHands在工作时应参考的文档
示例： references/finance.md 用于财务架构，references/mnda.md 用于公司NDA模板，references/policies.md 用于公司政策，references/api_docs.md 用于API规范
用例： 数据库架构、API文档、领域知识、公司政策、详细工作流程指南
好处： 保持SKILL.md简洁，仅在OpenHands确定需要时加载
最佳实践： 如果文件较大（>10k字），在SKILL.md中包含grep搜索模式
避免重复： 信息应仅存在于SKILL.md或参考资料文件中，而非两者。优先将详细信息放在参考资料文件中，除非其确实是技能的核心——这能保持SKILL.md简洁，同时使信息可发现而不占用上下文窗口。仅在SKILL.md中保留基本程序指令和工作流程指导；将详细参考材料、架构和示例移到参考资料文件中。

资产（`assets/`）

不旨在加载到上下文中，而是在OpenHands产生的输出中使用的文件。

何时包含： 当技能需要用于最终输出的文件时
示例： assets/logo.png 用于品牌资产，assets/slides.pptx 用于PowerPoint模板，assets/frontend-template/ 用于HTML/React样板，assets/font.ttf 用于排版
用例： 模板、图像、图标、样板代码、字体、被复制或修改的示例文档
好处： 将输出资源与文档分离，使OpenHands能够使用文件而无需加载到上下文中

渐进式披露设计原则

技能使用三级加载系统以高效管理上下文：

元数据（名称+描述） - 始终在上下文中（约100字）
SKILL.md正文 - 当技能触发时（<5k字）
捆绑资源 - 根据需要由OpenHands加载（无限*）

*无限，因为脚本可以在不读入上下文窗口的情况下执行。

技能创建过程

要创建技能，请按顺序遵循“技能创建过程”，仅在明显不适用时才跳过步骤。

步骤1：通过具体示例理解技能

仅当技能使用模式已清晰理解时才跳过此步骤。即使处理现有技能，它仍然有价值。

要创建有效技能，请清晰理解技能将如何使用的具体示例。这种理解可以来自直接用户示例或经用户反馈验证的生成示例。

例如，在构建图像编辑器技能时，相关问题包括：

“图像编辑器技能应支持哪些功能？编辑、旋转，还有其他吗？”
“你能给出一些此技能将如何使用的示例吗？”
“我可以想象用户会问‘从这张图像中移除红眼’或‘旋转这张图像’。你想象此技能还有其他使用方式吗？”
“用户说什么会触发此技能？”

为避免使用户不知所措，避免在单个消息中问太多问题。从最重要的问题开始，并根据需要跟进以提高效率。

当对技能应支持的功能有清晰感时结束此步骤。

步骤2：规划可重用技能内容

要将具体示例转化为有效技能，通过以下方式分析每个示例：

考虑如何从零开始执行示例
识别在执行这些工作流程反复时，哪些脚本、参考资料和资产会有帮助

示例：当构建pdf-editor技能以处理查询如“帮我旋转这个PDF”时，分析显示：

旋转PDF每次都需要重写相同代码
在技能中存储scripts/rotate_pdf.py脚本会有帮助

示例：当设计frontend-webapp-builder技能以处理查询如“为我构建一个待办事项应用”或“为我构建一个跟踪步数的仪表板”时，分析显示：

编写前端Web应用每次都需要相同的样板HTML/React
在技能中存储包含样板HTML/React项目文件的assets/hello-world/模板会有帮助

示例：当构建big-query技能以处理查询如“今天有多少用户登录？”时，分析显示：

查询BigQuery每次都需要重新发现表架构和关系
在技能中存储记录表架构的references/schema.md文件会有帮助

要建立技能内容，分析每个具体示例以创建要包含的可重用资源列表：脚本、参考资料和资产。

步骤3：创建技能结构

创建技能目录结构：

mkdir -p skill-name/{references,scripts,assets}
touch skill-name/SKILL.md

或者，使用init_skill.py脚本生成模板：

scripts/init_skill.py <skill-name> --path <output-directory>

该脚本创建带有SKILL.md模板和示例资源目录的技能目录。

步骤4：编辑技能

编辑（新创建或现有）技能时，记住技能是为另一个OpenHands实例使用而创建的。专注于包含对OpenHands有益且非显而易见的信息。考虑哪些程序性知识、领域特定细节或可重用资产会帮助另一个OpenHands实例更有效地执行这些任务。

从可重用技能内容开始

开始实现时，从上述识别的可重用资源开始：scripts/、references/和assets/文件。注意，此步骤可能需要用户输入。例如，当实现brand-guidelines技能时，用户可能需要提供品牌资产或模板以存储在assets/中，或文档存储在references/中。

此外，删除技能不需要的任何示例文件和目录。仅创建您实际需要的目录（references/、scripts/、assets/）。

更新SKILL.md

写作风格： 使用命令式/不定式形式（动词优先指令）编写整个技能，而非第二人称。使用客观、指导性语言（例如，“为完成X，执行Y”，而非“你应该执行X”或“如果你需要执行X”）。这为AI消费保持一致性和清晰度。

描述（前注）： 使用第三人称格式和具体触发短语：

---
name: skill-name
description: 当用户要求“特定短语1”、“特定短语2”、“特定短语3”时，应使用此技能。包括用户会说并应触发此技能的确切短语。具体且明确。
---

良好描述示例：

description: 当用户要求“创建钩子”、“添加PreToolUse钩子”、“验证工具使用”、“实现基于提示的钩子”，或提及钩子事件（PreToolUse、PostToolUse、Stop）时，应使用此技能。

不良描述示例：

description: 在处理钩子时使用此技能。  # 错误人称，模糊
description: 当用户需要钩子帮助时加载。  # 非第三人称
description: 提供钩子指导。  # 无触发短语

要完成SKILL.md正文，回答以下问题：

技能的目的是什么，用几句话说明？
何时应使用技能？（在前注描述中包含具体触发短语）
在实践中，OpenHands应如何使用技能？所有上述开发的可重用技能内容应被引用，以便OpenHands知道如何使用它们。

保持SKILL.md简洁： 目标正文1,500-2,000字。将详细内容移到references/：

详细模式 → references/patterns.md
高级技术 → references/advanced.md
迁移指南 → references/migration.md
API参考 → references/api-reference.md

在SKILL.md中引用资源：

## 其他资源

### 参考文件

有关详细模式和技术，请查阅：
- **`references/patterns.md`** - 常见模式
- **`references/advanced.md`** - 高级用例

### 示例文件

`examples/`中的工作示例：
- **`example-script.sh`** - 工作示例

步骤5：验证和测试

检查结构： 技能目录包含SKILL.md
验证SKILL.md： 具有带名称和描述的前注
检查触发短语： 描述包括具体用户查询
验证写作风格： 正文使用命令式/不定式形式，非第二人称
测试渐进式披露： SKILL.md简洁（约1,500-2,000字），详细内容在references/
检查引用： 所有引用的文件存在
验证脚本： 脚本可执行且正常工作

使用验证脚本检查基本要求：

scripts/quick_validate.py <path/to/skill-folder>

步骤6：迭代

测试技能后，用户可能请求改进。这通常在刚使用技能后发生，对技能性能有新鲜上下文。

迭代工作流程：

在实际任务上使用技能
注意困难或低效之处
识别应如何更新SKILL.md或捆绑资源
实施更改并再次测试

常见改进：

在描述中强化触发短语
将长部分从SKILL.md移到references/
添加缺失示例或脚本
澄清模糊指令
添加边缘情况处理

渐进式披露实践

放入SKILL.md的内容

包含（技能触发时始终加载）：

核心概念和概述
基本程序和流程
快速参考表
指向参考资料/示例/脚本的指针
最常见用例

保持在3,000字以下，理想情况1,500-2,000字

放入references/的内容

移到references/（根据需要加载）：

详细模式和高级技术
全面API文档
迁移指南
边缘案例和故障排除
广泛示例和演练

每个参考文件可以较大（2,000-5,000+字）

放入scripts/的内容

实用脚本：

验证工具
测试助手
解析实用程序
自动化脚本

应可执行且文档化

写作风格要求

命令式/不定式形式

使用动词优先指令编写，非第二人称：

正确（命令式）：

要创建钩子，定义事件类型。
配置MCP服务器并进行身份验证。
使用前验证设置。

不正确（第二人称）：

你应该通过定义事件类型来创建钩子。
你需要配置MCP服务器。
你必须在使用前验证设置。

描述中的第三人称

前注描述必须使用第三人称：

正确：

description: 当用户要求“创建X”、“配置Y”时，应使用此技能。

不正确：

description: 当你想创建X时使用此技能。
description: 当用户询问时加载此技能。

客观、指导性语言

专注于做什么，而非谁应做：

正确：

使用sed解析前注。
使用grep提取字段。
使用前验证值。

不正确：

你可以解析前注。
OpenHands应提取字段。
用户可能验证值。

验证检查清单

在最终确定技能前：

结构：

[ ] SKILL.md文件存在且具有有效YAML前注
[ ] 前注具有name和description字段
[ ] Markdown正文存在且充实
[ ] 引用的文件实际存在

描述质量：

[ ] 使用第三人称（“此技能应在…时使用”）
[ ] 包括用户会说的具体触发短语
[ ] 列出具体场景（“创建X”、“配置Y”）
[ ] 非模糊或通用

内容质量：

[ ] SKILL.md正文使用命令式/不定式形式
[ ] 正文聚焦且简洁（理想情况1,500-2,000字，最大<5k）
[ ] 详细内容移到references/
[ ] 示例完整且工作
[ ] 脚本可执行且文档化

渐进式披露：

[ ] 核心概念在SKILL.md中
[ ] 详细文档在references/中
[ ] 实用程序在scripts/中
[ ] SKILL.md引用这些资源

测试：

[ ] 技能在预期用户查询上触发
[ ] 内容对预期任务有帮助
[ ] 文件间无重复信息
[ ] 引用在需要时加载

常见错误避免

错误1：弱触发描述

❌ 不良：

description: 提供处理钩子的指导。

为何不良： 模糊、无具体触发短语、非第三人称

✅ 良好：

description: 当用户要求“创建钩子”、“添加PreToolUse钩子”、“验证工具使用”，或提及钩子事件时，应使用此技能。提供全面钩子API指导。

为何良好： 第三人称、具体短语、具体场景

错误2：SKILL.md内容过多

❌ 不良：

skill-name/
└── SKILL.md（8,000字 - 所有内容在一个文件中）

为何不良： 当技能加载时臃肿上下文，详细内容始终加载

✅ 良好：

skill-name/
├── SKILL.md（1,800字 - 核心要点）
└── references/
    ├── patterns.md（2,500字）
    └── advanced.md（3,700字）

为何良好： 渐进式披露，详细内容仅在需要时加载

错误3：第二人称写作

❌ 不良：

你应该从读取配置文件开始。
你需要验证输入。
你可以使用grep工具搜索。

为何不良： 第二人称、非命令式形式

✅ 良好：

从读取配置文件开始。
在处理前验证输入。
使用grep工具搜索模式。

为何良好： 命令式形式、直接指令

错误4：缺失资源引用

❌ 不良：

# SKILL.md

[核心内容]

[未提及references/或examples/]

为何不良： OpenHands不知道引用存在

✅ 良好：

# SKILL.md

[核心内容]

## 其他资源

### 参考文件
- **`references/patterns.md`** - 详细模式
- **`references/advanced.md`** - 高级技术

### 脚本
- **`scripts/validate.sh`** - 验证实用程序

为何良好： OpenHands知道在哪里找到额外信息

快速参考

最小技能

skill-name/
└── SKILL.md

适用于：简单知识，无需复杂资源

标准技能（推荐）

skill-name/
├── SKILL.md
├── references/
│   └── detailed-guide.md
└── scripts/
    └── helper.py

适用于：具有详细文档的大多数技能

完整技能

skill-name/
├── SKILL.md
├── references/
│   ├── patterns.md
│   └── advanced.md
├── scripts/
│   └── validate.sh
└── assets/
    └── template.txt

适用于：具有验证实用程序的复杂领域

最佳实践总结

✅ 应做：

在描述中使用第三人称（“此技能应在…时使用”）
包括具体触发短语（“创建X”、“配置Y”）
保持SKILL.md简洁（1,500-2,000字）
使用渐进式披露（将细节移到references/）
以命令式/不定式形式编写
清晰引用支持文件
提供工作示例
为常见操作创建实用脚本

❌ 不应做：

在任何地方使用第二人称
有模糊触发条件
将所有内容放在SKILL.md中（>3,000字且无references/）
以第二人称编写（“你应该…”）
留下未引用资源
包含损坏或不完整示例
跳过验证

其他资源

参考文件

有关详细模式和技术，请查阅：

references/workflows.md - 顺序工作流程和条件逻辑模式
references/output-patterns.md - 特定输出格式的模板和示例模式

实现工作流程

要创建技能：

理解用例： 识别技能使用的具体示例
规划资源： 确定需要哪些脚本/参考资料/资产
创建结构： mkdir -p skill-name/{references,scripts,assets}
编写SKILL.md：
- 前注包含第三人称描述和触发短语
- 简洁正文（1,500-2,000字）以命令式形式
- 引用支持文件
添加资源： 根据需要创建references/、scripts/、assets/
验证： 检查描述、写作风格、组织
测试： 验证技能在预期触发时加载
迭代： 基于使用改进

专注于强触发描述、渐进式披露和命令式写作风格，以创建在需要时加载并提供有针对指导的有效技能。

name: skill-creator description: 当用户想要“创建技能”、“编写新技能”、“改进技能描述”、“组织技能内容”，或需要关于技能结构、渐进式披露或技能开发最佳实践的指导时，应使用此技能。

技能创建器

关于技能

技能提供的内容

技能的结构

SKILL.md（必需）

捆绑资源（可选）

脚本（scripts/）

参考资料（references/）

资产（assets/）

渐进式披露设计原则

技能创建过程

步骤1：通过具体示例理解技能

步骤2：规划可重用技能内容

步骤3：创建技能结构

步骤4：编辑技能

从可重用技能内容开始

更新SKILL.md

步骤5：验证和测试

步骤6：迭代

渐进式披露实践

放入SKILL.md的内容

放入references/的内容

放入scripts/的内容

写作风格要求

命令式/不定式形式

描述中的第三人称

客观、指导性语言

验证检查清单

常见错误避免

错误1：弱触发描述

错误2：SKILL.md内容过多

错误3：第二人称写作

错误4：缺失资源引用

快速参考

最小技能

标准技能（推荐）

完整技能

最佳实践总结

其他资源

参考文件

实现工作流程

脚本（`scripts/`）

参考资料（`references/`）

资产（`assets/`）