src/bx_skills/catalog_skills/bx-skill-writer/SKILL.md
Use when creating new skills, editing existing skills, structuring SKILL.md files, writing skill frontmatter, testing skills with subagents, deploying skills, or verifying skills work before deployment
npx skillsauth add bitranox/bx_skills bx-skill-writerInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Writing skills IS Test-Driven Development applied to process documentation.
Personal skills live in agent-specific directories (~/.claude/skills for Claude Code, ~/.agents/skills/ for Codex)
if there is a skill in the current directory, work on AND test THAT skill, not ~/.claude/skills or ~/.agents/skills/
You write test cases (pressure scenarios with subagents), watch them fail (baseline behavior), write the skill (documentation), watch tests pass (agents comply), and refactor (close loopholes).
Core principle: If you didn't watch an agent fail without the skill, you don't know if the skill teaches the right thing.
REQUIRED BACKGROUND: You MUST understand superpowers:test-driven-development before using this skill. That skill defines the fundamental RED-GREEN-REFACTOR cycle. This skill adapts TDD to documentation.
Official guidance: For Anthropic's official skill authoring best practices, see anthropic-best-practices.md. This document provides additional patterns and guidelines that complement the TDD-focused approach in this skill.
| Topic | File | |----------------------------------------------------------------------------|----------------------------------| | Testing methodology — pressure scenarios, RED/GREEN/REFACTOR, meta-testing | testing-skills-with-subagents.md | | Persuasion principles — authority, commitment, scarcity, social proof | persuasion-principles.md | | Anthropic official best practices — conciseness, freedom, structure | anthropic-best-practices.md | | Graphviz conventions — node shapes, edge labels, naming patterns | graphviz-conventions.dot | | Flowchart rendering — SVG output from dot diagrams | render-graphs.js | | Worked example — full test campaign testing CLAUDE.md variants | examples/CLAUDE_MD_TESTING.md |
Use the Read tool to load referenced files identified as relevant for full details.
A skill is a reference guide for proven techniques, patterns, or tools. Skills help future Claude instances find and apply effective approaches.
Skills are: Reusable techniques, patterns, tools, reference guides
Skills are NOT: Narratives about how you solved a problem once
| TDD Concept | Skill Creation | |-------------------------|--------------------------------------------------| | Test case | Pressure scenario with subagent | | Production code | Skill document (SKILL.md) | | Test fails (RED) | Agent violates rule without skill (baseline) | | Test passes (GREEN) | Agent complies with skill present | | Refactor | Close loopholes while maintaining compliance | | Write test first | Run baseline scenario BEFORE writing skill | | Watch it fail | Document exact rationalizations agent uses | | Minimal code | Write skill addressing those specific violations | | Watch it pass | Verify agent now complies | | Refactor cycle | Find new rationalizations → plug → re-verify |
The entire skill creation process follows RED-GREEN-REFACTOR.
Create when:
Don't create for:
Concrete method with steps to follow (condition-based-waiting, root-cause-tracing)
Way of thinking about problems (flatten-with-flags, test-invariants)
API docs, syntax guides, tool documentation (office docs)
skills/
skill-name/
SKILL.md # Main reference (required)
supporting-file.* # Only if needed
Flat namespace - all skills in one searchable namespace
Separate files for:
Keep inline:
Hub skills with supporting files: When SKILL.md is an index that points to separate reference files, add an explicit instruction in the body (not frontmatter) telling Claude to use the Read tool. This prevents Claude from trying to answer from summary tables alone instead of loading the detailed file.
Use the Read tool to load referenced files identified as relevant for full details.
Only add this for hub/reference skills with supporting files. Self-contained skills (where everything is in SKILL.md) don't need it — the full body is already loaded when invoked.
Upstream doc linking: When hub skills consolidate content from original source documents in subdirectories (e.g., docs/, tutorial/, api/), include a two-tier routing table in SKILL.md:
Don't rely on passive > Source: annotations in supporting files — agents treat these as attribution, not as actionable links. The hub must provide an explicit routing table for upstream docs.
## Reference Files
| Topic | Distilled reference | Upstream source (full detail) |
|-------------------------------------------------|---------------------|------------------------------------|
| Core API — Client, Session, request(), stream() | api-reference.md | docs/api/full-reference.md |
| Config — Settings, env vars, pyproject section | configuration.md | docs/guides/configuration.md |
| Tutorials — quickstart, first app, deployment | quick-start.md | tutorial/getting-started/README.md |
Use the Read tool to load a distilled reference first.
If it lacks the detail you need, load the upstream source.
The upstream table should work as a comprehensive index so an agent can jump straight to the right file for any specific class, function, or method. Each row needs to list the concrete API symbols the file covers, not just a prose summary.
| Topic | Upstream source |
|--------------------------------------------------------|-----------------|
| ❌ Widgets | docs/widgets.md |
| ✅ Widgets — DataTable, Tree, OptionList, Select, Input | docs/widgets.md |
Building routing tables: For each supporting file, use grep -E '^#{2,3} ' filename.md to extract H2/H3 headings. For tier 1 (distilled reference) rows, list the 3-5 most important headings, class names, or function names as the topic description. If a file covers more than 5 key terms, pick the ones an agent is most likely to search for and add an "etc." or "and more" suffix. For tier 2 (upstream source) rows, list all classes, functions, API endpoints, and key concepts — the upstream column serves as a comprehensive index, so every symbol must be findable through the topic description.
Evaluating routing descriptions: For each row in a routing table, ask: given a realistic user query, could Claude pick the right file from the topic description alone? If two rows sound equally plausible for the same query, the descriptions need more differentiation.
Common failures:
Fix: expand topic descriptions to include 2-3 disambiguating subtopics or keywords.
| Topic | Distilled reference |
|----------------------------------------------|---------------------|
| ❌ API | api-reference.md |
| ❌ Config | configuration.md |
| ✅ Core API — endpoints, auth, rate limits | api-reference.md |
| ✅ Config — env vars, CLI flags, config files | configuration.md |
Verifying routing tables: After writing a routing table, run two checks to confirm it is both complete and accurate. For two-tier tables, run both checks independently for the distilled reference column and the upstream source column:
grep -E '^#{2,3} ' filename.md to extract its headings. For each heading or key term, confirm it appears in the routing table's topic description for that file. Missing terms = content agents can't find through the table.grep -i "term" filename.md to confirm the file actually contains it. Mismatches = stale entries that route agents to the wrong file.A routing table passes when every key term in the file appears in the table (coverage) and every term in the table appears in the file (accuracy). For tier 1 rows with 10+ headings, coverage is sufficient if the top 5 most-queried terms are represented. For tier 2 rows, coverage requires all classes, functions, and API endpoints — no "top 5" shortcut. Both columns must pass independently.
Example:
Referenced file `widgets.md` contains headings: DataTable, Tree, Select, Input, OptionList
✅ Coverage check passes — routing table says:
| Widgets — DataTable, Tree, OptionList, Select, Input | widgets.md |
❌ Coverage check fails — routing table says:
| Widgets | widgets.md |
(agent searching for "DataTable" won't find the right file)
✅ Accuracy check passes — grep widgets.md for "DataTable" → found
❌ Accuracy check fails — routing table lists "TreeView" but file only contains "Tree"
Tier 2 example (upstream source column):
Routing table row:
| Core API — Client, Session, request(), stream() | api-reference.md | docs/api/full-reference.md |
Upstream file `docs/api/full-reference.md` contains headings: Client, Session, request, stream, Connection, Retry
❌ Tier 2 coverage check fails — topic lists 4 of 6 symbols; missing Connection and Retry → add them to topic description
❌ Tier 2 accuracy check fails — topic lists "stream()" but upstream file heading is "Streaming" → fix topic or confirm alias
Fixed topic: Core API — Client, Session, request(), Streaming, Connection, Retry
Presence gate: Before checking coverage and accuracy, first confirm a tier 2 table exists at all. Run find <upstream-dirs> -name '*.md' to list all upstream files. If any exist but the routing table has no tier 2 (upstream source) column, the skill is incomplete — add the column and populate it before proceeding with coverage/accuracy checks.
Frontmatter (YAML):
name and description (custom fields are stripped by Claude Code)name: Use letters, numbers, and hyphens only (no parentheses, special chars)description: Third-person, describes ONLY when to use (NOT what it does)
---
name: Skill-Name-With-Hyphens
description: Use when [specific triggering conditions and symptoms]
---
# Skill Name
## Overview
What is this? Core principle in 1-2 sentences.
## When to Use
[Small inline flowchart IF decision non-obvious]
Bullet list with SYMPTOMS and use cases
When NOT to use
## Core Pattern (for techniques/patterns)
Before/after code comparison
## Quick Reference
Table or bullets for scanning common operations
## Implementation
Inline code for simple patterns
Link to file for heavy reference or reusable tools
## Common Mistakes
What goes wrong + fixes
## Real-World Impact (optional)
Concrete results
Critical for discovery: Future Claude needs to FIND your skill
Purpose: Claude reads description to decide which skills to load for a given task. Make it answer: "Should I read this skill right now?"
Format: Start with "Use when..." to focus on triggering conditions
CRITICAL: Description = When to Use, NOT What the Skill Does
The description should ONLY describe triggering conditions. Do NOT summarize the skill's process or workflow in the description.
Why this matters: Testing revealed that when a description summarizes the skill's workflow, Claude may follow the description instead of reading the full skill content. A description saying "code review between tasks" caused Claude to do ONE review, even though the skill's flowchart clearly showed TWO reviews (spec compliance then code quality).
When the description was changed to just "Use when executing implementation plans with independent tasks" (no workflow summary), Claude correctly read the flowchart and followed the two-stage review process.
The trap: Descriptions that summarize workflow create a shortcut Claude will take. The skill body becomes documentation Claude skips.
# ❌ BAD: Summarizes workflow - Claude may follow this instead of reading skill
description: Use when executing plans - dispatches subagent per task with code review between tasks
# ❌ BAD: Too much process detail
description: Use for TDD - write test first, watch it fail, write minimal code, refactor
# ✅ GOOD: Just triggering conditions, no workflow summary
description: Use when executing implementation plans with independent tasks in the current session
# ✅ GOOD: Triggering conditions only
description: Use when implementing any feature or bugfix, before writing implementation code
Content:
# ❌ BAD: Too abstract, vague, doesn't include when to use
description: For async testing
# ❌ BAD: First person
description: I can help you with async tests when they're flaky
# ❌ BAD: Mentions technology but skill isn't specific to it
description: Use when tests use setTimeout/sleep and are flaky
# ✅ GOOD: Starts with "Use when", describes problem, no workflow
description: Use when tests have race conditions, timing dependencies, or pass/fail inconsistently
# ✅ GOOD: Technology-specific skill with explicit trigger
description: Use when using React Router and handling authentication redirects
Use words Claude would search for:
Use active voice, verb-first:
creating-skills not skill-creationcondition-based-waiting not async-test-helpersProblem: getting-started and frequently-referenced skills load into EVERY conversation. Every token counts.
Target word counts:
Techniques:
Move details to tool help:
# ❌ BAD: Document all flags in SKILL.md
search-conversations supports --text, --both, --after DATE, --before DATE, --limit N
# ✅ GOOD: Reference --help
search-conversations supports multiple modes and filters. Run --help for details.
Use cross-references:
# ❌ BAD: Repeat workflow details
When searching, dispatch subagent with template...
[20 lines of repeated instructions]
# ✅ GOOD: Reference other skill
Always use subagents (50-100x context savings). REQUIRED: Use [other-skill-name] for workflow.
Compress examples:
# ❌ BAD: Verbose example (42 words)
your human partner: "How did we handle authentication errors in React Router before?"
You: I'll search past conversations for React Router authentication patterns.
[Dispatch subagent with search query: "React Router authentication error handling 401"]
# ✅ GOOD: Minimal example (20 words)
Partner: "How did we handle auth errors in React Router?"
You: Searching...
[Dispatch subagent → synthesis]
Eliminate redundancy:
Verification:
wc -w skills/path/SKILL.md
# getting-started workflows: aim for <150 each
# Other frequently-loaded: aim for <200 total
Name by what you DO or core insight:
condition-based-waiting > async-test-helpersusing-skills not skill-usageflatten-with-flags > data-structure-refactoringroot-cause-tracing > debugging-techniquesGerunds (-ing) work well for processes:
creating-skills, testing-skills, debugging-with-logsWhen writing documentation that references other skills:
Use skill name only, with explicit requirement markers:
**REQUIRED SUB-SKILL:** Use superpowers:test-driven-development**REQUIRED BACKGROUND:** You MUST understand superpowers:systematic-debuggingSee skills/testing/test-driven-development (unclear if required)@skills/testing/test-driven-development/SKILL.md (force-loads, burns context)Why no @ links: @ syntax force-loads files immediately, consuming 200k+ context before you need them.
digraph when_flowchart {
"Need to show information?" [shape=diamond];
"Decision where I might go wrong?" [shape=diamond];
"Use markdown" [shape=box];
"Small inline flowchart" [shape=box];
"Need to show information?" -> "Decision where I might go wrong?" [label="yes"];
"Decision where I might go wrong?" -> "Small inline flowchart" [label="yes"];
"Decision where I might go wrong?" -> "Use markdown" [label="no"];
}
Use flowcharts ONLY for:
Never use flowcharts for:
REFERENCE: See graphviz-conventions.dot for graphviz style rules.
Visualizing for your human partner: Use render-graphs.js in this directory to render a skill's flowcharts to SVG:
./render-graphs.js ../some-skill # Each diagram separately
./render-graphs.js ../some-skill --combine # All diagrams in one SVG
One excellent example beats many mediocre ones
Choose most relevant language:
Good example:
Don't:
You're good at porting - one great example is enough.
defense-in-depth/
SKILL.md # Everything inline
When: All content fits, no heavy reference needed
condition-based-waiting/
SKILL.md # Overview + patterns
example.ts # Working helpers to adapt
When: Tool is reusable code, not just narrative
pptx/
SKILL.md # Overview + workflows
pptxgenjs.md # 600 lines API reference
ooxml.md # 500 lines XML structure
scripts/ # Executable tools
When: Reference material too large for inline
NO SKILL WITHOUT A FAILING TEST FIRST
This applies to NEW skills AND EDITS to existing skills.
Write skill before testing? Delete it. Start over. Edit skill without testing? Same violation.
No exceptions:
REQUIRED BACKGROUND: The superpowers:test-driven-development skill explains why this matters. Same principles apply to documentation.
Different skill types need different test approaches:
Examples: TDD, verification-before-completion, designing-before-coding
Test with:
Success criteria: Agent follows rule under maximum pressure
Examples: condition-based-waiting, root-cause-tracing, defensive-programming
Test with:
Success criteria: Agent successfully applies technique to new scenario
Examples: reducing-complexity, information-hiding concepts
Test with:
Success criteria: Agent correctly identifies when/how to apply pattern
Examples: API documentation, command references, library guides
Test with:
Success criteria: Agent finds and correctly applies reference information
| Excuse | Reality | |--------------------------------|------------------------------------------------------------------| | "Skill is obviously clear" | Clear to you ≠ clear to other agents. Test it. | | "It's just a reference" | References can have gaps, unclear sections. Test retrieval. | | "Testing is overkill" | Untested skills have issues. Always. 15 min testing saves hours. | | "I'll test if problems emerge" | Problems = agents can't use skill. Test BEFORE deploying. | | "Too tedious to test" | Testing is less tedious than debugging bad skill in production. | | "I'm confident it's good" | Overconfidence guarantees issues. Test anyway. | | "Academic review is enough" | Reading ≠ using. Test application scenarios. | | "No time to test" | Deploying untested skill wastes more time fixing it later. |
All of these mean: Test before deploying. No exceptions.
Skills that enforce discipline (like TDD) need to resist rationalization. Agents are smart and will find loopholes when under pressure.
Psychology note: Understanding WHY persuasion techniques work helps you apply them systematically. See persuasion-principles.md for research foundation (Cialdini, 2021; Meincke et al., 2025) on authority, commitment, scarcity, social proof, and unity principles.
Don't just state the rule - forbid specific workarounds:
<Bad> ```markdown Write code before test? Delete it. ``` </Bad> <Good> ```markdown Write code before test? Delete it. Start over.No exceptions:
</Good>
### Address "Spirit vs Letter" Arguments
Add foundational principle early:
```markdown
**Violating the letter of the rules is violating the spirit of the rules.**
This cuts off entire class of "I'm following the spirit" rationalizations.
Capture rationalizations from baseline testing (see Testing section below). Every excuse agents make goes in the table:
| Excuse | Reality |
|----------------------------------|-------------------------------------------------------------------------|
| "Too simple to test" | Simple code breaks. Test takes 30 seconds. |
| "I'll test after" | Tests passing immediately prove nothing. |
| "Tests after achieve same goals" | Tests-after = "what does this do?" Tests-first = "what should this do?" |
Make it easy for agents to self-check when rationalizing:
## Red Flags - STOP and Start Over
- Code before test
- "I already manually tested it"
- "Tests after achieve the same purpose"
- "It's about spirit not ritual"
- "This is different because..."
**All of these mean: Delete code. Start over with TDD.**
Add to description: symptoms of when you're ABOUT to violate the rule:
description: use when implementing any feature or bugfix, before writing implementation code
Before writing any skill, plan the work. Use TaskCreate to build a task list, then execute it step by step. This prevents skipping steps and makes progress visible.
TaskCreate: "RED — Write and run baseline pressure scenarios"
TaskCreate: "GREEN — Write minimal SKILL.md addressing baseline failures"
TaskCreate: "REFACTOR — Close loopholes from GREEN testing"
TaskCreate: "Deploy — Commit, push, verify discoverability"
For complex skills, use TeamCreate to parallelize work:
TeamCreate: team_name="skill-creation"
Task (subagent_type="general-purpose", team_name="skill-creation"):
"Run 3 baseline pressure scenarios WITHOUT the skill, document rationalizations"
Task (subagent_type="general-purpose", team_name="skill-creation"):
"Draft SKILL.md structure: frontmatter, overview, core pattern sections"
Parallelizable work:
Sequential work (must wait for previous step):
Follow the TDD cycle:
Run pressure scenario with subagent WITHOUT the skill. Document exact behavior:
How to dispatch a baseline test:
Task tool call:
subagent_type: "general-purpose"
prompt: |
IMPORTANT: This is a real scenario. Choose and act.
[Your pressure scenario here]
Choose A, B, or C. Be honest.
# Do NOT include the skill in the prompt — this is the baseline test.
# The subagent must work without skill guidance to reveal natural behavior.
This is "watch the test fail" — you must see what agents naturally do before writing the skill.
Write skill that addresses those specific rationalizations. Don't add extra content for hypothetical cases.
CRITICAL: Test the version you are editing, not a stale installed copy.
When developing a skill in the current directory (e.g.,
./my-skill/SKILL.md), GREEN and REFACTOR tests MUST use that file — not whatever may be installed at~/.claude/skills/. Two approaches:
- Paste content into prompt (subagent testing): Read the current
./SKILL.mdand paste its full content into the subagent prompt.- Copy to project skills dir (live-agent testing):
cp -r ./my-skill/ .claude/skills/my-skill/— project-level skills take priority over user-space.
How to dispatch a verification test:
Task tool call:
subagent_type: "general-purpose"
prompt: |
You have access to this skill:
[Paste the full SKILL.md content here]
IMPORTANT: This is a real scenario. Choose and act.
[Same pressure scenario as baseline]
Choose A, B, or C. Be honest.
# Include the full skill content in the prompt so the subagent can follow it.
Agent should now comply. If agent still fails: skill is unclear or incomplete — revise and re-test.
Agent found new rationalization? Add explicit counter. Re-test until bulletproof.
REQUIRED REFERENCE: See testing-skills-with-subagents.md for the complete testing methodology:
"In session 2025-10-03, we found empty projectDir caused..." Why bad: Too specific, not reusable
example-js.js, example-py.py, example-go.go Why bad: Mediocre quality, maintenance burden
step1 [label="import fs"];
step2 [label="read file"];
Why bad: Can't copy-paste, hard to read
helper1, helper2, step3, pattern4 Why bad: Labels should have semantic meaning
After writing ANY skill, you MUST STOP and complete the deployment process.
Do NOT:
The deployment checklist below is MANDATORY for EACH skill.
Gate enforcement: Use TaskCreate to track the deployment checklist. Do NOT mark the final deployment task as completed until you have verified the skill is discoverable in a fresh session. Only after the deployment task is completed may you begin the next skill.
Deploying untested skills = deploying untested code. It's a violation of quality standards.
IMPORTANT: Use TaskCreate to create tasks for EACH checklist item below. For complex skills, use TeamCreate to parallelize testing work across subagents.
PLAN Phase - Before Writing Anything:
RED Phase - Write Failing Test:
GREEN Phase - Write Minimal Skill:
@ links)~/.claude/skills/)REFACTOR Phase - Close Loopholes:
Quality Checks:
docs/, tutorial/, api/), tier 2 table is present and lists every upstream file with concrete API symbols — run find docs/ tutorial/ api/ -name '*.md' (adjust paths) and confirm each result has a row in the tier 2 columnwc -w SKILL.md under 500 words (body only)Deployment:
<project-root>/.claude/skills/skill-name/SKILL.md~/.claude/skills/skill-name/SKILL.mdhead -5 SKILL.md — confirm --- delimiters and valid YAMLwc -w SKILL.md — target under 500 words for SKILL.md bodygit add skills/skill-name/ && git commit -m "Add skill-name skill"git pushHow future Claude finds your skill:
Optimize for this flow - put searchable terms early and often.
Creating skills IS TDD for process documentation.
Same Iron Law: No skill without failing test first. Same cycle: RED (baseline) → GREEN (write skill) → REFACTOR (close loopholes). Same benefits: Better quality, fewer surprises, bulletproof results.
If you follow TDD for code, follow it for skills. It's the same discipline applied to documentation.
development
Textual TUI framework documentation reference
development
Use when building transparent remote procedure calls, distributed computing, or remote object proxying in Python with RPyC. Use when asked about rpyc.connect, rpyc.Service, netref proxies, async_(), BgServingThread, SSLAuthenticator, DeployedServer, or rpyc_classic.py.
tools
Use when choosing Python libraries for a task, when writing new Python code that needs dependencies, when reviewing Python imports for non-preferred libraries, or when unsure which library to use for JSON, HTTP, logging, TOML, YAML, compression, database access, testing, or CLI tools
development
Use when structuring Python 3.10+ projects with layered ports-and-adapters architecture, reviewing layer dependency violations, scaffolding domain-driven designs, deciding where code belongs across domain, application, adapter, and composition layers, or setting up ports, UoW, outbox, and idempotency patterns