Jump to content

Simplified Technical English

From Wikipedia, the free encyclopedia

ASD-STE100 Simplified Technical English (STE) is a controlled language designed to simplify and clarify technical documentation. It was originally developed during the 1980's by the European Association of Aerospace Industries (AECMA), at the request of the European Airline industry, who wanted a standardized form of English for technical documentation that could be easily understood by non-English speakers. It has since been adopted in many other fields outside the aerospace, defense, and maintenance domains for its clear, consistent, and comprehensive nature. The current edition of the STE Specification, published in April 2021, consists of 53 writing rules and a dictionary of approximately 900 approved words.

History

[edit]

The first attempts towards controlled English were made as early as the 1930s and 1970s with Basic English,[1] Caterpillar Fundamental English [2][3] and Eastman Kodak (KISL).[4] In 1979, aerospace documentation was written in American English (Boeing, Douglas, Lockheed, etc.), in British English (Hawker Siddeley, British Aircraft Corporation, etc.) and by companies whose native language was not English (Fokker, Aeritalia, Aerospatiale, and some of the companies that formed Airbus at the time).

Because European airlines needed to translate parts of their maintenance documentation into other languages for local mechanics, the European Airline industry approached AECMA (the European Association of Aerospace Industries) to investigate the possibility of using a controlled or standardized form of English. In 1983, after an investigation into the different types of controlled languages that existed in other industries, AECMA decided to produce its own controlled English. The AIA (Aerospace Industries Association of America) was also invited to participate in this project. The result of this collaborative work was the release of the AECMA Document, PSC-85-16598 (known as the AECMA Simplified English Guide) in 1986. Subsequently, several changes, issues and revisions were released up to the present issue (the current Issue 8 of STE is dated April 2021).

After the merger of AECMA with two other associations to form the Aerospace, Security and Defence Industries Association of Europe (ASD) in 2004, the specification was renamed ASD Simplified Technical English, Specification ASD-STE100. ASD-STE100 is maintained by the Simplified Technical English Maintenance Group (STEMG), a working group of ASD, formed in 1983; the copyright of ASD-STE100 is fully owned by ASD.[5] [6]

Due to the ever-evolving nature of technology and technical language, the STEMG also relies on user feedback for suggested changes and updates.[7] Starting from Issue 6 in 2013, the Specification became free of charge. Over the years, more than 11,800 official copies of Issues 6 and 7 were distributed. Since Issue 8 was released in April 2021, over 3,200 official copies have been distributed (distribution log updated August 2022). Usually, a new issue is released every three years.

A free official copy of the ASD-STE100 Specification can be requested through the ASD-STE100 website and through ASD-STAN.

Benefits

[edit]

Simplified Technical English can:

  • provide a single word to replace English words with multiple meanings (e.g., "includes" instead of "comes with")
  • improve the clarity of technical writing, especially procedural writing[8]
  • improve comprehension for people whose first language is not English
  • make human translation easier, faster, and more cost-effective
  • facilitate computer-assisted translation and machine translation
  • improve reliability concerns of maintenance and assembly by reducing their probability to introduce defects or human-factor risks.

These claims come mostly from those who have invested in developing, implementing, or supporting STE. To date, there are no published scientific studies to provide evidence about the benefits of STE, suggesting the need for more research.

Specification structure

[edit]

The ASD-STE100 Simplified Technical English specification consists of two parts:

  1. The writing rules
  2. The dictionary

Writing rules

[edit]

The writing rules differentiate between two types of topics: procedural and descriptive writing. The rules also cover aspects of grammar and style. A non-exhaustive list of the writing rules includes the concepts that follow:

  • Use the approved words and only as the part of speech and meaning given in the dictionary.
  • Make instructions as clear and specific as possible.
  • Do not write noun clusters that have more than three words.
  • Use the approved forms of the verb to make only:
  • Do not use helping verbs to make complex verb structures.
  • Use the "-ing" form of a verb only as a technical name or as a modifier in a technical name.
  • Do not use passive voice in procedures.
  • Use the active voice as much as possible in descriptive texts.
  • Write short sentences: no more than 20 words in instructions (procedures) and 25 words in descriptive texts.
  • Do not omit parts of the sentence (e.g. verb, subject, article) to make your text shorter.
  • Use vertical lists for complex text.
  • Write one instruction per sentence.
  • Write only one topic per paragraph.
  • Do not write more than six sentences in each paragraph.
  • Start safety instructions with a clear command or condition.

