Home/Tech Writing/simple-english
S

simple-english

by @aminblgv
4.5(120)

This skill rewrites or checks technical text using ASD-STE100 Simplified Technical English rules. It makes sentences short, vocabulary consistent, and instructions unambiguous. Ideal for READMEs, API docs, and manuals, so a tired non-native reader can follow on the first read. It also removes the usual signs of AI-generated prose.

technical-writingdocumentationreadabilitystyle-guideeditingGitHub
Installation
npx skills add https://github.com/aminblg/simpleenglish --skill simple-english
compare_arrows

Before / After Comparison

1 组
Before

Before this skill, users wrote technical documentation manually with long sentences, inconsistent synonyms, and vague phrasing, requiring multiple review passes and lengthy rework cycles.

After

Using this skill, the documentation is rewritten following STE rules, producing short, clear sentences that pass review on the first try, dramatically reducing rework.

SKILL.md

Simple English: Write Like an Aerospace Manual

Write technical text with the rules of ASD-STE100 Simplified Technical English. STE is the controlled language that aerospace and defense manufacturers use for maintenance documentation. The rules exist so that a tired reader who is not a native English speaker cannot misread an instruction. They remove the usual signs of AI-generated text as a side effect: long sentences, synonym rotation, hedges, filler, and decorative clauses.

Write for that tired reader. Each sentence must survive one read.

Your Task

When asked to write or rewrite technical text:

  1. Select the mode (pragmatic or strict, below).
  2. Classify each passage as procedural or descriptive. Every other rule depends on this.
  3. Fix your vocabulary before drafting. Pick ONE verb for the check/verify/confirm/validate concept and ONE noun for config/settings. Use no other word for these concepts in the whole document.
  4. Apply the rules from the catalog below.
  5. Run the self-check before you deliver. This step is not optional.
  6. Never touch code, identifiers, commands, or quoted errors (see Untouchables).

When asked to CHECK text instead of writing it, report each violation as: rule number, the offending text, a compliant rewrite. Cite only rule numbers that exist in this file. Do not cite rule numbers from memory: the numbering is unintuitive and models invent it (tested — an agent without this file cited "Rule 3.1: short sentences"; the real Rule 3.1 is about verb forms).

Two Modes

ModeWhenWhat you apply
Pragmatic (default)Docs, READMEs, error messages — the user wants clear textAll structural rules. Domain words stay ("idempotent", "webhook").
StrictThe user names STE, ASD-STE100, or complianceStructural rules + full vocabulary discipline, and tell the user that full compliance needs the official dictionary (free at asd-ste100.org).

Step 1: Classify the Text

Procedural (instructions)Descriptive (explanations)
PurposeTell the reader what to doExplain what a thing is or does
Verb formImperative: "Install the pump."Simple present/past/future
Sentence limit20 words (Rule 5.1)25 words (Rule 6.3)
Unit ruleOne instruction per sentence (5.2)One topic per paragraph (6.5), max six sentences per paragraph (6.6)

Do not mix the two in one passage. A "Getting started" section is procedural. An "Architecture" section is descriptive. A note inside a procedure is descriptive (25-word limit, no imperative).

THE RULE CATALOG

53 rules in 9 sections, paraphrased from ASD-STE100 Issue 9 with software examples. The official wording is in the free standard at asd-ste100.org.

Section 1 — Words (Rules 1.1-1.14)

RuleInstruction
1.1Use only approved words, technical nouns, or technical verbs.
1.2Use an approved word only as its listed part of speech.
1.3Use an approved word only with its approved meaning.
1.4Use only the approved forms of verbs and adjectives.
1.5You can use domain words as technical nouns ("webhook", "commit", "endpoint").
1.6Use an unapproved word only when it is a technical noun or part of one.
1.7Do not use technical nouns as verbs.
1.8Use the technical nouns of your project or industry.
1.9When you pick a technical noun, pick a short and clear one.
1.10No regional, slang, or jargon words as technical nouns.
1.11One item, one name. Do not call it "config" here and "settings" there.
1.12You can use domain verbs as technical verbs ("deploy", "compile", "merge").
1.13Do not use technical verbs as nouns.
1.14Use American English spelling.

In pragmatic mode, rules 1.5, 1.8, and 1.12 do the heavy lifting: your domain vocabulary is legal. The ones agents break are 1.7, 1.11, and 1.13.

Before: You can webhook the event, then do a deploy. After: Send the event to the webhook. Then deploy the service.

Section 2 — Multi-word nouns (Rules 2.1-2.2)

RuleInstruction
2.1Write multi-word nouns of three words or fewer.
2.2When a technical noun needs more than three words, write it in full once, then give a short form or hyphenate the units.

Break long noun chains with prepositions (of, on, in, for):

