skill-creator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Skill Creator

技能创建工具

This skill provides guidance for creating effective skills.
本技能为创建高效技能提供指导。

About Skills

关于技能

Skills are modular, self-contained packages that extend Codex's capabilities by providing specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific domains or tasks—they transform Codex from a general-purpose agent into a specialized agent equipped with procedural knowledge that no model can fully possess.
技能是模块化、独立的软件包,通过提供专业知识、工作流和工具来扩展Codex的能力。可以将它们视为特定领域或任务的「入门指南」——它们能将Codex从通用型Agent转变为具备程序知识的专业型Agent,而这类知识是任何模型都无法完全掌握的。

What Skills Provide

技能能提供什么

  1. Specialized workflows - Multi-step procedures for specific domains
  2. Tool integrations - Instructions for working with specific file formats or APIs
  3. Domain expertise - Company-specific knowledge, schemas, business logic
  4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
  1. 专业工作流 - 针对特定领域的多步骤流程
  2. 工具集成 - 处理特定文件格式或API的操作指南
  3. 领域专业知识 - 公司专属知识、数据结构、业务逻辑
  4. 捆绑资源 - 用于复杂重复任务的脚本、参考资料和资源文件

Core Principles

核心原则

Concise is Key

简洁至上

The context window is a public good. Skills share the context window with everything else Codex needs: system prompt, conversation history, other Skills' metadata, and the actual user request.
Default assumption: Codex is already very smart. Only add context Codex doesn't already have. Challenge each piece of information: "Does Codex really need this explanation?" and "Does this paragraph justify its token cost?"
Prefer concise examples over verbose explanations.
上下文窗口是公共资源。技能需要与Codex所需的其他所有内容共享上下文窗口:系统提示词、对话历史、其他技能的元数据以及实际用户请求。
默认假设:Codex已经非常智能。 只添加Codex原本不具备的上下文信息。对每一条信息都要提出质疑:「Codex真的需要这个解释吗?」以及「这段内容的令牌成本是否值得?」
优先使用简洁示例,而非冗长说明。

Set Appropriate Degrees of Freedom

设置恰当的自由度

Match the level of specificity to the task's fragility and variability:
High freedom (text-based instructions): Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.
Medium freedom (pseudocode or scripts with parameters): Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.
Low freedom (specific scripts, few parameters): Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.
Think of Codex as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).
根据任务的脆弱性和可变性匹配具体程度:
高自由度(基于文本的指令):当多种方法均有效、决策依赖上下文或需要启发式方法指导时使用。
中等自由度(带参数的伪代码或脚本):当存在首选模式、允许一定变化或配置会影响行为时使用。
低自由度(特定脚本,参数极少):当操作脆弱易出错、一致性至关重要或必须遵循特定步骤序列时使用。
可以把Codex比作探索路径的主体:两侧是悬崖的狭窄桥梁需要明确的护栏(低自由度),而开阔的田野则允许多种路线(高自由度)。

Anatomy of a Skill

技能的结构

Every skill consists of a required SKILL.md file and optional bundled resources:
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-name/
├── SKILL.md (required)
│   ├── YAML frontmatter metadata (required)
│   │   ├── name: (required)
│   │   └── description: (required)
│   └── Markdown instructions (required)
└── Bundled Resources (optional)
    ├── scripts/          - 可执行代码(Python/Bash等)
    ├── references/       - 按需加载到上下文的参考文档
    └── assets/           - 输出中使用的文件(模板、图标、字体等)

SKILL.md (required)

SKILL.md(必填)

Every SKILL.md consists of:
  • Frontmatter (YAML): Contains
    name
    and
    description
    fields. These are the only fields that Codex reads to determine when the skill gets used, thus it is very important to be clear and comprehensive in describing what the skill is, and when it should be used.
  • Body (Markdown): Instructions and guidance for using the skill. Only loaded AFTER the skill triggers (if at all).
