incubator Archives | Shufrans TechDocs Home // incubator Archives | Shufrans TechDocs

APAC Online Workshop: Write effective user manuals & instructions with Simplified Technical English

APAC Online Workshop: Write effective user manuals & instructions with Simplified Technical English

Write effective user manuals & instructions with Simplified Technical English

Dates:  3 & 4 February 2020

Plan later: 

  1. 27 & 28 February 2020.

Time: 09:00 to 17:00 UTC/GMT +08:00 [Asia Pacific]

Length of training: 2 days

Course fee: 450 EUR**

Course registration ends one week before training commences.

**Course fee includes exercises, learning aids, certificate of completion, and 90-day post-training support.

Summary

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. STE helps to make translations cheaper and more accurate. Often a formal requirement for aircraft and defence maintenance documentation, STE can easily be adapted to all technical industries and beyond. Ms. Shumin Chen will teach participants how to correctly and effectively use STE in practice. She will also address some of the mistakes commonly found in technical writing and the frequently incorrect use of common STE writing rules.

Shumin gave us a an all-rounded presentation to Simplified Technical English. Personally, rule 1.3: To use only approved words with their approved meaning holds the key to successful controlled language implementation. Rules 3.4, 3.6, 4.1, 5.3, and 5.5 are also among my favourites. The approved verb TO MAKE SURE THAT can come in very handy for technical writers as well. The presentation of STE rules offers quite a detailed overview that includes not only language rules but good, old technical authoring principles in general. It has been very helpful for us to learn and understand the concept of STE. I have found Shumin to be very competent in STE and will defnitely recommend her course! Eric, Head of Corporate Technical Documentation (CTD), Schindler Group.

Course outline*

  • Day 1: Classroom Training
    1. Practical overview of Simplified Technical English
    2. How STE helps both native & non-native speakers of English
    3. Benefits of adopting the STE international writing standard
    4. Writing rules and how to apply them in practice
    5. How to use the general vocabulary.
    6. Approved and non-approved words discussion and the rationale behind.
  • Day 2: Application, Review, & Exercises
    1. How to deal with industry-specific terminology
    2. How to use STE for various documentation types
    3. How to implement STE with minimal disruption to on-going production and existing documentation
    4. Practical workshop session for applying STE rules to your own documents
    5. Review, edit, and discuss participants’ own documents to reinforce learning
    6. Classroom presentation of own documents.

* Shufrans also offers customised ASD-STE100 training solutions tailored to meet your specific requirements. These courses are normally provided at the customer’s premises.

Who should attend?

  • Compliance managers
  • CIO, COO, CTO
  • Customer support managers
  • Documentation managers
  • Editors
  • Engineering managers
  • Engineers and SMEs who create documentation
  • Graphics specialists
  • ILS managers
  • Maintenance managers
  • Operation managers
  • Product managers
  • Project managers
  • Quality managers
  • Software research engineers
  • Technical illustrators
  • Technical writers
  • Translation managers
  • Translators.

What training outcomes to expect?

Our interactive training, exercises and workshop, will teach participants to standardise content to:

  • Author more efficiently
  • Communicate more effectively with a global audience
  • Improve operational safety
  • Reduce AOG / downtime
  • Facilitate modular writing and reuse
  • Facilitate teamwork
  • Facilitate translation
  • Maximise consistency
  • Optimise product lifecycle support
  • Reduce the cost of creating and maintaining technical publications.

Trainer’s qualifications

Ms. Shumin Chen, principal trainer & consultant at Shufrans TechDocs received her professional on-the-job training in the field of STE under the tutelage of Dr Frans Wijma, a linguist and documentation expert. Together as an experienced global team, they provided their combined knowledge and dedication to benefit customers worldwide. To date, they have provided training and consultancy services to over 180 companies. Shufrans TechDocs is the only company with such vast experience in providing certified STE training.

