---
name: skill-creator
description: 创建有效技能的指南。当用户想要创建新技能（或更新现有技能）以通过专门的知识、工作流程或工具集成扩展 Codex 功能时，应使用此技能。
metadata:
  short-description: 创建或更新技能
---

# 技能创建器

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

## 关于技能

技能是模块化、自包含的文件夹，通过提供专门的知识、工作流程和工具来扩展 Codex 的功能。将它们视为特定领域或任务的"入职指南"——它们将 Codex 从通用代理转变为配备程序性知识的专业代理，而没有任何模型能够完全拥有这些知识。

### 技能提供的内容

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

## 核心原则

### 简洁是关键

上下文窗口是公共资源。技能与 Codex 需要的所有其他内容共享上下文窗口：系统提示、对话历史、其他技能的元数据以及实际的用户请求。

**默认假设：Codex 已经非常智能。** 只添加 Codex 尚不具备的上下文。挑战每一条信息："Codex 真的需要这个解释吗？"和"这个段落是否值得其 token 成本？"

更喜欢简洁的示例而不是冗长的解释。

### 设置适当的自由度

将特异性级别与任务的脆弱性和可变性相匹配：

**高自由度（基于文本的说明）**：当多种方法都有效、决策取决于上下文或启发式方法指导方法时使用。

**中等自由度（带有参数的伪代码或脚本）**：当存在首选模式、某些变化可接受或配置影响行为时使用。

**低自由度（特定脚本、少量参数）**：当操作脆弱且容易出错、一致性至关重要或必须遵循特定顺序时使用。

将 Codex 视为探索路径：带有悬崖的狭窄桥梁需要特定的护栏（低自由度），而开阔的田野允许许多路线（高自由度）。

### 技能的解剖结构

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

```
skill-name/
├── SKILL.md（必需）
│   ├── YAML 前言元数据（必需）
│   │   ├── name：（必需）
│   │   └── description：（必需）
│   └── Markdown 说明（必需）
├── agents/（推荐）
│   └── openai.yaml - 技能列表和芯片的 UI 元数据
└── 捆绑资源（可选）
    ├── scripts/          - 可执行代码（Python/Bash 等）
    ├── references/       - 意在根据需要加载到上下文中的文档
    └── assets/           - 输出中使用的文件（模板、图标、字体等）
```

#### SKILL.md（必需）

每个 SKILL.md 由以下内容组成：

- **前言**（YAML）：包含 `name` 和 `description` 字段。这些是 Codex 读取以确定何时使用技能的唯一字段，因此清楚地全面描述技能是什么以及何时使用它非常重要。
- **正文**（Markdown）：使用技能及其捆绑资源的说明和指导。仅在技能触发后加载（如果有的话）。

#### Agents 元数据（推荐）

- 技能列表和芯片的面向 UI 的元数据
- 在生成值之前阅读 references/openai_yaml.md 并遵循其描述和约束
- 通过阅读技能创建面向人类的 `display_name`、`short_description` 和 `default_prompt`
- 通过将值作为 `--interface key=value` 传递给 `scripts/generate_openai_yaml.py` 或 `scripts/init_skill.py` 来确定性生成
- 更新时：验证 `agents/openai.yaml` 仍然匹配 SKILL.md；如果过时则重新生成
- 仅在明确提供时包含其他可选接口字段（图标、品牌颜色）
- 有关字段定义和示例，请参阅 references/openai_yaml.md

#### 捆绑资源（可选）

##### 脚本（`scripts/`）

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

- **何时包含**：当相同的代码被重复重写或需要确定性可靠性时
- **示例**：用于 PDF 旋转任务的 `scripts/rotate_pdf.py`
- **好处**：Token 高效、确定性，可以在不加载到上下文的情况下执行
- **注意**：Codex 可能仍需要读取脚本以进行修补或特定于环境的调整

##### 参考资料（`references/`）

意在根据需要加载到上下文中以通知 Codex 的过程和思维的文档和参考资料。

- **何时包含**：用于 Codex 在工作时应该参考的文档
- **示例**：用于财务架构的 `references/finance.md`、用于公司 NDA 模板的 `references/mnda.md`、用于公司政策的 `references/policies.md`、用于 API 规范的 `references/api_docs.md`
- **用例**：数据库架构、API 文档、领域知识、公司政策、详细的工作流程指南
- **好处**：保持 SKILL.md 精简，仅在 Codex 确定需要时加载
- **最佳实践**：如果文件很大（超过 1 万字），请在 SKILL.md 中包含 grep 搜索模式
- **避免重复**：信息应存在于 SKILL.md 或参考文件中，而不是两者中。对于详细信息，更喜欢参考文件，除非它对技能真正核心——这使 SKILL.md 保持精简，同时使信息可在不占用上下文窗口的情况下被发现。在 SKILL.md 中仅保留基本的过程说明和工作流程指导；将详细的参考资料、架构和示例移至参考文件。

##### 资产（`assets/`）

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

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

#### 技能中不应包含的内容

