| name | ste100 |
|---|---|
| description | Rules to write text in ASD-STE100, Simplified Technical English (STE). Use this skill when a user asks for text in Simplified Technical English, STE, or ASD-STE100, or asks you to simplify technical text for readers with basic English skills. |
This skill tells you how to write in ASD-STE100. ASD-STE100 is Simplified Technical English. Users call it STE.
STE is a controlled language. ASD owns STE. Write technical text in STE for readers who have basic English skills. STE removes big words. STE removes long sentences. STE removes complex grammar.
STE has two parts.
- Part 1 is a set of writing rules.
- Part 2 is a dictionary of approved words.
Use the writing rules to make your grammar and style simple. Use the dictionary to pick words that most readers know.
- Use a word for only one meaning. Example: use "start". Do not use "begin", "commence", or "initiate".
- Use a word as only one part of speech. Example: use "test" as a noun. Do not use "test" as a verb.
- Use short, common words.
- Do not use long or rare words.
- Do not join more than three nouns together in one term.
- Use articles. Do not remove "a", "an", or "the" from a sentence.
- Do not use slang or idioms.
- Do not use a verb that ends in "-ing". Example: do not write "You are installing the unit." Write "Install the unit."
- You can use a word that ends in "-ing" as a noun or as an adjective. Example: "the opening", "the remaining parts".
Use only these forms of a verb:
- the infinitive form (to install)
- the imperative form (Install the unit.)
- the simple present tense (The light comes on.)
- the simple past tense (The light came on.)
- the simple future tense (The light will come on.)
- the past participle as an adjective (the installed unit)
Do not add auxiliary verbs to make a complex verb form. Do not write "The unit should have been installed." Write "Install the unit."
- Write one instruction in one sentence.
- Write no more than 20 words in an instruction sentence.
- Write no more than 25 words in a sentence that gives information.
- Write in active voice. Example: "Remove the panel." Do not write "The panel must be removed."
- Use the passive voice only when you do not know who or what does the action.
- Do not remove words from a sentence to make it short. Keep the subject, the verb, and the article.
- Write about only one topic in a paragraph.
- Write no more than six sentences in a paragraph.
- Use a vertical list when you write about a complex topic or many items.
Write a procedure as a set of short steps. Write each step as a command. Start a safety instruction with a clear command or a clear condition.
Example:
- Open the access panel.
- Remove the four screws.
- Pull the cover away from the frame.
Use this format for cautions and warnings:
- A WARNING tells the reader about a risk of injury or death.
- A CAUTION tells the reader about a risk of damage to equipment.
- A NOTE gives extra information that is not a warning or a caution.
Put the WARNING or CAUTION before the step, not after.
Ask these questions about your text:
- Does each sentence have one topic?
- Does each sentence use a simple verb tense?
- Does each sentence stay under the word limit?
- Does each word have only one meaning in this text?
- Can a reader with basic English skills understand this text?
If the answer to any question is "no", rewrite the sentence.
This skill does not give you the full ASD-STE100 dictionary. ASD owns that dictionary. Get the full standard from asd-ste100.org. Use this skill for the general rules and the style. Check your final text against the real standard when you write for a real aerospace or defense program.