Shumin has supported various companies with their STE and other documentation needs, based on standards where possible. Although STE was developed for the aerospace industry, more specifically for aircraft maintenance documentation, Shumin found that it made a lot of sense to apply the same principles to other industries and types of documents as well. Few -if any- changes to the specification are necessary to adapt STE to industries ranging from machinery to IT, automotive to medical equipment.

Different industries, one technical language?

Different industries, one technical language?

Given the success of Simplified Technical English (STE) and its adaptability, it was over time applied to various document types, and increasingly also in other (mainly technical) industries. In the aerospace and defence industries, safety, efficiency and readability are the main considerations for the use of STE. In many other industries, such as machinery, automotive, electronics, IT and medical equipment, another important consideration is to save on translation cost without compromising on translation quality.

 

Simplified Technical English (STE) rules describe sound writing practices

STE is an aerospace standard, or at least it started off as an aerospace standard. That having been said, out of those 65 writing rules, I couldn’t name a single one that is aerospace-specific. Take these STE rules for example:

  1. Do not make long sentences (maximum 20 words for procedures, 25 words for descriptive text).
  2. Do not use clusters of more than 3 nouns.
  3. Only use simple verb tenses.
  4. When you give an instruction, use the imperative/command form of the verb.

Well, most of us will have seen this kind of rules. We don’t like long sentences and Simplified Technical English tells us that for procedures or tasks there should be no more than 20 words in one sentence. For descriptive text we are allowed some more flexibility, and we need that, we have up to 25 words. Also English is a rather problematic language in that it allows us to just put any number of nouns into a cluster, and this makes it very difficult at times to see the relationship between the nouns in those clusters. For example ‘left engine switch’ can already be confusing, and difficult to understand, difficult to accurately translate.

If I say ‘left engine switch’, does that mean it is the switch for the left engine, or is it the left switch for a specific engine? So, do ‘left’ and ‘switch’ or ‘left’ and ‘engine’ belong together most directly?

In this case, the use of prepositions such as ‘of’, or ‘for’ will help to clarify this. Take the example of the ‘runway light connection resistance calibration‘. While it is common to see noun clusters made from several words  in technical language, clusters that are too long will mean that your reader has to make his way through four modifying words to reach the main noun.

For technical writing professionals who are considering the option of implementing Simplified Technical English (STE) in their organisation, you now see that many of the STE writing principles are very valid for all technical documentation purposes.

 

One STE rule that can transform your technical writing skills

One valuable STE rule is the rule that I would consider the most important one: Only use approved words. This is where Simplified Technical English becomes really different from corporate style guides. Why? Because the STE language standard includes a core vocabulary (or general dictionary) of around 930 words that will let you write just about everything that you need for technical documentation, even for procedural information in general.

We find that roughly 95% of the words in the STE general dictionary can be easily adapted even for general banking, like financial aspects of banking information. The set-up of the STE standard is such that you can very easily adapt the STE to suit and cover your specific needs. It mainly entails additions to the dictionary which are customarily made, even for aerospace customers. Because even within aerospace, there is a lot of variation when it comes to vocabulary, terminology, especially when dealing with different systems on board an aircraft.

ASD-STE100-coffee-machine

As a very simple example, one of our customers actually makes coffee machines. Now coffee machines seem to have nothing to do with aircraft. However, I think 98% of passenger aircraft actually have coffee machines on board, and they need their documentation in Simplified Technical English.

Now if this coffee machine happens to be in an office, or in a medical practitioner’s practice, or in a cafeteria, would it really require documentation that is all that different from the documentation on board an aircraft? No.. If anything at all, we just restrict the rules a little bit less. Aerospace tends to be a little bit more restrictive, we just relax the rules a little bit for other industries.

 

Copyright © 2016 Shufrans TechDocs. All rights reserved. No part of this article may be reproduced or transmitted in any form or by any means whatsoever without express written permission from the author, except in the case of brief quotations embodied in critical articles and reviews. 

Are you ready to make STE your strategic partner?

Attend a 2-day certified ASD-STE100 workshop at any of our worldwide locations