October 2017 | Shufrans TechDocs Home // October 2017 | Shufrans TechDocs

Elevating cities of the future | Schindler Elevator Corporation

Elevating cities of the future | Schindler Elevator Corporation

STE as part of your global content strategy

Simplified Technical English as part of your content strategy

Schindler’s success is driven by their commitment to traditional core values such as customer service, quality, and safety, combined with our key strengths of creativity and innovation to produce intelligent solutions in response to customer needs. More than 66,000 Schindler employees work around the clock to serve 1.5 billion people using our elevators and escalators every day. Safety for each one of our passengers and employees is foremost.

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.

 

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 will 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.

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:

  1. The oil is poisonous.
  2. 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.. | Schindler Elevator Corporation

Marco Valtangoli, Corporate Technical Author, Schindler Management
“A sometimes missed, yet very important point highlighted during the introduction is that STE is an English language specification that is not only applicable for companies in the aerospace & defence industry. Rule 5.2 where you only have one instruction per sentence is important to us. Not being able to use the verb “CHECK’ that is only used as an approved STE noun poses a challenge to me all the time. I really appreciate the STE writing rules that give us the possibility to improve the consistency of our documents.
The workshop exercises were of high-interest value and drive home the point that it is important to learn by doing. Although a time-consuming process, the writing workshop impressed on me that the need to prioritise the analysis of our internal documents.
Shumin is a competent trainer who does not only focus on explaining and enforcing the “writing rules”, but is always available to understand and empathise with the training needs of the class.”

Sylvia Helfenstein, Technical author, Proofreader “The information presented was clear and succinct. The exercises provided helped me understand and grasp the concept of Simplified English from the very beginning of the training. A 10/10 rating from me. When it comes to rules about Simplified English writing, I very much like the use of active voice, having a list of approved verbs as a useful resource, and the encouraged use of pronouns (you, we, it, them). To me, clear rules are the bedrock of consistent text and document creation.
I’ve found the STE exercises very useful since the examples in them are well focussed and cover issues we encounter in our daily work. Overall, I have found this training workshop to be well-structured, Shumin came well prepared, was well organised, clear & an easy speaker to follow. Thank you for the great training!”

Cécile Roos, Corporate Translation Manager, Schindler Management Ltd
“Entertaining, short, and clear presentation of the STE specification and rule sets. Overall, a good mix of rules, examples, and exercises. The course was very much on point and encouraged me to write in a more structured way. This will help the readers to properly understand my message even in business writing. Shumin had a very calm way of leading all of us through the training. Her style of teaching is rather empathetic and she keeps the group working effectively with timely breaks in between. Thanks Shumin for an enjoyable course with the perfect score of 10/10 in terms of trainer evaluation.”

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.