skill-creator

技能创建器

此技能提供创建高效技能的指导。

关于技能

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

技能提供的内容

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

核心原则

简洁至关重要

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

默认假设：Codex 已经非常聪明。 只添加 Codex 尚不了解的上下文。审视每条信息：“Codex 真的需要这段解释吗？”以及“这段话值得占用相应的 token 吗？”

优先使用简洁示例，而不是冗长解释。

设定适当的自由度

根据任务的脆弱性和可变性，匹配具体程度：

高自由度（基于文本的说明）：适用于存在多种有效方法、决策取决于上下文，或需要依靠启发式方法指导的情况。

中自由度（带参数的伪代码或脚本）：适用于存在首选模式、允许一定变化，或配置会影响行为的情况。

低自由度（参数较少的具体脚本）：适用于操作脆弱且容易出错、一致性至关重要，或必须遵循特定顺序的情况。

可以把 Codex 想象成在探索一条路径：悬崖边的狭窄桥梁需要明确的护栏（低自由度），而开阔的田野则允许多种路线（高自由度）。

技能的组成

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

skill-name/
├── SKILL.md (required)
│   ├── YAML frontmatter metadata (required)
│   │   ├── name: (required)
│   │   └── description: (required)
│   └── Markdown instructions (required)
└── Bundled Resources (optional)
    ├── scripts/          - Executable code (Python/Bash/etc.)
    ├── references/       - Documentation intended to be loaded into context as needed
    └── assets/           - Files used in output (templates, icons, fonts, etc.)

SKILL.md（必需）

每个 SKILL.md 都包含：

• Frontmatter（YAML）：包含 name 和 description 字段。这是 Codex 用来判断何时使用该技能的唯一字段，因此清晰、全面地描述技能的内容及其适用场景非常重要。
• 正文（Markdown）：使用该技能的说明和指导。仅在技能触发后（如果触发）加载。

捆绑资源（可选）

脚本（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 判断有需要时加载
• 最佳实践：如果文件较大（>10k 字），请在 SKILL.md 中加入 grep 搜索模式
• 避免重复：信息应放在 SKILL.md 或 references 文件中，而不是两者都放。除非某些信息确实是技能的核心内容，否则详细信息优先放在 references 文件中，这样既能让 SKILL.md 保持精简，又能让信息易于发现，而不会占用过多上下文窗口。SKILL.md 中仅保留必要的操作说明和工作流指导；详细参考资料、架构和示例则移至 references 文件。

资源文件（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 Agent 完成当前任务所需的信息。不应包含有关创建过程的辅助背景、设置和测试流程、面向用户的文档等内容。创建额外的文档文件只会增加杂乱和混淆。

渐进式披露设计原则

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

1. 元数据（名称 + 描述） - 始终位于上下文中（约 100 个词）
2. SKILL.md 正文 - 技能触发时加载（<5k 个词）
3. 捆绑资源 - Codex 按需使用（无限制，因为可以执行脚本，而无需将其读入上下文窗口）

渐进式披露模式

将 SKILL.md 正文控制在必要内容范围内，并限制在 500 行以内，以尽量减少上下文膨胀。接近这一限制时，请将内容拆分到单独的文件中。将内容拆分到其他文件时，务必在 SKILL.md 中引用这些文件，并清楚说明何时阅读，确保技能的读者知道这些文件的存在及其用途。

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

模式 1：高层指南与参考文件

# PDF Processing

## Quick start

Extract text with pdfplumber:
[code example]

## Advanced features

- **Form filling**: See [FORMS.md](FORMS.md) for complete guide
- **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
- **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns

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

模式 2：按领域组织

对于包含多个领域的技能，按领域组织内容，以避免加载无关上下文：

bigquery-skill/
├── SKILL.md (overview and navigation)
└── reference/
    ├── finance.md (revenue, billing metrics)
    ├── sales.md (opportunities, pipeline)
    ├── product.md (API usage, features)
    └── marketing.md (campaigns, attribution)

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

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

cloud-deploy/
├── SKILL.md (workflow + provider selection)
└── references/
    ├── aws.md (AWS deployment patterns)
    ├── gcp.md (GCP deployment patterns)
    └── azure.md (Azure deployment patterns)

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

模式 3：条件式详细信息

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

# DOCX Processing

## Creating documents

Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).

## Editing documents

For simple edits, modify the XML directly.