Dictionary

[edit]

The table that follows is an extract from a page of the ASD-STE100 dictionary:

Word

(Part of speech)

Approved meaning/

ALTERNATIVES

APPROVED EXAMPLE Not approved example
acceptance (n) ACCEPT (v) BEFORE YOU ACCEPT THE UNIT, DO THE SPECIFIED TEST PROCEDURE. Before acceptance of unit, do the specified test procedure.
ACCESS (n) The ability to go into or near. GET ACCESS TO THE ACCUMULATOR FOR THE NO. 1 HYDRAULIC SYSTEM.
accessible (adj) ACCESS (n) TURN THE COVER UNTIL YOU CAN GET ACCESS TO THE JACKS THAT HAVE “+” AND “-” MARKS. Rotate the cover until the jacks marked + and - are accessible.
ACCIDENT (n) An occurrence that causes injury or damage. MAKE SURE THAT THE PINS ARE INSTALLED TO PREVENT ACCIDENTS.

Explanation of the four columns:

Word (part of speech) – This column has information on the word and its part of speech. Every approved word in STE is only permitted as a specific part of speech. For example, the word "test" is only approved as a noun (the test) but not as a verb (to test). There are few exceptions to the "One word, one part of speech, one meaning" principle.

Approved meaning/ALTERNATIVES – This column gives the approved meaning (or definition) of an approved word in STE. In the example table, "ACCESS" and "ACCIDENT" are approved (they are written in uppercase). The text in these definitions is not written in STE. If a meaning is not given in the dictionary, you cannot use the word in that meaning. Use an alternative word. For words that are not approved (they are written in lowercase, such as "acceptance" and "accessible" in the example table), this column gives approved alternatives that you can use to replace the unapproved words. These alternatives are in uppercase, and they are only suggestions. It is possible that the suggested alternative for an unapproved word has a different part of speech. Usually, the first suggested alternative has the same part of speech as the unapproved word.

APPROVED EXAMPLE – This column shows how to use the approved word or how to use the approved alternative (usually a word-for-word replacement). It also shows how to keep the same meaning with a different construction. The wording given in the approved examples is not mandatory. It shows only one method to write the same information with approved words. You can frequently use different constructions with other approved words to say the same thing.

Not approved example – This column (text in lowercase) shows examples of how the unapproved word is frequently used in standard technical writing. The examples also help you to understand how you can use the approved alternatives and/or different constructions to give the same information. For approved words, this column is empty unless there is a help symbol (lightbulb) related to other meanings or restrictions.

The dictionary includes entries of both approved and unapproved words. The approved words can only be used according to their specified meaning. For example, the word "close" (v) can only be used in one of two meanings:

  1. To move together, or to move to a position that stops or prevents materials from going in or out
  2. To operate a circuit breaker to make an electrical circuit

The verb can express to close a door or to close a circuit, but it cannot be used with other connotations (e.g., to close a meeting or to close a business). The adjective "close" appears in the dictionary as an unapproved word with the suggested approved alternative "NEAR." Thus, STE does not allow do not go close to the landing gear, but it does allow do not go near the landing gear. In addition to the general STE vocabulary listed in the dictionary, Section 1, Words, gives specific guidelines for using technical names and technical verbs that writers need to describe technical information. For example, words, noun clusters, or verbs such as grease, discoloration, propeller, aural warning system, overhead panel, to ream, and to drill are not listed in the dictionary, but they qualify as approved terms according to Part 1, Section 1 (specifically, writing rules 1.5 and 1.12).