每个SKILL.md包含:
  • 前置元数据(YAML):包含
    name
    description
    字段。这些是Codex判断何时使用该技能的唯一依据,因此清晰全面地描述技能功能及适用场景至关重要。
  • 主体内容(Markdown):使用技能的指令和指南。仅在技能触发后才会加载(如有需要)。

Bundled Resources (optional)

捆绑资源(可选)

Scripts (
scripts/
)
脚本(
scripts/
Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
  • When to include: When the same code is being rewritten repeatedly or deterministic reliability is needed
  • Example:
    scripts/rotate_pdf.py
    for PDF rotation tasks
  • Benefits: Token efficient, deterministic, may be executed without loading into context
  • Note: Scripts may still need to be read by Codex for patching or environment-specific adjustments
用于需要确定性可靠性或重复编写的任务的可执行代码(Python/Bash等)。
  • 适用场景:当相同代码被重复编写或需要确定性可靠性时
  • 示例:用于PDF旋转任务的
    scripts/rotate_pdf.py
  • 优势:令牌效率高、结果确定,无需加载到上下文即可执行
  • 注意:Codex可能仍需读取脚本以进行补丁或环境特定调整
References (
references/
)
参考资料(
references/
Documentation and reference material intended to be loaded as needed into context to inform Codex's process and thinking.
  • When to include: For documentation that Codex should reference while working
  • Examples:
    references/finance.md
    for financial schemas,
    references/mnda.md
    for company NDA template,
    references/policies.md
    for company policies,
    references/api_docs.md
    for API specifications
  • Use cases: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
  • Benefits: Keeps SKILL.md lean, loaded only when Codex determines it's needed
  • Best practice: If files are large (>10k words), include grep search patterns in SKILL.md
  • Avoid duplication: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
旨在按需加载到上下文中,为Codex的处理过程和思考提供信息的文档和参考材料。
  • 适用场景:用于Codex工作时需要参考的文档
  • 示例:用于财务数据结构的
    references/finance.md
    、用于公司保密协议模板的
    references/mnda.md
    、用于公司政策的
    references/policies.md
    、用于API规范的
    references/api_docs.md
  • 使用案例:数据库结构、API文档、领域知识、公司政策、详细工作流指南
  • 优势:保持SKILL.md精简,仅在Codex判定需要时加载
  • 最佳实践:如果文件过大(>10000字),在SKILL.md中包含grep搜索模式
  • 避免重复:信息应仅存在于SKILL.md或参考文件中,不可同时存在。除非是技能的核心内容,否则优先将详细信息放在参考文件中——这样既能保持SKILL.md精简,又能让信息可被发现且不占用上下文窗口。仅将必要的流程指令和工作流指南保留在SKILL.md中;将详细的参考材料、数据结构和示例移至参考文件。
Assets (
assets/
)
资源文件(
assets/
Files not intended to be loaded into context, but rather used within the output Codex produces.
  • When to include: When the skill needs files that will be used in the final output
  • Examples:
    assets/logo.png
    for brand assets,
    assets/slides.pptx
    for PowerPoint templates,
    assets/frontend-template/
    for HTML/React boilerplate,
    assets/font.ttf
    for typography
  • Use cases: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
  • Benefits: Separates output resources from documentation, enables Codex to use files without loading them into context
无需加载到上下文,而是用于Codex生成的输出中的文件。
  • 适用场景:当技能需要在最终输出中使用文件时
  • 示例:用于品牌资产的
    assets/logo.png
    、用于PPT模板的
    assets/slides.pptx
    、用于HTML/React模板的
    assets/frontend-template/
    、用于字体的
    assets/font.ttf
  • 使用案例:模板、图片、图标、样板代码、字体、可复制或修改的示例文档
  • 优势:将输出资源与文档分离,使Codex无需加载即可使用文件

What to Not Include in a Skill

技能中不应包含的内容

A skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:
  • README.md
  • INSTALLATION_GUIDE.md
  • QUICK_REFERENCE.md
  • CHANGELOG.md
  • etc.
The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxiliary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.
技能应仅包含直接支持其功能的必要文件。请勿创建无关的文档或辅助文件,包括:
  • README.md
  • INSTALLATION_GUIDE.md
  • QUICK_REFERENCE.md
  • CHANGELOG.md
  • 等等
技能应仅包含AI Agent完成当前工作所需的信息。不应包含关于技能创建过程、设置和测试流程、面向用户的文档等辅助上下文。创建额外的文档文件只会增加混乱和干扰。

Progressive Disclosure Design Principle

渐进式披露设计原则

Skills use a three-level loading system to manage context efficiently:
  1. Metadata (name + description) - Always in context (~100 words)
  2. SKILL.md body - When skill triggers (<5k words)
  3. Bundled resources - As needed by Codex (Unlimited because scripts can be executed without reading into context window)
技能采用三级加载系统以高效管理上下文:
  1. 元数据(名称+描述) - 始终处于上下文中(约100词)
  2. SKILL.md主体 - 技能触发时加载(<5000词)
  3. 捆绑资源 - 由Codex按需加载(无限制,因为脚本可在不读取到上下文窗口的情况下执行)

Progressive Disclosure Patterns

渐进式披露模式

Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.
Key principle: When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.
Pattern 1: High-level guide with references
markdown
undefined
将SKILL.md主体内容控制在必要范围内,且不超过500行,以减少上下文膨胀。当接近此限制时,将内容拆分为单独文件。将内容拆分到其他文件时,务必在SKILL.md中引用它们,并明确说明何时读取,以确保技能的使用者知道它们的存在及使用时机。
核心原则:当技能支持多种变体、框架或选项时,仅将核心工作流和选择指南保留在SKILL.md中。将变体特定的细节(模式、示例、配置)移至单独的参考文件中。
模式1:带参考资料的高级指南
markdown
undefined

PDF Processing

PDF处理

Quick start

快速开始

Extract text with pdfplumber: [code example]
使用pdfplumber提取文本: [代码示例]

Advanced features

高级功能

  • Form filling: See FORMS.md for complete guide
  • API reference: See REFERENCE.md for all methods
  • Examples: See EXAMPLES.md for common patterns

Codex loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.

**Pattern 2: Domain-specific organization**

For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:
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)

When a user asks about sales metrics, Codex only reads sales.md.

Similarly, for skills supporting multiple frameworks or variants, organize by variant:
cloud-deploy/ ├── SKILL.md (workflow + provider selection) └── references/ ├── aws.md (AWS deployment patterns) ├── gcp.md (GCP deployment patterns) └── azure.md (Azure deployment patterns)

When the user chooses AWS, Codex only reads aws.md.

**Pattern 3: Conditional details**

Show basic content, link to advanced content:

```markdown
  • 表单填充:完整指南请参阅FORMS.md
  • API参考:所有方法请参阅REFERENCE.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 Processing

DOCX处理

Creating documents

创建文档

Use docx-js for new documents. See DOCX-JS.md.
使用docx-js创建新文档。请参阅DOCX-JS.md

Editing documents

编辑文档

For simple edits, modify the XML directly.
For tracked changes: See REDLINING.md For OOXML details: See OOXML.md

Codex reads REDLINING.md or OOXML.md only when the user needs those features.

**Important guidelines:**

- **Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
- **Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so Codex can see the full scope when previewing.
对于简单编辑,直接修改XML即可。
如需跟踪更改:请参阅REDLINING.md 如需OOXML细节:请参阅OOXML.md

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

**重要指南**:

- **避免深层嵌套参考** - 参考文件应直接从SKILL.md链接,保持一级深度。
- **结构化长参考文件** - 对于超过100行的文件,在顶部添加目录,以便Codex预览时能看到完整范围。

Skill Creation Process

技能创建流程

Skill creation involves these steps:
  1. Understand the skill with concrete examples
  2. Plan reusable skill contents (scripts, references, assets)
  3. Initialize the skill (run init_skill.py)
  4. Edit the skill (implement resources and write SKILL.md)
  5. Package the skill (run package_skill.py)
  6. Iterate based on real usage
Follow these steps in order, skipping only if there is a clear reason why they are not applicable.
技能创建包含以下步骤:
  1. 通过具体示例理解技能需求
  2. 规划可复用的技能内容(脚本、参考资料、资源文件)
  3. 初始化技能(运行init_skill.py)
  4. 编辑技能(实现资源并编写SKILL.md)
  5. 打包技能(运行package_skill.py)
  6. 根据实际使用情况迭代优化
按顺序执行这些步骤,仅在有明确理由时才可跳过。

Skill Naming

技能命名规则

  • Use lowercase letters, digits, and hyphens only; normalize user-provided titles to hyphen-case (e.g., "Plan Mode" ->
    plan-mode
    ).
  • When generating names, generate a name under 64 characters (letters, digits, hyphens).
  • Prefer short, verb-led phrases that describe the action.
  • Namespace by tool when it improves clarity or triggering (e.g.,
    gh-address-comments
    ,
    linear-address-issue
    ).
  • Name the skill folder exactly after the skill name.
  • 仅使用小写字母、数字和连字符;将用户提供的标题标准化为连字符分隔格式(例如:"Plan Mode" ->
    plan-mode
    )。
  • 生成名称时,长度不超过64个字符(字母、数字、连字符)。
  • 优先使用简短、以动词开头的短语来描述操作。
  • 当有助于提高清晰度或触发准确性时,按工具命名空间(例如:
    gh-address-comments
    linear-address-issue
    )。
  • 技能文件夹名称必须与技能名称完全一致。

Step 1: Understanding the Skill with Concrete Examples

步骤1:通过具体示例理解技能需求

Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
For example, when building an image-editor skill, relevant questions include:
  • "What functionality should the image-editor skill support? Editing, rotating, anything else?"
  • "Can you give some examples of how this skill would be used?"
  • "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
  • "What would a user say that should trigger this skill?"
To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
Conclude this step when there is a clear sense of the functionality the skill should support.
仅当技能的使用模式已完全明确时才可跳过此步骤。即使处理现有技能,此步骤仍有价值。
要创建有效的技能,需清晰理解技能的具体使用示例。这种理解可来自直接的用户示例,或经用户反馈验证的生成示例。
例如,构建图像编辑器技能时,相关问题包括:
  • "图像编辑器技能应支持哪些功能?编辑、旋转,还是其他?"
  • "能否举例说明该技能的使用场景?"
  • "我能想象用户会要求‘去除这张图片的红眼’或‘旋转这张图片’。你认为还有其他使用场景吗?"
  • "用户说什么话应该触发这个技能?"
为避免给用户造成负担,请勿在一条消息中提出过多问题。先从最重要的问题开始,必要时再跟进以提高效果。
当明确了解技能应支持的功能时,此步骤结束。

Step 2: Planning the Reusable Skill Contents

步骤2:规划可复用的技能内容

To turn concrete examples into an effective skill, analyze each example by:
  1. Considering how to execute on the example from scratch
  2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
Example: When building a
pdf-editor
skill to handle queries like "Help me rotate this PDF," the analysis shows:
  1. Rotating a PDF requires re-writing the same code each time
  2. A
    scripts/rotate_pdf.py
    script would be helpful to store in the skill
Example: When designing a
frontend-webapp-builder
skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
  1. Writing a frontend webapp requires the same boilerplate HTML/React each time
  2. An
    assets/hello-world/
    template containing the boilerplate HTML/React project files would be helpful to store in the skill
Example: When building a
big-query
skill to handle queries like "How many users have logged in today?" the analysis shows:
  1. Querying BigQuery requires re-discovering the table schemas and relationships each time
  2. A
    references/schema.md
    file documenting the table schemas would be helpful to store in the skill
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
要将具体示例转化为有效的技能,需通过以下方式分析每个示例:
  1. 考虑如何从头开始执行该示例
  2. 确定哪些脚本、参考资料和资源文件对重复执行这些工作流有帮助
示例:构建处理「帮我旋转这个PDF」等查询的
pdf-editor
技能时,分析显示:
  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
    文件会很有帮助
要确定技能内容,需分析每个具体示例,创建要包含的可复用资源列表:脚本、参考资料和资源文件。

Step 3: Initializing the Skill

步骤3:初始化技能

At this point, it is time to actually create the skill.
Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
When creating a new skill from scratch, always run the
init_skill.py
script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
Usage:
bash
scripts/init_skill.py <skill-name> --path <output-directory> [--resources scripts,references,assets] [--examples]
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
The script:
  • Creates the skill directory at the specified path
  • Generates a SKILL.md template with proper frontmatter and TODO placeholders
  • Optionally creates resource directories based on
    --resources
  • Optionally adds example files when
    --examples
    is set
After initialization, customize the SKILL.md and add resources as needed. If you used
--examples
, replace or delete placeholder files.
此时即可实际创建技能。
仅当开发的技能已存在且需要迭代或打包时才可跳过此步骤。这种情况下,直接进入下一步。
从头创建新技能时,务必运行
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
该脚本:
  • 在指定路径创建技能目录
  • 生成带有正确前置元数据和待办事项占位符的SKILL.md模板
  • 可选地根据
    --resources
    参数创建资源目录
  • 当设置
    --examples
    时,可选地添加示例文件
初始化完成后,自定义SKILL.md并添加所需资源。如果使用了
--examples
,请替换或删除占位符文件。

Step 4: Edit the Skill

步骤4:编辑技能

When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Codex to use. Include information that would be beneficial and non-obvious to Codex. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Codex instance execute these tasks more effectively.
编辑(新生成或现有)技能时,请记住该技能是为另一个Codex实例使用而创建的。包含对Codex有益且非显而易见的信息。考虑哪些流程知识、领域特定细节或可复用资源能帮助另一个Codex实例更有效地执行这些任务。

Learn Proven Design Patterns

学习已验证的设计模式

Consult these helpful guides based on your skill's needs:
  • Multi-step processes: See references/workflows.md for sequential workflows and conditional logic
  • Specific output formats or quality standards: See references/output-patterns.md for template and example patterns
These files contain established best practices for effective skill design.
根据技能需求参考以下有用指南:
  • 多步骤流程:请参阅references/workflows.md了解顺序工作流和条件逻辑
  • 特定输出格式或质量标准:请参阅references/output-patterns.md了解模板和示例模式
这些文件包含有效技能设计的既定最佳实践。

Start with Reusable Skill Contents

从可复用技能内容开始

To begin implementation, start with the reusable resources identified above:
scripts/
,
references/
, and
assets/
files. Note that this step may require user input. For example, when implementing a
brand-guidelines
skill, the user may need to provide brand assets or templates to store in
assets/
, or documentation to store in
references/
.
Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.
If you used
--examples
, delete any placeholder files that are not needed for the skill. Only create resource directories that are actually required.
开始实现时,先处理之前确定的可复用资源:
scripts/
references/
assets/
文件。请注意,此步骤可能需要用户输入。例如,构建
brand-guidelines
技能时,用户可能需要提供品牌资产或模板以存储在
assets/
中,或提供文档以存储在
references/
中。
添加的脚本必须实际运行测试,以确保没有错误且输出符合预期。如果有许多类似脚本,只需测试代表性样本即可,在确保所有脚本正常工作的同时平衡完成时间。
如果使用了
--examples
,请删除技能不需要的占位符文件。仅创建实际需要的资源目录。

Update SKILL.md

更新SKILL.md

Writing Guidelines: Always use imperative/infinitive form.
写作指南:始终使用祈使语气/不定式形式。
Frontmatter
前置元数据
Write the YAML frontmatter with
name
and
description
:
  • name
    : The skill name
  • description
    : This is the primary triggering mechanism for your skill, and helps Codex understand when to use the skill.
    • Include both what the Skill does and specific triggers/contexts for when to use it.
    • Include all "when to use" information here - Not in the body. The body is only loaded after triggering, so "When to Use This Skill" sections in the body are not helpful to Codex.
    • Example description for a
      docx
      skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when Codex needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"
Do not include any other fields in YAML frontmatter.
编写包含
name
description
的YAML前置元数据:
  • name
    :技能名称
  • description
    :这是技能的主要触发机制,帮助Codex理解何时使用该技能。
    • 同时包含技能功能和使用该技能的特定触发条件/上下文。
    • 所有「何时使用」的信息都应放在这里——不要放在主体内容中。主体内容仅在触发后才会加载,因此主体内容中的「何时使用本技能」部分对Codex没有帮助。
    • 示例:
      docx
      技能的描述:「全面的文档创建、编辑和分析,支持跟踪更改、批注、格式保留和文本提取。当Codex需要处理专业文档(.docx文件)时使用,包括:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理跟踪更改,(4) 添加批注,或任何其他文档任务」
请勿在YAML前置元数据中包含任何其他字段。
Body
主体内容
Write instructions for using the skill and its bundled resources.
编写使用技能及其捆绑资源的指令。

Step 5: Packaging a Skill

步骤5:打包技能

Once development of the skill is complete, it must be packaged into a distributable .skill file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
bash
scripts/package_skill.py <path/to/skill-folder>
Optional output directory specification:
bash
scripts/package_skill.py <path/to/skill-folder> ./dist
The packaging script will:
  1. Validate the skill automatically, checking:
    • YAML frontmatter format and required fields
    • Skill naming conventions and directory structure
    • Description completeness and quality
    • File organization and resource references
  2. Package the skill if validation passes, creating a .skill file named after the skill (e.g.,
    my-skill.skill
    ) that includes all files and maintains the proper directory structure for distribution. The .skill file is a zip file with a .skill extension.
    Security restriction: symlinks are rejected and packaging fails when any symlink is present.
If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
技能开发完成后,必须将其打包为可分发的.skill文件与用户共享。打包过程会自动先验证技能,确保其符合所有要求:
bash
scripts/package_skill.py <path/to/skill-folder>
可选输出目录指定:
bash
scripts/package_skill.py <path/to/skill-folder> ./dist
打包脚本将:
  1. 验证:自动验证技能,检查:
    • YAML前置元数据格式和必填字段
    • 技能命名规则和目录结构
    • 描述的完整性和质量
    • 文件组织和资源引用
  2. 打包:如果验证通过,创建以技能名称命名的.skill文件(例如:
    my-skill.skill
    ),包含所有文件并保持分发所需的正确目录结构。.skill文件是扩展名为.skill的zip文件。
    安全限制:如果存在任何符号链接,打包将失败并拒绝。
如果验证失败,脚本将报告错误并退出,不创建包。修复所有验证错误后,重新运行打包命令。

Step 6: Iterate

步骤6:迭代优化

After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
Iteration workflow:
  1. Use the skill on real tasks
  2. Notice struggles or inefficiencies
  3. Identify how SKILL.md or bundled resources should be updated
  4. Implement changes and test again
测试技能后,用户可能会提出改进请求。通常这会在使用技能后立即发生,此时用户对技能的表现有清晰的上下文认知。
迭代工作流
  1. 在实际任务中使用技能
  2. 注意遇到的困难或低效之处
  3. 确定应如何更新SKILL.md或捆绑资源
  4. 实施更改并再次测试