Plain English is not sufficient for many technical documents. A controlled language is a solution to the problems of plain English. A controlled language specifies the grammatical structures and the words that a writer can use. One controlled language is ASD-STE100 Simplified Technical English (www.asd-ste100.org).
The specification for ASD Simplified Technical English is ASD-STE100. (Before 2005, ASD Simplified Technical English was AECMA Simplified English.) ASD-STE100 was developed for the aerospace industry, but it can be adapted for other industries. ASD-STE100 helps people to write clear documentation.
Each word has only one meaning. For example, the verb 'to follow' means 'to come after'. 'To follow' does not mean 'to obey'. As an alternative to 'Follow the safety instructions', write 'Obey the safety instructions'.
The writing rules specify the structure of the text. For example, descriptive sentences must have no more than 25 words. (This rule puts a number on the plain English guideline to keep sentences short.)
In technical documentation, ambiguous text is bad. Each instruction must be clear. ASD Simplified Technical English helps technical writers to achieve that requirement. ASD Simplified Technical English has limits, but it helps to make sure that text is clear.
The TechScribe website does not conform to all the rules of ASD-STE100. For example, we use synonyms such as 'technical writer' and 'technical author'. This website is a marketing tool. If people use the term 'technical author' in search engines, and if our term is 'technical writer', then people will not find this website. Therefore, we use the synonyms.
Some professional technical writers think that synonyms are good. In 'Spring into Technical Writing for Engineers and Scientists' (www.informit.com/store/product.aspx?isbn=0131498630), Barry Rosenberg suggests that for non-technical verbs, a technical writer can use synonyms to make the text interesting. I asked Barry to explain, and he wrote:
When I refer to a product name, a product component, a scientific concept, or any sort of technical noun, I want to make sure that I refer to this thing in the same consistent way each time. Thus, a "widget" on page 10 cannot become a "gadget" on page 11 and a "doohickey" on page 12. Such name shifts confuse readers. Similarly, if the correct technical verb for the way a widget disintegrates is "to framboozle," then I better make sure that the widget framboozles at every opportunity, even if the widget has to framboozle in sentence after sentence. However, in the "Verbs" section, I was trying to say (unsuccessfully, it would seem) that some writers tend to overuse certain general verbs (for example, "illustrates" or "shows"). For instance, a paragraph that used "shows" in four consecutive sentences would probably be a suboptimal paragraph. In this instance, I think verb variety can be quite helpful.
"MIRCE Science is a theory of the motion of working systems through Mirce Space compelled by imposing functionability actions, used for the calculation of the expected work & resources needed." Dr J. Knezevic, 1999
Sep 4, 2023Space Debris Research Lab[More]Jun 12, 2014MIRCE Functionability Actions[More]May 13, 2013MIRCE Science Papers[More]Aug 12, 2011Orlando's ASD- Simplified Technical English[More]Aug 6, 2011MIRCE Science related quotes[More]
Orlando Chiarello is the Chairman of the ASD Simplified Technical English Maintenance Group (STEMG), responsible for the development and maintenance of the ASD-STE100, Simplified Technical English, Specification (www.asd-ste100.org). He is the Product Support Manager of Secondo Mona (www.secondomona.com), an Italian aerospace systems and equipment manufacturer, where he is responsible for the aftermarket support of the company products.
c80f0f1006