| name | technical-writing |
|---|---|
| description | Write clear, simple technical prose and check it with the vale CLI. Applies to documentation, READMEs, PR descriptions, GitHub comments, code comments, commit messages, specifications, and implementation plans (never to code). Use when writing or editing technical text, or when asked to make writing plain, clear, or less AI-sounding. |
Use simple language in all technical prose. This covers documentation, READMEs, pull request text, GitHub comments, commit messages, code comments, error messages, specifications, and implementation plans. It does not cover code, identifiers, or command syntax.