Skip to content

Commit d55105d

Browse files
docs: rename skill-creator references to examples directory
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
1 parent da70a4d commit d55105d

3 files changed

Lines changed: 19 additions & 19 deletions

File tree

.agent/skills/skill-creator/SKILL.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ equipped with procedural knowledge that no model can fully possess.
1919
1. Specialized workflows - Multi-step procedures for specific domains
2020
2. Tool integrations - Instructions for working with specific file formats or APIs
2121
3. Domain expertise - Company-specific knowledge, schemas, business logic
22-
4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
22+
4. Bundled resources - Scripts, examples, and assets for complex and repetitive tasks
2323

2424
## Core Principles
2525

@@ -56,7 +56,7 @@ skill-name/
5656
│ └── Markdown instructions (required)
5757
└── Bundled Resources (optional)
5858
├── scripts/ - Executable code (Python/Bash/etc.)
59-
├── references/ - Documentation intended to be loaded into context as needed
59+
├── examples/ - Documentation intended to be loaded into context as needed
6060
└── assets/ - Files used in output (templates, icons, fonts, etc.)
6161
```
6262

@@ -78,16 +78,16 @@ Executable code (Python/Bash/etc.) for tasks that require deterministic reliabil
7878
- **Benefits**: Token efficient, deterministic, may be executed without loading into context
7979
- **Note**: Scripts may still need to be read by Agent for patching or environment-specific adjustments
8080

81-
##### References (`references/`)
81+
##### Examples (`examples/`)
8282

8383
Documentation and reference material intended to be loaded as needed into context to inform Agent's process and thinking.
8484

8585
- **When to include**: For documentation that Agent should reference while working
86-
- **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
86+
- **Examples**: `examples/finance.md` for financial schemas, `examples/mnda.md` for company NDA template, `examples/policies.md` for company policies, `examples/api_docs.md` for API specifications
8787
- **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
8888
- **Benefits**: Keeps SKILL.md lean, loaded only when Agent determines it's needed
8989
- **Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
90-
- **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.
90+
- **Avoid duplication**: Information should live in either SKILL.md or examples files, not both. Prefer examples 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 examples files.
9191

9292
##### Assets (`assets/`)
9393

@@ -124,7 +124,7 @@ Keep SKILL.md body to the essentials and under 500 lines to minimize context blo
124124

125125
**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.
126126

127-
**Pattern 1: High-level guide with references**
127+
**Pattern 1: High-level guide with examples**
128128

129129
```markdown
130130
# PDF Processing
@@ -150,7 +150,7 @@ For Skills with multiple domains, organize content by domain to avoid loading ir
150150
```
151151
bigquery-skill/
152152
├── SKILL.md (overview and navigation)
153-
└── reference/
153+
└── examples/
154154
├── finance.md (revenue, billing metrics)
155155
├── sales.md (opportunities, pipeline)
156156
├── product.md (API usage, features)
@@ -164,7 +164,7 @@ Similarly, for skills supporting multiple frameworks or variants, organize by va
164164
```
165165
cloud-deploy/
166166
├── SKILL.md (workflow + provider selection)
167-
└── references/
167+
└── examples/
168168
├── aws.md (AWS deployment patterns)
169169
├── gcp.md (GCP deployment patterns)
170170
└── azure.md (Azure deployment patterns)
@@ -195,15 +195,15 @@ Agent reads REDLINING.md or OOXML.md only when the user needs those features.
195195

196196
**Important guidelines:**
197197

198-
- **Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
198+
- **Avoid deeply nested examples** - Keep examples one level deep from SKILL.md. All reference files should link directly from SKILL.md.
199199
- **Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so Agent can see the full scope when previewing.
200200

201201
## Skill Creation Process
202202

203203
Skill creation involves these steps:
204204

205205
1. Understand the skill with concrete examples
206-
2. Plan reusable skill contents (scripts, references, assets)
206+
2. Plan reusable skill contents (scripts, examples, assets)
207207
3. Initialize the skill (run init_skill.py)
208208
4. Edit the skill (implement resources and write SKILL.md)
209209
5. Package the skill (run package_skill.py)
@@ -233,7 +233,7 @@ Conclude this step when there is a clear sense of the functionality the skill sh
233233
To turn concrete examples into an effective skill, analyze each example by:
234234

235235
1. Considering how to execute on the example from scratch
236-
2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
236+
2. Identifying what scripts, examples, and assets would be helpful when executing these workflows repeatedly
237237

238238
Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
239239

@@ -248,9 +248,9 @@ Example: When designing a `frontend-webapp-builder` skill for queries like "Buil
248248
Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
249249

250250
1. Querying BigQuery requires re-discovering the table schemas and relationships each time
251-
2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
251+
2. A `examples/schema.md` file documenting the table schemas would be helpful to store in the skill
252252

253-
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
253+
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, examples, and assets.
254254

255255
### Step 3: Initializing the Skill
256256

@@ -270,7 +270,7 @@ The script:
270270

271271
- Creates the skill directory at the specified path
272272
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
273-
- Creates example resource directories: `scripts/`, `references/`, and `assets/`
273+
- Creates example resource directories: `scripts/`, `examples/`, and `assets/`
274274
- Adds example files in each directory that can be customized or deleted
275275

276276
After initialization, customize or remove the generated SKILL.md and example files as needed.
@@ -283,18 +283,18 @@ When editing the (newly-generated or existing) skill, remember that the skill is
283283

284284
Consult these helpful guides based on your skill's needs:
285285

286-
- **Multi-step processes**: See references/workflows.md for sequential workflows and conditional logic
287-
- **Specific output formats or quality standards**: See references/output-patterns.md for template and example patterns
286+
- **Multi-step processes**: See examples/workflows.md for sequential workflows and conditional logic
287+
- **Specific output formats or quality standards**: See examples/output-patterns.md for template and example patterns
288288

289289
These files contain established best practices for effective skill design.
290290

291291
#### Start with Reusable Skill Contents
292292

293-
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/`.
293+
To begin implementation, start with the reusable resources identified above: `scripts/`, `examples/`, 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 `examples/`.
294294

295295
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.
296296

297-
Any example files and directories not needed for the skill should be deleted. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
297+
Any example files and directories not needed for the skill should be deleted. The initialization script creates example files in `scripts/`, `examples/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
298298

299299
#### Update SKILL.md
300300

@@ -337,7 +337,7 @@ The packaging script will:
337337
- YAML frontmatter format and required fields
338338
- Skill naming conventions and directory structure
339339
- Description completeness and quality
340-
- File organization and resource references
340+
- File organization and resource examples
341341

342342
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.
343343

.agent/skills/skill-creator/references/output-patterns.md renamed to .agent/skills/skill-creator/examples/output-patterns.md

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)