Technical Writing
Trigger
Use when the output is text people will read later: documentation, release notes, PR or issue text, spec and plan prose, README edits, reports.
Non-trigger
Do not activate for code, identifiers, commit subjects that follow the repository's own convention, or conversational replies.
Rules
- Name the reader and write at their level; say what they can do, not how the code does it, unless they are developers.
- State only verified behavior. A name, guarantee, command, or example that was not checked against the repository does not go in.
- The repository's existing prose style wins: match neighboring documents, headings, terminology, and link style before applying any default.
- Where the repository sets no style and the text is English, write to the STE rules.
- Code identifiers, commands, paths, and product names are technical names: keep the repository's exact spelling and formatting.
- Read the result once as the named reader; cut every sentence they do not need.