Before: the connection pool timeout configuration value After: the timeout value for the connection pool

Section 3 — Verbs (Rules 3.1-3.7)

RuleInstruction
3.1Use only the verb forms that the dictionary gives.
3.2Use only: infinitive, imperative, simple present, simple past, simple future, past participle as adjective.
3.3Use the past participle only as an adjective ("the cached response").
3.4No auxiliary verbs for complex constructions. No present perfect, no "is to be installed".
3.5Use an "-ing" form only as a technical noun or inside one ("logging", "the mounting bracket") — never as a verb.
3.6Active voice. In descriptive text, passive is legal only when the agent is unknown.
3.7Describe an action with a verb, not a noun ("compress the file", not "perform compression of the file").

Approved modals: can, will, must. Banned: should, would, may, might, could. The standard rejects "could" even for possibility: write "an explosion can occur", never "could occur". For "should": a requirement becomes "must"; a suggestion is stated as fact or deleted. This matters double for agent instructions — models read "should" as optional.

Before: The migration has completed and the table is being rebuilt. After: The migration is complete. The database rebuilds the table.

Before: The flag can be set in the config file, making restarts unnecessary. After: You can set the flag in the config file. Then a restart is not necessary.

Before: The temperature must be adjusted. After: Adjust the temperature.

Section 4 — Sentences (Rules 4.1-4.5)

RuleInstruction
4.1Write short and clear sentences.
4.2Do not omit words or use contractions to shorten sentences. Keep articles, keep "that".
4.3Use a vertical list for complex text.
4.4Use connecting words between sentences on related topics ("Then", "As a result").
4.5Put an article (the, a, an) or a demonstrative adjective (this, these) before nouns where applicable.

Rule 4.2 is the anti-terseness rule. STE is short sentences with complete grammar, not telegraph style:

Wrong shortening: Ensure file exists before running. STE: Make sure that the file exists before you run the command.

Section 5 — Procedural writing (Rules 5.1-5.5)

RuleInstruction
5.1Maximum 20 words per sentence. Warnings and cautions included.
5.2One instruction per sentence, unless two actions happen at the same time.
5.3Write instructions in the imperative: "Run the migration."
5.4Put a required condition before the command, divided by a comma: "If the build fails, read the log."
5.5Notes give information, never instructions. Notes get the 25-word limit.

Before: You'll want to grab the API key from the dashboard before configuring the client, which you can do under Settings. After: Get the API key from the dashboard, under Settings. Then configure the client with this key.

Section 6 — Descriptive writing (Rules 6.1-6.6)

RuleInstruction
6.1Give information gradually: one new fact per sentence.
6.2Use key words and phrases to give the text a logical structure.
6.3Maximum 25 words per sentence.
6.4Group related information in paragraphs.
6.5One topic per paragraph.
6.6Maximum six sentences per paragraph.

No imperative in descriptive text. Descriptions explain; procedures instruct.

Section 7 — Safety instructions (Rules 7.1-7.3)

RuleInstruction
7.1Use a word that shows the risk level ("WARNING" = injury, "CAUTION" = damage).
7.2Start with a clear command or condition.
7.3Then give the risk or the possible result.

Never bury the instruction after the explanation. The pattern transfers directly to destructive CLI flags, irreversible migrations, and dangerous API options.

Before: Note that data loss may occur in some circumstances if the destructive flag happens to be enabled when running against production. After: CAUTION: Do not use the --force flag against production. The flag deletes rows that do not match the source.

Section 8 — Punctuation and word count (Rules 8.1-8.7)

RuleInstruction
8.1All standard punctuation is legal except the semicolon. Write two sentences instead.
8.2Use hyphens to connect words that act as one unit.
8.3Parentheses are legal for references, item numbers, abbreviations, plural forms, explanations, alternatives.
8.4In a vertical list, the lead-in colon ends a sentence for word count.
8.5Text inside parentheses counts as one word.
8.6Count as one word each: numbers, numbers with units, abbreviations, alphanumeric identifiers, quoted text, titles, labels, proper nouns.
8.7A hyphenated word counts as one word.

Rule 8.6 matters for software text: sqlpipe run --config sqlpipe.yaml in backticks is quoted text and counts as one word. Long identifiers do not blow your sentence budget.

Section 9 — Writing practices (Rules 9.1-9.4, GR-1 to GR-8)

RuleInstruction
9.1When a word-for-word replacement does not work, restructure the sentence.
9.2Use each approved word correctly: approved meaning, approved part of speech.
9.3Do not build phrasal verbs ("go down" → "decrease", "set up" → "install" or "configure").
9.4Keep one consistent style and terminology through the whole document.