Aerospace and defense standards

[edit]

"Simplified Technical English" is sometimes used as a generic term for a controlled language. The aerospace and defense specification started as an industry-regulated writing standard for aerospace maintenance documentation, but it has become a requirement for an increasing number of military land vehicles, seacraft, and weapons programs. Although it was not initially intended for use as a general writing standard, it has been successfully adopted by other industries and for a wide range of document types. The US government's Plain English lacks the strict vocabulary restrictions of the aerospace standard, but represents an attempt at a more general writing standard.[9]

Since 1986, STE has been a requirement of the ATA Specification i2200 (formerly ATA100) and ATA104 (Training). STE is also a requirement of the S1000D Specification. The European Defence Standards Reference (EDSTAR) recommends STE as one of the best practice standards for writing technical documentation to be applied for defense contracting by all EDA (European Defence Agency) participating member states.

Today, the success of STE is such that other industries use it beyond its initial purpose for maintenance documentation and outside the aerospace and defense domains; as of August 2022, the STE distribution log shows that 56% of users come from outside these two industries. It is successfully applied in the automotive, renewable energies, and offshore logistics sectors, and is further expanding within medical devices and the pharmaceutical sector. STE interest is also increasing within the academic world, including the disciplines of information engineering, applied linguistics, and computational linguistics).

Tools

[edit]

Several outside software products exist to support the application of STE, but the STEMG does not endorse or certify these products.[10]

Boeing developed the Boeing Simplified English Checker (BSEC). This linguistic-based checker uses a sophisticated 350-rule English parser, which is augmented with special functions that check for violations of the Simplified Technical English specification.[11]

HyperSTE is a plugin tool offered by Etteplan to check content for adherence to the rules and grammar of the specification.

Congree offers a Simplified Technical English Checker based on linguistic algorithms. It supports all rules of Simplified Technical English issue 7 that are relevant to the text composition and provides an integrated Simplified Technical English dictionary.[12]

The TechScribe term checker for ASD-STE100 helps writers to find text that does not conform to ASD-STE100.[13]

See also

[edit]

References

[edit]
  1. ^ Ogden, Charles Kay (1932). Basic English: A General Introduction with Rules and Grammar. K. Paul, Trench, Trubner & Company, Limited.
  2. ^ Caterpillar Tractor Company. (1972). Caterpillar Fundamental English. Peoria, Ill. : Caterpillar Tractor Co.
  3. ^ Kaiser, Herbert. "A Close Look at STE". TC World. Archived from the original on 10 July 2019. Retrieved 20 May 2019.
  4. ^ "Re: controlled languages/simplified English?". www.techwr-l.com. Retrieved 2024-07-17.
  5. ^ "STEMG Official ASD-STE100 website". ASD-STE100 Simplified Technical English Maintenance Group.
  6. ^ Simplified Technical English, ASD-STE100, is a Copyright and a Trade Mark of ASD, Brussels, Belgium. All rights reserved. European Community Trade Mark No. 017966390.
  7. ^ "STE Downloads". asd-ste100.org. Retrieved 2023-11-03.
  8. ^ Kuhn, Tobias (2014). "A Survey and Classification of Controlled Natural Languages". Computational Linguistics. 40 (1): 121–170: 121–170. arXiv:1507.01701. doi:10.1162/COLI_a_00168. S2CID 14586568.
  9. ^ Plain Language: Improving Communications from the Federal Government to the Public
  10. ^ "FAQ". asd-ste100.org. Retrieved 2023-11-17.
  11. ^ Hoard, James E. (1992). An Automated Grammar and Style Checker for Writers of Simplified English. Computers and Writing. pp. 278–296.
  12. ^ "Congree Simplified Technical English Checker". Subject Detail Page. Congree Language Technologies GmbH. Retrieved 25 March 2019.
  13. ^ "Term checker for ASD-STE100 Simplified Technical English, issue 8". www.simplified-english.co.uk. Retrieved November 16, 2023.