Loading...

Back to Details

example-skill

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Example Skill

示例Skill

Purpose

用途

Provide a spec-aligned template for creating consistent, reusable skills.

提供符合规范的模板，用于创建一致、可复用的Skill。

When to use

使用场景

You are adding a new skill to this repository.
You want a starter structure with required sections.

你需要向此仓库中添加新Skill。
你需要一个包含必填章节的初始结构。

Workflow

工作流程

State the objective in one sentence.
Collect only required inputs.
Execute deterministic steps.

Load deeper context only when needed:

```
references/REFERENCE.md
```
```
assets/output-template.md
```
```
agents/openai.yaml
```

Return output in a stable format.
Use
```
scripts/example-check.sh
```
for a deterministic preflight check.

用一句话说明目标。
仅收集必填输入项。
执行确定性步骤。

仅在需要时加载深层上下文：

```
references/REFERENCE.md
```
```
assets/output-template.md
```
```
agents/openai.yaml
```

以稳定格式返回输出。
使用
```
scripts/example-check.sh
```
进行确定性预检查。

Inputs

输入项

Task objective
Constraints
Output destination

任务目标
约束条件
输出目标位置

Outputs

输出项

Primary deliverable
Follow-up checks

主要交付成果
后续检查项

Examples

示例

Build a new skill skeleton with required sections and valid frontmatter.
Refactor an existing skill to move deep details into
```
references/
```
.
Add deterministic checks under
```
scripts/
```
for repeatable verification.

构建包含必填章节和有效前置元数据的新Skill框架。
重构现有Skill，将深层细节迁移至
```
references/
```
目录。
在
```
scripts/
```
目录下添加确定性检查脚本，用于可重复验证。

Edge cases

边缘情况

Missing frontmatter fields: stop and add required fields first.
Invalid
```
name
```
format: normalize to lowercase-hyphen and match directory name.
Broken resource paths: fix links so all referenced files exist.

缺少前置元数据字段：先停止操作并添加必填字段。
无效的
```
name
```
格式：标准化为小写连字符格式，并与目录名匹配。
资源路径损坏：修复链接，确保所有引用文件都存在。

Guardrails

约束规则

Keep instructions concrete and testable.
Avoid unnecessary context loading.
Prefer deterministic commands over manual steps.
Keep file references one level deep from
```
SKILL.md
```
.

保持说明具体且可测试。
避免不必要的上下文加载。
优先使用确定性命令而非手动步骤。
文件引用保持在
```
SKILL.md
```
的一级深度范围内。