技能应仅包含直接支持其功能的基本文件。不要创建多余的文档或辅助文件，包括：
- README.md
- INSTALLATION_GUIDE.md
- QUICK_REFERENCE.md
- CHANGELOG.md
- 等等。

技能应仅包含 AI 代理完成手头工作所需的信息。它不应包含有关创建它的过程的辅助上下文、设置和测试程序、面向用户的文档等。创建额外的文档文件只会增加混乱和混淆。

### 渐进式披露设计原则

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

1. **元数据（名称 + 描述）** - 始终在上下文中（约 100 字）
2. **SKILL.md 正文** - 当技能触发时（少于 5k 字）
3. **捆绑资源** - 由 Codex 根据需要（无限，因为脚本可以在不读入上下文窗口的情况下执行）

#### 渐进式披露模式

保持 SKILL.md 正文精简且少于 500 行，以尽量减少上下文膨胀。在接近此限制时将内容拆分为单独的文件。将内容拆分到其他文件时，非常重要的一点是从 SKILL.md 引用它们并清楚地描述何时阅读它们，以确保技能的读者知道它们的存在以及何时使用它们。

**关键原则：**当技能支持多个变体、框架或选项时，仅在 SKILL.md 中保留核心工作流程和选择指导。将特定于变体的详细信息（模式、示例、配置）移至单独的参考文件。

**模式 1：带有参考资料的高级指南**

```markdown
# PDF 处理

## 快速开始

使用 pdfplumber 提取文本：
[代码示例]

## 高级功能

- **表单填写**：完整指南请参阅 [FORMS.md](FORMS.md)
- **API 参考**：所有方法请参阅 [REFERENCE.md](REFERENCE.md)
- **示例**：常见模式请参阅 [EXAMPLES.md](EXAMPLES.md)
```

Codex 仅在需要时加载 FORMS.md、REFERENCE.md 或 EXAMPLES.md。

**模式 2：特定于领域的组织**

对于具有多个领域的技能，按领域组织内容以避免加载不相关的上下文：

```
bigquery-skill/
├── SKILL.md（概述和导航）
└── reference/
    ├── finance.md（收入、计费指标）
    ├── sales.md（机会、管道）
    ├── product.md（API 使用、功能）
    └── marketing.md（活动、归因）
```

当用户询问销售指标时，Codex 仅读取 sales.md。

同样，对于支持多个框架或变体的技能，按变体组织：

```
cloud-deploy/
├── SKILL.md（工作流程 + 提供商选择）
└── references/
    ├── aws.md（AWS 部署模式）
    ├── gcp.md（GCP 部署模式）
    └── azure.md（Azure 部署模式）
```

当用户选择 AWS 时，Codex 仅读取 aws.md。

**模式 3：条件性详细信息**

显示基本内容，链接到高级内容：

```markdown
# DOCX 处理

## 创建文档

使用 docx-js 创建新文档。请参阅 [DOCX-JS.md](DOCX-JS.md)。

## 编辑文档

对于简单编辑，直接修改 XML。

**对于修订跟踪**：请参阅 [REDLINING.md](REDLINING.md)
**对于 OOXML 详细信息**：请参阅 [OOXML.md](OOXML.md)
```

Codex 仅在用户需要这些功能时读取 REDLINING.md 或 OOXML.md。

**重要指导原则：**

- **避免深度嵌套的引用** - 保持引用距离 SKILL.md 一层深度。所有参考文件都应直接从 SKILL.md 链接。
- **构建较长的参考文件** - 对于超过 100 行的文件，在顶部包含目录，以便 Codex 在预览时可以看到完整范围。

## 技能创建过程

技能创建涉及以下步骤：

1. 通过具体示例了解技能
2. 规划可重用的技能内容（脚本、参考资料、资产）
3. 初始化技能（运行 init_skill.py）
4. 编辑技能（实现资源并编写 SKILL.md）
5. 验证技能（运行 quick_validate.py）
6. 根据实际使用进行迭代

按顺序执行这些步骤，仅在有明确理由不适用时才跳过。

### 技能命名

- 仅使用小写字母、数字和连字符；将用户提供的标题规范化为连字符大小写（例如，"Plan Mode" -> `plan-mode`）。
- 生成名称时，生成一个 64 个字符以下的名称（字母、数字、连字符）。
- 更喜欢简短的、以动词引导的描述动作的短语。
- 当它提高清晰度或触发时，按工具命名空间（例如，`gh-address-comments`、`linear-address-issue`）。
- 技能文件夹的名称与技能名称完全相同。

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

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

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

例如，在构建 image-editor 技能时，相关问题包括：
- "image-editor 技能应该支持什么功能？编辑、旋转，还是其他？"
- "你能举一些如何使用这个技能的例子吗？"
- "我可以想象用户要求诸如'从这张图片中去除红眼'或'旋转这张图片'之类的事情。你能想象这个技能还有其他使用方式吗？"
- "用户会说什么来触发这个技能？"

为了避免让用户不知所措，避免在一条消息中问太多问题。从最重要的问题开始，并根据需要进行后续跟进以提高有效性。

