technical-writing

Installation
SKILL.md

Technical writing

Write accurate, task-focused documentation for developers and coding agents. Each section should be easy to scan, retrieve, and act on without unstated context.

Consuming repo

Read the repo's AGENTS.md before you write: doc layers, public one-liner, capability names, banned copy, and where DESIGN.md lives. Glob rules in .cursor/rules/ override this skill. For which layer to update (MDX vs README vs rules), use /w-docs—do not duplicate its routing table here.

Voice

  • Address the reader as you; use imperative verbs for steps. Active voice, present tense, concrete nouns.
  • American English, Oxford comma. Write eve lowercase when naming the runtime.
  • Lead each page and section with the answer or outcome. One primary job per page.
  • Preserve the author's supported meaning, nuance, and uncertainty. Make the minimum effective edit; leave strong prose alone.
  • Use we only when describing a deliberate team action documented in the repo.

Ban filler and hype: easy, simple, quick, just, obviously, utilize, facilitate, leverage, robust, seamless, promotional adjectives, rhetorical questions, engagement bait.

Ban AI tells: summary transitions (With this setup complete…), stop-start fragments, datasheet verbs (provides, is configurable), cold opens with no antecedent, template closers and closing proverbs, manufactured specificity to sound human.

Installs
105
GitHub Stars
1
First Seen
11 days ago