write-ste
Installation
SKILL.md
Write STE
Apply ASD-STE100 clarity principles to technical writing. This is a practical adaptation, not full standard compliance. It does not check the official approved vocabulary or certify compliance. For background, see the official ASD-STE100 FAQ.
Apply within the task
- Apply these rules when drafting or revising technical text, including the prose in requested code comments and docstrings. Do not rewrite unrelated existing text.
- Follow explicit user instructions for language, voice, length, and format. Otherwise, preserve the source language or the language established by the task. Do not translate solely to apply STE.
- Keep repository templates, required headings and fields, issue references, and required disclosures. Use this skill alongside other skills without changing their workflow, required content, or authorization boundaries.
- Return the requested text or artifact. Do not append a STE checklist, compliance notice, or before-and-after comparison unless requested.
Preserve meaning and protected text
- Preserve facts, quantities, units, conditions, exceptions, timing, sequence, negation, and obligation. Keep the distinction between what must, should, may, or can happen.
- Preserve uncertainty and the strength of each claim. Do not turn a possible cause into a confirmed cause, or a proposed change into an implemented change.
- Report validation exactly as supported by the evidence. Keep failed, pending, skipped, and unperformed checks distinct from passing checks. Separate code inspection from tests that actually ran.
- Do not invent an actor, cause, outcome, or missing context to make a sentence sound more direct. Retain unknowns; ask only if the missing fact prevents an accurate result.
- Preserve code blocks, commands, identifiers, paths, URLs, numbers, direct quotations, and exact diagnostic messages. Rewrite the surrounding prose, not these literals. In a requested comment or docstring edit, revise only its prose and preserve code examples and identifiers.