Writing Guardrails
Prose anchored in BLUF / Inverted Pyramid structure and informed by ASD-STE100 controlled-language discipline. Follow the following rules for governed prose.
Scope
- Govern: prose in
plan.md,spec.md,mission.md, decision logs, verification reports, GitHub PRs, issues, and comments. - Leave unchanged: Gherkin, Background bullets, tables, ASCII diagrams, delta markers, and validator-owned RFC keyword casing.
- PR text: lead with tradeoffs and boundaries; tie claims to diffs, files, tests, or command output.
Rules
- Classify each passage as procedural or descriptive.
- One sentence states one idea. Split a sentence joined by
and,which, orwhileinto two. - Procedural: imperative, one instruction per sentence, maximum 20 words.
- Descriptive: simple tense, one fact per sentence, one topic per paragraph, maximum 25 words and six sentences per paragraph.
- Put the conclusion first. Make headings summarize their sections. Make each section stand alone.
- State the current content, plan, or decision as fact. Do not narrate the steps, attempts, or revisions that produced it.
- Use active voice and name the actor. Use verbs, not nominalizations.
- Put conditions before commands:
If the build fails, read the log. - Use complete grammar. Keep articles and
that. Use no perfect or progressive forms. - Use no semicolons or contractions.
- Replace weak requirements:
should→MUSTor a fact. Replace hypothetical modals with conditions. Keep uncertainty when evidence requires it. - Use
MUST,SHOULD, andMAYonly as RFC 2119 / 8174 normative keywords. - Label destructive instructions:
WARNINGfor injury,CAUTIONfor data or equipment damage. State the consequence after the instruction. - Use one term, meaning, word class, and verb for each concept. Repeat nouns when pronouns lose the referent.
- Remove filler, vague claims, hedges, escape hatches, and
and/or. Quantify vague terms. - Ban hyperbole. Use no superlatives or intensifiers:
massive,game-changing,seamless,dramatically,very. State scale or impact only with a number or a test result. - Use one verb per concept:
check,run, andshow, or another chosen set. - Replace:
utilize→use;in order to→to;prior to→before;ensure→make sure that;facilitate→help;e.g.→for example;i.e.→that is;etc.→ named items;functionality→functionorfeature;out of the box→by default;under the hood→internally. - Keep technical names, product names, identifiers, commands, flags, paths, config keys, code, quoted errors, and numbers with units unchanged. Count each as one word.
- Do not claim project behavior without evidence. Scope unsupported claims, label inferences, and name untested areas.
- Ban em dashes. Use a comma, period, colon, parentheses, or a new sentence.
Delivery Check
- Count procedural and descriptive sentences against their caps.
- Scan for weak modals, contractions, semicolons, and em dashes.
- Scan for process narration, superlatives, and intensifiers. Replace each with the result and its evidence.
- Move each condition before its command.
- Check vocabulary consistency, active voice, actors, filler, and unsupported claims.
- Rerun the checks after every correction.
External Boundaries
- These rules paraphrase ASD-STE100 Simplified Technical English for teaching. They reproduce no spec text, controlled dictionary, or official examples, and claim no ASD-STE100 compliance. ASD-STE100 is a registered trademark of ASD; this skill has no affiliation with or endorsement from ASD or STEMG.
- RFC 2119 and RFC 8174 identify normative-keyword conventions only. This skill reproduces no RFC text.