mirror of
https://github.com/obra/superpowers.git
synced 2026-04-16 10:29:57 +00:00
fix(writing-skills): correct false 'only two fields' frontmatter claim (#882)
This commit is contained in:
@@ -93,7 +93,7 @@ skills/
|
|||||||
## SKILL.md Structure
|
## SKILL.md Structure
|
||||||
|
|
||||||
**Frontmatter (YAML):**
|
**Frontmatter (YAML):**
|
||||||
- Only two fields supported: `name` and `description`
|
- Two required fields: `name` and `description` (see [agentskills.io/specification](https://agentskills.io/specification) for all supported fields)
|
||||||
- Max 1024 characters total
|
- Max 1024 characters total
|
||||||
- `name`: Use letters, numbers, and hyphens only (no parentheses, special chars)
|
- `name`: Use letters, numbers, and hyphens only (no parentheses, special chars)
|
||||||
- `description`: Third-person, describes ONLY when to use (NOT what it does)
|
- `description`: Third-person, describes ONLY when to use (NOT what it does)
|
||||||
@@ -604,7 +604,7 @@ Deploying untested skills = deploying untested code. It's a violation of quality
|
|||||||
|
|
||||||
**GREEN Phase - Write Minimal Skill:**
|
**GREEN Phase - Write Minimal Skill:**
|
||||||
- [ ] Name uses only letters, numbers, hyphens (no parentheses/special chars)
|
- [ ] Name uses only letters, numbers, hyphens (no parentheses/special chars)
|
||||||
- [ ] YAML frontmatter with only name and description (max 1024 chars)
|
- [ ] YAML frontmatter with required `name` and `description` fields (max 1024 chars; see [spec](https://agentskills.io/specification))
|
||||||
- [ ] Description starts with "Use when..." and includes specific triggers/symptoms
|
- [ ] Description starts with "Use when..." and includes specific triggers/symptoms
|
||||||
- [ ] Description written in third person
|
- [ ] Description written in third person
|
||||||
- [ ] Keywords throughout for search (errors, symptoms, tools)
|
- [ ] Keywords throughout for search (errors, symptoms, tools)
|
||||||
|
|||||||
@@ -144,7 +144,7 @@ What works perfectly for Opus might need more detail for Haiku. If you plan to u
|
|||||||
## Skill structure
|
## Skill structure
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
**YAML Frontmatter**: The SKILL.md frontmatter supports two fields:
|
**YAML Frontmatter**: The SKILL.md frontmatter requires two fields:
|
||||||
|
|
||||||
* `name` - Human-readable name of the Skill (64 characters maximum)
|
* `name` - Human-readable name of the Skill (64 characters maximum)
|
||||||
* `description` - One-line description of what the Skill does and when to use it (1024 characters maximum)
|
* `description` - One-line description of what the Skill does and when to use it (1024 characters maximum)
|
||||||
@@ -1092,7 +1092,7 @@ reader = PdfReader("file.pdf")
|
|||||||
|
|
||||||
### YAML frontmatter requirements
|
### YAML frontmatter requirements
|
||||||
|
|
||||||
The SKILL.md frontmatter includes only `name` (64 characters max) and `description` (1024 characters max) fields. See the [Skills overview](/en/docs/agents-and-tools/agent-skills/overview#skill-structure) for complete structure details.
|
The SKILL.md frontmatter requires `name` (64 characters max) and `description` (1024 characters max) fields. See the [Skills overview](/en/docs/agents-and-tools/agent-skills/overview#skill-structure) for complete structure details.
|
||||||
|
|
||||||
### Token budgets
|
### Token budgets
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user