agentleFS
tikalktikalk/adlc-team-skills/skills/authoring/writing-skills/SKILL.md

writing-skills

Skill145 starsChanged 21 days agoMITView on GitHub

Use when creating a new skill, editing an existing skill, or verifying skills work before deployment

191 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use chinese-code-review, chinese-commit-conventions and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • Leodorareluctant259Skill

    chinese-code-review

    中文代码审查规范——在保持专业严谨的同时,用符合国内团队文化的方式给出有效反馈

    Also in 8 projects that use this

  • Leodorareluctant259Skill

    chinese-commit-conventions

    中文 Git 提交规范 — 适配国内团队的 commit message 规范和 changelog 自动化

    Also in 8 projects that use this

  • obraSkill

    diagnosing-superpowers

    Use when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness.

    Also in 20 projects that use this

  • kntismSkill

    condition-based-waiting

    Use when tests have race conditions, timing dependencies, or inconsistent pass/fail behavior - replaces arbitrary timeouts with condition polling to wait for actual state changes, eliminating flaky tests from timing guesses

    Also in 3 projects that use this

  • aaddrickSkill

    writing-agents

    Use when creating new agents, editing existing agents, or defining specialized subagent roles for the Task tool

    Also in 3 projects that use this

  • frankxaiSkill

    defense-in-depth

    Use when invalid data causes failures deep in execution, requiring validation at multiple system layers - validates at every layer data passes through to make bugs structurally impossible

    Also in 3 projects that use this

  • +3 more from Leodorareluctant259

The file

We split this skill into the rules it gives an agent

9 rules. 2 are common, 6 are distinctive, and 1 is very specific to this project.

  • 2

    Common

    Most of the 180 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Common:

    Core principle: if you didn't watch an agent fail without the skill, you don't know whether the skill teaches the right thing — or anything …

    line 16
  2. Common:

    Write the skill before testing it?

    line 27
  3. Distinctive:

    Run the scenario WITHOUT the skill loaded.

    line 45
  4. Distinctive:

    If the agent already behaves correctly without the skill, stop — there is nothing to fix.

    line 52
  5. Very specific:

    Start from the template (templates/SKILL-template.md in this directory).

    line 58
  6. Distinctive:

    Run the same scenario WITH the skill.

    line 61
  7. Distinctive:

    Start with "Use when…" and name concrete symptoms and situations

    line 110
  8. Distinctive:

    Before writing guidance, classify the baseline failure.

    line 118
  9. Distinctive:

    No nuance clauses either way: "don't X unless it matters" reopens negotiation.

    line 128

“Common” is measured: kept by at least 6 in 10 of the 180 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Writing Skills

Overview

Writing skills IS Test-Driven Development applied to process documentation.

A skill is behavior-shaping code, not prose. You write a failing test (a pressure scenario an agent gets wrong without the skill), watch it fail, write the minimal skill that fixes it, watch it pass, then close loopholes.

Core principle: if you didn't watch an agent fail without the skill, you don't know whether the skill teaches the right thing — or anything at all.

The Iron Law:

NO SKILL WITHOUT A FAILING BASELINE FIRST

This applies to new skills AND to edits of existing skills. "Simple addition", "just a section", "docs update" — all the same violation. Write the skill before testing it? Delete it and start over.

When to Use

  • Creating a new skill for this repo (also read CONTRIBUTING.md — new skills must be agreed in an issue first and ship with eval coverage)
  • Editing any skills/**/SKILL.md content
  • Reviewing a PR that changes skill content

When NOT to use: for project-specific conventions (those go in the team-ai-directives repo as CDRs), or for mechanical constraints a script or test can enforce — automate those, save documentation for judgment calls.

Core Process

RED — Baseline the failure

Run the scenario WITHOUT the skill loaded. Document verbatim:

  • What the agent actually did
  • The exact rationalizations it used to skip the correct behavior
  • Which pressures triggered the failure (time, sunk cost, authority, "it works either way")

If the agent already behaves correctly without the skill, stop — there is nothing to fix. A skill that enforces behavior that comes for free is context noise (this repo exists to fight context noise, not add to it).

GREEN — Write the minimal skill

Start from the template (templates/SKILL-template.md in this directory). Address only the failures you observed in RED — not hypothetical ones.

Run the same scenario WITH the skill. The agent should now comply.

REFACTOR — Close the loopholes

New rationalization found? Add an explicit counter, re-test. Loop until bulletproof under pressure.

