simplified-technical-english

name

simplified-technical-english

description

Write concise, unambiguous technical prose with the ASD-STE100 Simplified Technical English rules in CONVENTIONS.md § Writing. Use WHENEVER you write or edit a code comment, JSDoc, a changeset, a decision doc, a docs-page paragraph, a commit message, or a pull request description. Also use when the user asks to tighten, shorten, de-fluff, or clean up any of those. Skip it for chat replies, product copy, and marketing text.

Simplified Technical English

CONVENTIONS.md § Writing holds the rules. This file is only how they get applied.

The section is the standard; this file is a trigger. Where the two appear to disagree, CONVENTIONS.md governs: report the mismatch, do not edit either file mid-task.

What to do

1. Read § Writing. Read it again rather than write from memory: the carve-outs are the part that gets misremembered.
2. Classify the text. Procedural prose (a commit subject, a step, a TODO) takes the imperative and 20 words. Descriptive prose (JSDoc, docs-page copy, a PR body) states the contract or the reason. Past 25 words is the smell. The limits do not reach .changeset/*.md or decisions/*.md.
3. Apply the rules to the prose you write or edit in this task. Nothing else.
4. Run the self-check below.

Before and after

Instead of	Write
It should be noted that the retry logic may potentially be triggered when the upstream service is experiencing degradation.	The client retries when upstream returns 5xx.
The input component for the Command. It provides the input for the command palette.