STE as part of your global content strategy
The role of technical authors and technical documentation managers
Technical writers are the go-between for subject-matter-experts (SMEs), engineers, designers and the end-users of documentation. Consequently, the responsibility of creating effective documentation falls on technical authors who endeavour to send out a clear, unambiguous, and user-friendly message about their products and line of services.
At the level of global information management, technical writing professionals should consider short-term tactics and longer-term strategies to overcome the following:
- An ever-increasing volume of words to write and translate
- Snowballing translation and documentation management costs
- Overlapping information across different versions of similar document types
- Low comprehension levels for the English language jargon.
Simplified Technical English as part of your content strategy
Since 1970, Aerotech has been solving motion control and automation challenges for the most complex applications in the world’s most demanding industries. Aerotech’s depth and breadth of experience reduces technical and business risk and total cost of ownership. Aerotech is the global precision motion control and automation industry leader. Aerotech’s solutions enable manufacturing, testing, and inspection processes on a micrometer and nanometer scale. Aerotech is the only company offering solutions for every motion challenge.
As your precision motion partner, Aerotech works closely with your team to improve your processes, products and productivity. The depth and breadth of their experience means they’ve likely seen your motion challenge before – and they’ve probably already solved it.
ASD-STE100 Simplified Technical English (STE) is a controlled language that is used to write technical manuals in such a way that they can be more easily understood by an international audience. To put it across plainly, STE is a form of controlled language that is guided by 53 technical writing rules that were put together by a committee of linguists, engineers, and manufacturers who established over the years that these writing rules made sense and allowed them to re-write any of their existing documentation based on these rules, making their documentation easier to understand, while maintaining accuracy, safety, and validity.
Develop, deploy, and deliver documentation with STE
STE Quick facts
Background: With the widespread dissemination of user documentation published in various delivery formats across several language translations, the relevance of global information management has become greater in an attempt to stem terminology inconsistencies, mistranslations, and the disproportionate escalation of costs associated with the maintenance, reuse, and consumption of technical content.
Year: In use since 1986
Current Version: Issue 8, May 2021.
Technical writing rules: 53
Dictionary word entries: approx. 2400 terms.
The STE specification also includes a core vocabulary of around 930 approved words and 1500 non-approved words that let technical authors write just about everything that they need for for procedural and descriptive texts. Therefore, the use of approved words, compliance with the standard, and a language quality checker tool to complement your content strategy efforts is akin to pooling your most valuable resources where people, internal processes, and innovative technologies become more aligned.
STE in practice
If this is your first time hearing about STE, the example that follows will hopefully shed more light on the principles and best practices that govern good STE writing. Here is an original piece of text presented in standard English writing:
THE SYNTHETIC LUBRICATING OIL USED IN THIS ENGINE CONTAINS ADDITIVES WHICH, IF ALLOWED TO COME INTO CONTACT WITH THE SKIN FOR PROLONGED PERIODS, CAN BE TOXIC THROUGH ABSORPTION.
And here it is again in STE:
THE OIL IS POISONOUS. DO NOT GET THE ENGINE OIL ON YOUR SKIN. IT CAN GO THROUGH YOUR SKIN AND INTO YOUR BODY.
Making the comparison between the two types of writing above, you will see that the original writing is rather cumbersome in expression. It is also very likely that the person reading this sentence will have difficulties following the writer’s line of thought because of the longer sentence length and unnecessary information included. In contrast, the text written in STE is much more to the point and simply distils what is pertinent to the person doing this work:
- The oil is poisonous.
- I must always be careful not to touch oil without protection.
From this example, STE shows us that warnings and cautions must always start with a simple and clear command that is usually substantiated by a reasoning that comes before or after. A command informs the user about the precautionary measures to take to avoid danger. Presenting information as if it were a general comment in the original writing obscures the importance of the message and is not specific enough.
Where can I learn more about STE?
Shufrans TechDocs regularly hosts online training workshops for technical writers, SMEs, and engineers at different time zones for your convenience. To learn more about our diverse course offerings and workshop customisations that we can do for you and your global technical documentation team, speak to us today!
What customers are saying.. | Aerotech Inc.
Senior Technical Writer, Aerotech Inc. “The presentation on rules clarified a lot of things of which I was unaware. I have a much better understanding of how to format lists with colons, when to use obey vs. comply, and the differences between notes, cautions, and warnings. Moving forward, I will be able to utilize the ASD-STE rules more effectively to write better documents.
I appreciated the exercises because they helped me immediately practice and enforce the ASD-STE rules. I like the fact that they were timed. Writing under time constraints forced me to think quickly and fully concentrate on my writing.
I will definitely recommend this training to writers of many fields, especially technical fields. The material, presentation, and instructor are fantastic. I learned a lot about ASD-STE. Even though I’ve been using this writing convention for almost eight years, formal training brought much clarity and comprehension that I had not previously realized. I now know that an aptitude for writing and a copy of the STE rules is a good start, but not enough. This course takes your understanding to a professional level.”
Lauren Gelli, Senior Technical Writer, Aerotech Inc. “The introduction provided a well-rounded history of ASD-STE, the types of industries that use it, and how they use it. I now have a better understanding of what ASD-STE is and how our company should be using it.
My favourite writing rule is Rule 1.3 (Use approved words only with their approved meanings.) This rule is the heart of STE. It makes consistency, clarity, and comprehension ubiquitous across all documents regardless of who writes them. It is the main rule that unifies writers with one voice.
My favourite STE verbs are Apply, Attach, Make Sure, and Show. The verb Apply has multiple use cases for our documents. The verb Attach is a great utility verb because common alternatives like “mount” are not approved. The verb “make sure” is extremely helpful in cautions and warnings, also in some procedural steps. Finally, the verb “show” is extremely helpful when I write about background processes and how things work in general.”
Kelly Walsh, Technical Writer, Aerotech Inc. “The course intro was helpful. Shumin used examples, videos, and asked us questions to introduce the material. Knowing that the subject matter could be dry, she tried to counteract that by varying the presentation. The information itself was useful for what we did later in the course.
My favourite rules are the word count rules. That sounds lame, but I tend to write too long of sentences that don’t get to the point. The exercises were really helpful in demonstrating the rules that we had talked about / gone over. I got the most out of doing the exercises and working on the examples that we submitted.
I would definitely recommend the course to someone considering or currently using STE. Shumin catered the course to our needs and familiarity level. She was very knowledgeable and was happy to help us through trouble spots and answer our questions.”
An innovative approach to consider for your global documentation landscape
Over the last three decades, STE has emerged as a rather important and universal standard for technical English. Predictably, as a result of language standardisation, STE helps us to achieve a number of benefits. Technical writers become more consistent on a word level. This starts with the simple fact that we are going to use the same word whenever we refer to the same thing, so that means an improved level of consistency and consequently quality improvements.
