Structure & Organization Criteria

Proper structure enables discovery and maintainability.

Required Directory Layout

.opencode/skills/
└── skill-name/
    ├── SKILL.md          # Required, uppercase
    ├── scripts/          # Optional: executable code
    ├── references/       # Optional: documentation
    └── assets/           # Optional: output resources

SKILL.md Requirements

File name: Exactly SKILL.md (uppercase)

YAML Frontmatter: Required at top

---
name: skill-name  # optional namespace: ck:skill-name
description: Under 200 chars, specific triggers
license: Optional
version: Optional
---

Resource Directories

scripts/

Executable code for deterministic tasks.

scripts/
├── main_operation.py
├── helper_utils.py
├── requirements.txt
├── .env.example
└── tests/
    └── test_main_operation.py

references/

Documentation loaded into context as needed.

references/
├── api-documentation.md
├── schema-definitions.md
└── workflow-guides.md

assets/

Files used in output, not loaded into context.

assets/
├── templates/
├── images/
└── boilerplate/

File Naming

Format: kebab-case, descriptive

Good:

api-endpoints-authentication.md
database-schema-users.md
rotate-pdf-script.py

Bad:

docs.md - not descriptive
apiEndpoints.md - wrong case
1.md - meaningless

Cleanup

After initialization, delete unused example files:

# Remove if not needed
rm -rf scripts/example_script.py
rm -rf references/example_reference.md
rm -rf assets/example_asset.txt

Scope Consolidation

Related topics should be combined into single skill:

Consolidate:

cloudflare + cloudflare-r2 + cloudflare-workers → devops
mongodb + postgresql → databases

Keep separate:

Unrelated domains
Different tech stacks with no overlap

Validation

Run packaging script to check structure:

scripts/package_skill.py <skill-path>

Checks:

SKILL.md exists
Valid frontmatter
Proper directory structure

2.1 KiB Raw Permalink Blame History