Micro-test wording before full scenarios

Full pressure runs are slow. Verify wording cheaply first: one fresh API/subagent call per sample, 5+ reps per variant, always including a no-guidance control. If the control doesn't exhibit the failure, there is nothing to fix. Read every flagged match manually — automated counts overstate both failure and success.

Structure Rules (this repo)

RuleWhy
Exactly 2 levels deep: skills/<domain>/<skill>/SKILL.mdEnforced by test_skill_directory_depth; resolves the skills CLI depth limit
Frontmatter: name + description required (≤1024 chars total)Enforced by test_skill_description_presence_and_length
Optional scripts: (sh:/ps:) and disable-model-invocation: trueMark skills that must not be model-invoked
Description = trigger onlySee below — the single most common way skills silently break
Headings: Overview → When to Use → Core Process → Red Flags → VerificationCanonical shape; Configuration only if the skill has knobs
Token budget: aim <500 lines for the SKILL.md body (enforced: warn >500, fail >800 — see test_skill_token_budget)Heavy reference → references/; scripts → scripts/{bash,powershell}/
New skills ship with eval coverageGoldset criterion + binary grader ({"pass": bool, "score": 1.0|0.0}) — see evals/promptfoo/

Skill Discovery Optimization (SDO)

The description is the trigger surface: factory-mission hands every skill's name+description to its subagents, and the model decides what to load from that list.

Description = when to use. NEVER what the skill does.

Measured failure mode (see superpowers' writing-skills, which this skill adapts): when a description summarizes the workflow, agents follow the description instead of reading the skill body — a description saying "code review between tasks" produced one review where the skill's flowchart clearly required two.

# BAD: workflow summary — agents will follow this shortcut
description: Bootstraps the session by injecting the team context index and pulls rules on demand

# GOOD: trigger only
description: Use when a session starts and the team AI directives context is not yet loaded
  • Start with "Use when…" and name concrete symptoms and situations
  • Third person (it is injected into prompts)
  • Keywords an agent would search for: error messages, symptoms, tool names
  • Skills with disable-model-invocation: true are exempt (not routed by the model) but must still not mislead

Match the Form to the Failure

Before writing guidance, classify the baseline failure. The form that bulletproofs one failure type backfires on another.

Baseline failureRight formWrong form
Skips a rule under pressure (knows better, does it anyway)Prohibition + rationalization table + red flagsSoft guidance ("prefer…", "consider…")
Output has the wrong shape (bloated, buried verdict)Positive recipe: state what the output IS, its parts in orderProhibition list ("don't restate", "never narrate")
Omits a required elementStructural: a REQUIRED slot in the templateProse reminders near the template
Behavior depends on a conditionConditional on an observable predicateUnconditional rule + exemption clauses

No nuance clauses either way: "don't X unless it matters" reopens negotiation; a single nuance clause on a winning recipe degrades it.

Bulletproofing Discipline Skills

For rule-enforcing skills, close every loophole explicitly: forbid the specific workarounds ("don't keep it as reference — delete means delete"), add the foundational principle early ("violating the letter of the rules is violating the spirit"), build the rationalization table from your RED transcript, and list Red Flags the agent can self-check against.

Red Flags

  • Skill written before the baseline run — delete and start over
  • Description summarizes what the skill does instead of when to use it
  • "The agent will obviously do the right thing" — that's what RED is for
  • Skill grew past ~500 lines and everything is inline instead of references/
  • New skill shipped without its eval criterion + grader
  • Hypothetical failure modes addressed but observed ones missing

All of these mean: stop, re-run the baseline, fix the skill.

Verification

A skill change is done when ALL of these are true:

  • Baseline scenario run WITHOUT the skill; verbatim failures recorded
  • Same scenario passes WITH the skill
  • pytest tests/unit/test_playbook_integrity.py -q green (depth, frontmatter, description rules)
  • Eval criterion + binary grader added, and the grader has a unit test (evals/promptfoo/tests/)
  • Regenerated install artifacts are in sync: pytest tests/unit/test_generated_artifacts_sync.py -q
  • Manual acceptance check in a real agent (CONTRIBUTING "Manual testing") — skill triggers when it should, stays silent when it shouldn't

References

  • templates/SKILL-template.md — starting point for a new skill
  • references/skill-testing.md — pressure scenarios, pressure types, micro-testing methodology
  • CONTRIBUTING.md — PR process, eval coverage requirement, manual test protocol

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.