Skip to content

ericrisco/rsc-harness / skills/technical-writing

technical-writing

Verified

Use when writing or fixing user-facing technical docs — a README, a getting-started tutorial, a how-to guide, or API/CLI/config reference — especially when a page tries to teach, explain and enumerate at once, a tutorial branches, a reference is padded with opinions, a README reads like a sales pitch, samples are stale, or weasel words have crept in. NOT an SEO blog article (that is `article-writing`), NOT the content calendar or pipeline (that is `content-engine`).

FileKindSize
SKILL.mdskill md11.7 KB
evals/README.mdmarkdown824 B
evals/cases.yamlconfig3.6 KB
references/diataxis-modes.mdmarkdown4.1 KB
references/vale-starter.mdmarkdown2.2 KB
scripts/verify.shexecutablescript2.6 KB

evals/cases.yaml

View on GitHub
skill: technical-writing

# Prompts that MUST load technical-writing. The skill owns the user-facing
# DOCUMENT — README, tutorial, how-to, reference — and the discipline of
# writing each in its correct Diátaxis mode. Not topic strategy, not the
# calendar, not localization, not pedagogy.
should_trigger:
  - prompt: "Write a README for my Python CLI tool."
    why: "Core job — the README is the one doc everyone gets wrong; squarely in scope."
  - prompt: "My docs page teaches, explains, and lists every parameter at once — readers are lost."
    why: "Non-obvious: no doc-type word, but it is the signature mode-mixing failure the skill exists to fix."
  - prompt: "Turn these notes into a step-by-step getting-started guide a beginner can run end to end."
    why: "Tutorial mode — linear, runnable, guaranteed success."
  - prompt: "Document this REST endpoint's parameters, responses, and error codes."
    why: "Reference mode — dry, complete, table-structured."
  - prompt: "Split this page into a tutorial vs a how-to — right now it's one confusing blob."
    why: "Non-obvious: the request is a Diátaxis split, the core decision this skill makes."
  - prompt: "Add a Vale lint to block 'simply' and 'just' in our /docs on every PR."
    why: "Docs-as-code: prose linting in CI is owned here, framed as tooling not writing."
  - prompt: "escriu un README clar per aquesta llibreria"
    why: "Catalan trigger for the core README job."
  - prompt: "documenta esta API con una guía paso a paso"
    why: "Spanish trigger — documenting an API as a step-by-step guide (tutorial/how-to)."

# Prompts that must NOT load technical-writing — each routes to a real sibling.
should_not_trigger:
  - prompt: "Write a 1500-word SEO blog post about vector databases with FAQ schema."
    route_to: article-writing
    why: "Search-intent prose plus on-page schema, not a product/codebase doc."
  - prompt: "Build our content calendar and topic pillars for Q3."
    route_to: content-engine
    why: "The system and calendar across many pieces, not one document."
  - prompt: "Translate our existing English docs into Spanish."
    route_to: translation-l10n
    why: "Localization of already-written docs, not authoring the source doc."
  - prompt: "Design a 6-week course curriculum on Kubernetes with lessons and slides."
    route_to: course-storytelling
    why: "Syllabus and pedagogy over time, not one runnable doc."
  - prompt: "Define our brand tone of voice and a reusable style spec."
    route_to: brand-voice
    why: "The voice rules a doc is written in, not the doc itself."

# Capability: can the skill actually restructure a mixed page and clean the prose?
capability:
  - scenario: "Given a single docs page that opens with a beginner tutorial intro, then drifts into an opinionated explanation of why the architecture is async, then dumps a parameter list — restructure it correctly."
    must_include:
      - "Classifies the page's content into the four Diátaxis modes (tutorial, how-to, reference, explanation)."
      - "Proposes splitting it into separate pages, one mode per page — not patching one page."
      - "Rewrites at least one mode in its correct shape (e.g. a dry reference table for the parameters, with required/default columns)."
      - "Removes weasel/AI-tell words (simply, just, easy, seamless) and explains why."
      - "Ensures code samples are minimal, runnable, and show expected output, with no hidden '...' lines."
      - "Recommends a Vale-in-CI blocking gate (or the verify.sh banlist) so docs cannot regress."
      - "States that the README must say what the thing is and what it's for, and link to the fuller docs."
writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deploymentStars: 322kUpdated Claude CodeCodexVerifiedInstall
xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release.Stars: 118kUpdated Claude CodeCodexVerifiedInstall