**For tracked changes**: See [REDLINING.md](REDLINING.md)
**For OOXML details**: See [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. 打包技能（运行 package_skill.py）
6. 根据实际使用情况迭代

请按顺序执行这些步骤；只有在有明确理由说明某个步骤不适用时，才跳过该步骤。

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

只有在已充分了解该技能的使用模式时，才跳过此步骤。即使是在处理现有技能时，这一步仍然很有价值。

要创建有效的技能，必须清楚了解该技能的具体使用方式。这种了解可以来自用户直接提供的示例，也可以来自经用户反馈验证的生成示例。

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

• “图像编辑器技能应支持哪些功能？编辑、旋转，还有其他功能吗？”
• “你能举一些该技能的使用示例吗？”
• “我可以想到用户可能会提出‘去除这张图片中的红眼’或‘旋转这张图片’之类的要求。你还能想到其他使用方式吗？”
• “用户会说什么话来触发这个技能？”

为避免让用户不堪其扰，请勿在一条消息中提出过多问题。先提出最重要的问题，再根据需要继续追问，以提升效果。

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

第 2 步：规划可复用的技能内容

要将具体示例转化为有效的技能，请逐一分析每个示例：

1. 思考如何从头开始完成示例中的任务
2. 确定在重复执行这些工作流时，哪些脚本、参考资料和素材会有所帮助

示例：创建 pdf-editor 技能以处理“帮我旋转这个 PDF”之类的请求时，分析发现：

1. 每次旋转 PDF 都需要重新编写相同的代码
2. 将 scripts/rotate_pdf.py 脚本存放在技能中会很有帮助

示例：设计 frontend-webapp-builder 技能以处理“帮我构建一个待办事项应用”或“帮我构建一个追踪步数的仪表板”之类的请求时，分析发现：

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

示例：创建 big-query 技能以处理“今天有多少用户登录？”之类的请求时，分析发现：

1. 每次查询 BigQuery 都需要重新查找表结构及其关系
2. 将说明表结构的 references/schema.md 文件存放在技能中会很有帮助

要确定技能包含哪些内容，请分析每个具体示例，列出需要包含的可复用资源：脚本、参考资料和素材。

第 3 步：初始化技能

现在可以正式创建技能了。

只有当要开发的技能已存在，且需要迭代或打包时，才跳过此步骤。在这种情况下，请继续下一步。

从头创建新技能时，务必运行 init_skill.py 脚本。该脚本可以便捷地生成新的技能模板目录，并自动包含技能所需的一切，从而显著提高技能创建过程的效率和可靠性。

用法：

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

该脚本会：

• 在指定路径创建技能目录
• 生成包含正确 frontmatter 和 TODO 占位符的 SKILL.md 模板
• 创建示例资源目录：scripts/、references/ 和 assets/
• 在各目录中添加可自定义或删除的示例文件

初始化后，可根据需要自定义或删除生成的 SKILL.md 和示例文件。

第 4 步：编辑技能

编辑（新生成或已有的）技能时，请记住，该技能是为另一个 Codex 实例创建的。请加入对 Codex 有用且不显而易见的信息。思考哪些流程知识、领域特定细节或可复用素材能够帮助另一个 Codex 实例更有效地完成这些任务。

学习经过验证的设计模式

根据技能需求，参考以下实用指南：

• 多步骤流程：参阅 references/workflows.md，了解顺序工作流和条件逻辑
• 特定输出格式或质量标准：参阅 references/output-patterns.md，了解模板和示例模式

这些文件包含经实践验证的有效技能设计最佳实践。

从可复用的技能内容着手

开始实现时，先从上述确定的可复用资源着手：scripts/、references/ 和 assets/ 文件。请注意，此步骤可能需要用户输入。例如，实现 brand-guidelines 技能时，用户可能需要提供品牌素材或模板，以便存放在 assets/ 中，或提供文档，以便存放在 references/ 中。

必须通过实际运行新增的脚本来测试，确保没有错误且输出符合预期。如果有许多相似脚本，只需测试有代表性的一部分，确保对它们都能正常运行有信心，同时兼顾完成时间。

删除技能不需要的示例文件和目录。初始化脚本会在 scripts/、references/ 和 assets/ 中创建示例文件以展示结构，但大多数技能不会用到所有这些文件。

更新 SKILL.md

写作指南： 始终使用祈使形式或不定式形式。

Frontmatter

编写包含 name 和 description 的 YAML frontmatter：

• name：技能名称
• description：这是技能的主要触发机制，可帮助 Codex 理解何时使用该技能。
  • 同时说明技能的功能，以及使用技能的具体触发条件或场景。
  • 将所有“何时使用”的信息都放在此处，而不是正文中。只有触发技能后才会加载正文，因此在正文中添加“何时使用此技能”部分对 Codex 没有帮助。
  • docx 技能的描述示例：“全面支持文档创建、编辑和分析，包括修订跟踪、批注、格式保留和文本提取。Codex 需要处理专业文档（.docx 文件）时使用，包括：（1）创建新文档；（2）修改或编辑内容；（3）处理修订跟踪；（4）添加批注，或执行其他文档任务。”

不要在 YAML frontmatter 中添加其他字段。

正文

编写使用技能及其附带资源的说明。

步骤 5：打包技能

技能开发完成后，必须将其打包成可分发的 .skill 文件，并分享给用户。打包流程会先自动验证技能，确保其符合所有要求：

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

可选的输出目录指定方式：

scripts/package_skill.py <path/to/skill-folder> ./dist

打包脚本将：

1. 验证技能，自动检查：

   • YAML frontmatter 格式和必填字段
   • 技能命名规范和目录结构
   • 描述的完整性和质量
   • 文件组织和资源引用

2. 如果验证通过，则打包技能，创建一个以技能名称命名的 .skill 文件（例如，my-skill.skill），其中包含所有文件，并保留适合分发的目录结构。.skill 文件是扩展名为 .skill 的 zip 文件。

如果验证失败，脚本会报告错误并退出，不会创建打包文件。请修复所有验证错误，然后重新运行打包命令。

步骤 6：迭代

测试技能后，用户可能会要求改进。通常，这种情况会在使用技能后立即发生，此时用户对技能的表现记忆犹新。

迭代工作流：

1. 在实际任务中使用技能
2. 留意遇到的困难或效率低下之处
3. 确定应如何更新 SKILL.md 或附带资源
4. 实施更改并再次测试