General recommendations GR-1 to GR-8: keep the conjunction "that", be careful with "with", give pronouns clear referents, prefer "this + noun" over bare "this", avoid false friends, avoid Latin abbreviations, use inclusive language, and use the possessive apostrophe form only when you are sure it is correct (GR-8: if unsure, do not use it — non-native readers find it hard).

GR-6 for software docs: "e.g." → "for example", "i.e." → "that is", and delete "etc." — name the items or write "and more".

VOCABULARY DISCIPLINE

The official dictionary (~900 approved words, ~1,200 banned words with alternatives) is copyrighted by ASD and is not reproduced here. Its mechanics apply without it: one word, one meaning, one part of speech.

Known part-of-speech rulings, useful as patterns:

WordRuling
test, check, workNoun only. "Do a test", not "test the pump". "Check that X" becomes "make sure that X".
oilNoun only as used in STE examples. For the verb, the dictionary gives "lubricate".
helpVerb only. For the noun, the dictionary gives "aid": "with the aid of".
fall"To move down by gravity" only, never "decrease".
follow"To come after" only, never "obey". Write "obey the instructions".
above, belowPhysical positions only. For limits write "more than", "less than".

The modal ladder

You wroteSTE writes
should (requirement)must
should (recommendation)Delete it, or state it as fact: "X is better because Y."
may / might / could (possibility)can
may (permission)can
would (hypothetical)Restructure: "If X occurs, Y occurs."

Slop-to-simple substitutions

This table is ours, not the ASD dictionary. It maps the words AI-generated docs overuse to plain replacements. If the word carries no fact, delete it instead of replacing it.

SlopWrite instead
leverage, utilizeuse
in order toto
prior tobefore
ensuremake sure that
it is worth noting that(delete)
it's important to, crucially(delete — state the fact)
simply, just, easily, seamlessly, effortlessly(delete)
robust, powerful, comprehensive, performant(delete, or give the measurable property)
functionalityfunction, feature
enables you to, allows you toyou can
is designed to, aims to(delete — say what it does)
facilitatehelp, make possible
dive into, delve intoread, examine
when it comes tofor
in the event thatif
due to the fact thatbecause
as needed, as necessary(state the condition)
and/orPick one, or write "X, or Y, or both"
e.g. / i.e. / etc.for example / that is / (name the items)
gracefully handles(say what it does: "retries three times, then stops")
out of the boxby default
under the hoodinternally
blazingly fast, state-of-the-artfast (give the number) / (delete)
streamlinemake simpler, make faster
plethora, myriadmany
addresses the issue, tacklescorrects the fault, removes the error

Consistency pass

Collapse these common rotations to one term each (Rules 1.11, 9.4):

  • check / verify / confirm / validate / ensure → pick one
  • config / configuration / settings / options → pick one
  • delete / remove / drop / destroy → one per meaning, kept consistent
  • error / issue / problem / failure → "error" for errors, "failure" for failed operations
  • run / execute / invoke / launch → pick one
  • show / display / render / present → pick one

Untouchables

These are technical names (Rules 1.5, 8.6). Leave them exact, even when they break vocabulary rules:

  • Code blocks, inline code, identifiers, CLI commands, flags, file paths
  • Quoted error messages and log lines
  • Product names, API endpoint names, config keys
  • Numbers with units — each counts as one word in the sentence limit

Beyond Documentation

Same rules, different targets. Full adaptations in references/use-cases.md:

  • Error messages: state what happened (simple past), the cause if known, then the fix as an imperative. No "Oops", no "Please ensure", no apology filler.
  • Runbooks: STE's home turf. Imperative steps, conditions first, warnings before the step.
  • Incident reports: simple past only. "We have identified an issue that may have impacted" becomes "Between 14:02 and 14:31 UTC, 12% of requests failed."
  • Release notes: breaking changes follow the warning pattern — command first, risk second.
  • Agent instructions (prompts, AGENTS.md): a system prompt is a procedure for a reader that cannot ask questions. One instruction per sentence, no "should", condition first.
  • Translation prep: STE's original job. One meaning per word plus complete grammar removes most translation ambiguity.

Self-Check Before You Deliver

This step is not optional. Run these four checks on your draft:

  1. Count words in your three longest sentences. Over the 20/25 limit → split them.
  2. Search your draft for: 'll,

...

User Reviews (0)

Write a Review

Effect
Usability
Docs
Compatibility

No reviews yet

Statistics

Installs13.3K
Rating4.5 / 5.0
Version
Updated2026年10月23日
Comparisons1

User Rating

4.5(120)
5
37%
4
43%
3
13%
2
5%
1
2%

Rate this Skill

0.0

Compatible Platforms

🤖claude-code

Timeline

Created2026年8月2日
Last Updated2026年10月23日
🎁 Agent Knowledge Cards
Survey