当清楚了解技能应支持的功能时，结束此步骤。

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

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

1. 考虑如何从头开始执行示例
2. 确定在重复执行这些工作流程时哪些脚本、参考资料和资产会有帮助

示例：在构建 `pdf-editor` 技能以处理诸如"帮我旋转这个 PDF"之类的查询时，分析显示：
1. 旋转 PDF 每次都需要重写相同的代码
2. 在技能中存储 `scripts/rotate_pdf.py` 脚本会有帮助

示例：在设计 `frontend-webapp-builder` 技能以处理诸如"为我构建一个待办事项应用程序"或"为我构建一个仪表板来跟踪我的步骤"之类的查询时，分析显示：
1. 编写前端 webapp 每次都需要相同的样板 HTML/React
2. 在技能中存储包含样板 HTML/React 项目文件的 `assets/hello-world/` 模板会有帮助

示例：在构建 `big-query` 技能以处理诸如"今天有多少用户登录？"之类的查询时，分析显示：
1. 每次查询 BigQuery 都需要重新发现表架构和关系
2. 在技能中存储记录表架构的 `references/schema.md` 文件会有帮助

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

### 步骤 3：初始化技能

此时，是时候实际创建技能了。

仅当正在开发的技能已经存在时才跳过此步骤。在这种情况下，继续下一步。

从头开始创建新技能时，始终运行 `init_skill.py` 脚本。该脚本方便地生成一个新的模板技能目录，自动包含技能所需的一切，使技能创建过程更加高效和可靠。

用法：

```bash
scripts/init_skill.py <skill-name> --path <output-directory> [--resources scripts,references,assets] [--examples]
```

示例：

```bash
scripts/init_skill.py my-skill --path skills/public
scripts/init_skill.py my-skill --path skills/public --resources scripts,references
scripts/init_skill.py my-skill --path skills/public --resources scripts --examples
```

该脚本：
- 在指定路径创建技能目录
- 生成带有适当前言和 TODO 占位符的 SKILL.md 模板
- 使用通过 `--interface key=value` 传递的代理生成的 `display_name`、`short_description` 和 `default_prompt` 创建 `agents/openai.yaml`
- 可选地根据 `--resources` 创建资源目录
- 可选地在设置 `--examples` 时添加示例文件

初始化后，根据需要自定义 SKILL.md 并添加资源。如果您使用了 `--examples`，请替换或删除占位符文件。

通过阅读技能生成 `display_name`、`short_description` 和 `default_prompt`，然后将它们作为 `--interface key=value` 传递给 `init_skill.py` 或通过以下方式重新生成：

```bash
scripts/generate_openai_yaml.py <path/to/skill-folder> --interface key=value
```

仅当用户明确提供时才包含其他可选接口字段。有关完整的字段描述和示例，请参阅 references/openai_yaml.md。

### 步骤 4：编辑技能

编辑（新生成的或现有的）技能时，请记住技能是为另一个 Codex 实例创建的。包含对 Codex 有益且不明显的信息。考虑哪些程序性知识、特定于领域的详细信息或可重用资产将帮助另一个 Codex 实例更有效地执行这些任务。

#### 从可重用的技能内容开始

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

必须通过实际运行添加的脚本来测试，以确保没有错误并且输出符合预期。如果有许多类似的脚本，只需要测试具有代表性的样本，以确保对它们都有信心，同时平衡完成时间。

如果您使用了 `--examples`，请删除技能不需要的任何占位符文件。仅创建实际需要的资源目录。

#### 更新 SKILL.md

**编写指南：** 始终使用祈使/不定式形式。

##### 前言

使用 `name` 和 `description` 编写 YAML 前言：

- `name`：技能名称
- `description`：这是技能的主要触发机制，并帮助 Codex 理解何时使用技能。
  - 包括技能做什么以及何时使用的特定触发器/上下文。
  - 在此处包括所有"何时使用"信息 - 不在正文中。正文仅在触发后加载，因此正文中的"何时使用此技能"部分对 Codex 没有帮助。
  - `docx` 技能的描述示例："全面的文档创建、编辑和分析，支持修订跟踪、评论、格式保留和文本提取。当 Codex 需要处理专业文档（.docx 文件）时使用：（1）创建新文档，（2）修改或编辑内容，（3）使用修订跟踪，（4）添加评论，或任何其他文档任务"

不要在 YAML 前言中包含任何其他字段。

##### 正文

编写使用技能及其捆绑资源的说明。

### 步骤 5：验证技能

一旦技能开发完成，验证技能文件夹以尽早发现基本问题：

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

验证脚本检查 YAML 前言格式、必需字段和命名规则。如果验证失败，修复报告的问题并再次运行命令。

### 步骤 6：迭代

测试技能后，用户可能会请求改进。通常这发生在使用技能后不久，具有技能如何表现的新鲜上下文。

**迭代工作流程：**

1. 在实际任务上使用技能
2. 注意挣扎或低效
3. 确定 SKILL.md 或捆绑资源应该如何更新
4. 实施更改并再次测试