joyco-studio/skill-writer

Skill Writer

A skill in this repo is a self-contained directory under skills/skills/<name>/ with one entry-point file (SKILL.md) and any number of supporting docs alongside it. The harness loads SKILL.md's frontmatter to decide when to surface the skill; the body is what the agent reads when it triggers.

This skill is for writing those entries well: tight SKILL.md, deep material lifted into siblings.

---

When to use

• The user asks to author a new skill, or to refactor an existing one.
• A SKILL.md is growing past ~250 lines and needs to be split.
• You're about to add a large reference table, threshold list, full template, or worked example to a SKILL.md.

If the user just wants to use an existing skill (e.g. "review this PR" → pr-description-writer), invoke that skill directly. This skill is for authoring.

---

File layout

skills/skills/<name>/
  SKILL.md              # required — entry point and frontmatter
  <topic>.md            # optional — deep reference, templates, examples
  <another-topic>.md

One directory per skill. The directory name matches the skill's name field, kebab-case. Existing examples to model after:

• Lean, single file: skills/skills/webaudio/SKILL.md, skills/skills/lab-experiment/SKILL.md.
• Split into linked docs: skills/skills/trace-audit/ (SKILL.md + detection-heuristics.md + report-format.md), skills/skills/webaudio/ (SKILL.md + writing-effects.md).

---

Frontmatter

Required:

---
name: <kebab-case-id>          # matches directory name
description: >                 # the trigger text — see below
  One paragraph that names the task and lists the verbs/phrases that
  should make Claude reach for this skill.
---

Conventional in this repo:

license: MIT
metadata:
  author: joyco-studio
  version: "0.0.1"

For user-invocable slash commands (the user types /skill-name <args>):

user-invocable: true
argument-hint: <expected-arg-shape>

Writing the description

The description is the only thing the harness sees when deciding whether to load the skill. Treat it as a trigger spec, not marketing copy:

• Lead with the task ("Analyze a Chrome DevTools trace…", "Add sound effects…").
• List the user phrases that should fire it ("triggers on 'isolate this', 'publish to lab', …").
• Mention the libraries / file types / domain terms that imply this skill ("@joycostudio/suno", "SunoProvider", "trace JSON file").
• Say what not to fire on, if there's a near neighbor that gets confused.

Look at lab-experiment for a description heavy on trigger phrases, and webaudio for one heavy on library/domain terms — both work, pick the form that matches how users will reach for the skill.

---

The split rule

Default: write everything in SKILL.md. Split a section into its own sibling .md only when all of these hold:

1. The section is reference material the agent re-reads on demand (a heuristics table, a template, a full worked example, a per-topic deep-dive).
2. It's long enough that inlining it would bury the rest of SKILL.md (rule of thumb: ≥80 lines, or its own table of contents starts to make sense).
3. The skill has a clear "do step N — see <topic>.md" handoff point, so the agent knows when to open it.

Don't split for the sake of it. A 250-line SKILL.md that reads top-to-bottom is better than a 60-line stub that punts every section to a sibling — splitting costs the agent a tool call and fragments the mental model.

For a concrete before/after walkthrough of pulling a section out of a fat SKILL.md, see splitting-example.md.

Linking siblings

From SKILL.md, link with a relative path so editors and previews resolve it:

See [`detection-heuristics.md`](./detection-heuristics.md) for the full pattern list.

In step-by-step workflows, name the file inline at the step that needs it (see trace-audit/SKILL.md — "Refer to detection-heuristics.md for the full set of patterns"). The agent reads the workflow top-to-bottom; tell it exactly when to open the sibling.

---

SKILL.md body shape

There's no rigid template, but the skills that work well share this skeleton:

1. One-line purpose — what this skill does, restated from the description in the agent's voice.
2. When to use / not to use — bulleted, concrete. Helps the agent self-correct.
3. Mental model or prerequisites — the conceptual frame or the env requirements (CLI tools installed, accounts configured) the agent needs before doing anything.
4. The actual instructions — either a numbered workflow (for slash-command-style skills like trace-audit) or topic sections (for guide-style skills like webaudio).
5. Pitfalls / common mistakes — short list of things the agent will get wrong if not warned.
6. Final checklist — the "before you finish" gate. Keep it short; every item should be a real failure mode.

Skip any section that isn't earning its keep. A guide skill might not need a workflow; a workflow skill might not need a mental model.

---

After writing the skill

1. Add a row to the table in /README.md — title links to the new SKILL.md, description is one or two sentences lifted from the frontmatter (not the full paragraph).
2. Verify the directory contains exactly the files you intended (ls skills/skills/<name>/).
3. Read SKILL.md straight through. If your eyes glaze on a section, that's a split candidate (or a delete candidate).

---

Checklist

• [ ] Directory name matches name in frontmatter (kebab-case).
• [ ] Frontmatter has name and description; description lists trigger phrases or domain terms.
• [ ] license, metadata.author, metadata.version set (repo convention).
• [ ] If user-invocable, user-invocable: true and argument-hint present.
• [ ] No deep reference material inlined that should be a sibling .md.
• [ ] Sibling .md files are linked from SKILL.md with a relative path at the step that needs them.
• [ ] README.md table updated.
• [ ] SKILL.md reads cleanly top-to-bottom.