content strategy Archives | Shufrans TechDocs Home // content strategy Archives | Shufrans TechDocs

Middle East & Africa Online Workshop: ASD-STE100 Simplified Technical English workshop for all industries

Middle East & Africa Online Workshop: ASD-STE100 Simplified Technical English workshop for all industries

ASD-STE100 Simplified Technical English workshop for all industries

Dates: 27 & 28 January 2020

Plan later: 

  1. 19 & 20 February 2020
  2. 4 & 5 March 2020.

Time: 09:00 to 17:00 Gulf Standard Time [MEA]

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.

I’ve found all the rules introduced in this workshop equally valuable and applicable in my field of work. The ASD-STE100 Specification is very useful for searching examples and finding STE compliant alternatives. It was also great that we has such a large number of practical exercises. Personally, it would be more valuable to have more context available. This helps us judge how to apply STE optimally. Thank you Shumin! Your workshop was concise, clear, and pragmatic. I also liked the occasional humour! 🙂 Diane Goodrick, Information Architect/ Author Trainer, 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.

 

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.

Join a certified ASD-STE100 Simplified Technical English training workshop in Auckland, New Zealand

Join a certified ASD-STE100 Simplified Technical English training workshop in Auckland, New Zealand

Quick facts

Dates: 19 – 20 April 2017

Location: Auckland, New Zealand

Length of training: 2 days

Fee: 1,850 NZD

Early bird registration: Before 28 March 2017

Sign up early to enjoy a 20% training discount

Deadline for registration: 10 April 2017

Summary

Simplified Technical English (STE) stresses on the use of unambiguous terminology where one word only has one meaning. This reduces the likelihood of using synonymous terms that can result in confusion. Optimum re-usability of technical terms on the word, phrase, and sentence levels is to be expected. This will greatly improve any product life-cycle management process.

Technical documentation that is written in STE becomes easier for non-native speakers of the English language to understand. The resulting text is much easier to translate which is especially relevant when machine translation is part of your localization strategy. Preparing your technical content with ASD-STE100 ensures quality at the source and prepares you for future-proof translation processes.

Said Ms Shumin Chen, principal ASD-STE100 trainer: “The benefits of implementing and writing in Simplified Technical English (STE) are manifold – audience engagement through high-quality content, improved product safety, lower life cycle cost and reduced logistics footprint!”

“The ASD-STE100 course I attended by Shumin was very intensive yet enjoyable. Besides the standard format and company templates used when creating documentation, STE rules helped me understand that there is an alternative approach to technical writing. Top Qualities: Effective, versatile, high-quality training delivery.” Manufacturing Engineer, FNSS Defence Systems

Course outline*

  • Practical overview of ASD-STE100 Simplified Technical English
  • How STE helps both native & non-native speakers of English
  • Writing rules and how to apply them in practice
  • How to use the general vocabulary
  • How to deal with industry-specific terminology
  • How to use STE for various documentation types
  • How to implement STE with minimal disruption to on-going production and existing documentation
  • Hands-on STE editing and review

Who should attend?

  • Compliance managers
  • CIO, COO, CTO
  • Customer support managers
  • Documentation managers
  • Editors
  • Engineering managers
  • Engineers and SMEs who create documentation
  • ILS managers
  • Maintenance managers
  • MRO personnel
  • Operation managers
  • Product managers
  • Project managers
  • Quality managers
  • Technical writers
  • Translation managers
  • Translators

What training outcomes to expect?

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.

Our interactive training, exercises and workshop let participants 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.

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

2-day certified Simplified Technical English training workshop in Muscat, Oman

2-day certified Simplified Technical English training workshop in Muscat, Oman

Quick facts

Dates: 1 – 2 March 2017

Location: Muscat, Oman

Length of training: 2 days

Early bird registration: 1 February 2017

Sign up early to enjoy a 20% training discount

Deadline for registration: 15 February 2017

Summary

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

It is important that operation and management information be understandable to the target audience. Sometimes, operation information is conveyed through a less-than-optimum selection of words. The manufacturer’s technical language can result in incomprehensible operation documentation.

Course outline*

This course introduces the underpinning principles of STE and its most practical application. We will explain the underlying principles of STE grammar rules and offer participants the opportunity to apply what they have learnt in a highly interactive classroom environment.

  • Practical overview of ASD-STE100 Simplified Technical English
  • How STE helps both native & non-native speakers of English
  • Writing rules and how to apply them in practice
  • How to use the general vocabulary
  • How to deal with industry-specific terminology
  • How to use STE for various documentation types
  • How to implement STE with minimal disruption to on-going production and existing documentation
  • Hands-on STE editing and review

* 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
  • ILS managers
  • Maintenance managers
  • Operation managers
  • Product managers
  • Project managers
  • Quality managers
  • 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.

 

 

Dozuki Workshop Series – Optimize your technical content (Part 3 of 3)

Dozuki Workshop Series – Optimize your technical content (Part 3 of 3)

Read Part 1 & 2 of our blog series here:

Dozuki Workshop Series – Optimize your technical content (Part 1 of 3)

Dozuki Workshop Series – Optimize your technical content (Part 2 of 3)

In this final installment of our three-part text analysis, we highlight areas for improvement, then provide the same information based on Simplified Technical English (STE) writing rules.

RULE: 5.1 Keep procedural sentences as short as possible (20 words maximum).

RULE: 9.2 When you combine words to make a phrase, make sure that each word continues to obey the meanings given to them in the Dictionary.

1a) Standard English:

Hold onto your iPhone securely and close the handle of the iSclack to separate the suction cups, pulling the front panel up from the rear case.

1b) STE:

Hold your iPhone tightly and close the iSclack handles. The suction cup at the top will pull the front panel up from the rear case.

Analysis:

In this rewrite, it is not necessary to create a phrasal verb such as ‘hold onto‘ to add emphasis to the verb ‘hold‘. Also, the objective of this step is to remove the front panel from the rear case. For this reason, we rephrased the sentence to clearly show which components need to be removed, using which tools. It is also recommended to write short, simple to understand sentences in procedural-type instructions.

 

RULE: 1.17  Make your instructions as specific as possible.

2a) Standard English:

The iSclack is designed to safely open your iPhone just enough to separate the pieces, but not enough to damage any cables.

2b) STE:

The iSclack can safely open your iPhone without damage to the cables.

Analysis:

In this rewrite, we reduced the number of words from 21 to 12. The Standard English sentence above seems  rather excessive in trying to explain the use of the iSclack, when it is sufficient to say that the iSclack tool is safe to use, without going into unnecessary details, such as design.

 

RULE: 1.1 Only use approved words in the dictionary

3a) Standard English:

Skip the next three steps and continue on to Step 8.

3b) STE:

Go to Step 8.

Analysis:

‘Skip’ is an unapproved word in STE, and not quite useful in this context. Simply tell your reader which steps they need to complete next.

 

Missed this session? The on-demand presentation is now available below.

 

 


Shumin Chen

About the speaker

Since 2006, Ms Shumin Chen has been working as a consultant with customers in various industries worldwide: aerospace and defence, banking, consumer products, healthcare, IT, medical and fitness equipment. She has helped many companies with their documentation needs, based on standards where possible, and is widely regarded as a leading expert in ASD-STE100 Simplified Technical English training, aviation documentation and multilingual documentation.

Ms Chen now heads the ASD-STE100 training arm of Shufrans TechDocs. In her current role, Ms Chen continues to focus on the practical implementation of international standards to facilitate the efficient creation and management of multilingual documentation.

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. 

Ready to learn more?

Make STE your strategic partner today!

STE training & consultancy
Simplified Technical English at the core of your documentation strategy

Simplified Technical English at the core of your documentation strategy

Why Simplified Technical English (STE)?

Whether you are looking to implement working standards such as DITA, S1000D, ATA iSpec 2200, RailDex, or ShipDex to standardise your information structure and facilitate content re-use, it is important to give due consideration to the quality of your source text when creating your technical content. Ambiguous or inconsistently worded documentation can result in non-compliant data deliveries, poor customer support, potential legal liabilities, equipment damage, as well as safety risks.

A well-written source text ensures the ease of downstream content management processes such as translations

Improved readability for your technical content

STE prescribes the use of grammar rules that are relatively more restrictive than the standard rules of the English language.

The general vocabulary has only 900 approved words while explicitly listing 1500 other non-approved words with alternative suggestions.

By introducing these grammar and vocabulary restrictions, technical authors can avoid writing overly long sentences and leave out unnecessary technical details where applicable, all of which are obstacles to the ease of readability and sound understanding.

Recommended by global documentation standards

Military defence standards (MIL-SPEC / MIL-STD) such as MIL-STD-3048, as well as technical documentation standards like S1000D and ATA iSpec 2200 recommend the use of ASD-STE100.

Although the S1000D standard was originally intended for the aerospace and defence industry, this widely successful specification has been customised for the shipping and train manufacturing and operations communities giving rise to both ShipDex and RailDex. Likewise, sound and consistent STE writing rules are highly applicable and practical for use across industries.

Simplifying or eliminating the need for translations?

STE is an international aerospace standard that helps to make technical documentation easy to understand. However, the benefits of STE have proven very highly applicable to all industries. That is why 60% of STE users today come from industries outside of aerospace & defence.

Understandably, STE was designed with non-native speakers of the English language in mind. By providing technical writers with a common set of standardised writing rules and general vocabulary, STE enables teams of writers to write technical manuals that are consistently accurate and require less proofreading and editing effort. Consequently, this does away with the need for translations altogether.

Besides the aerospace maintenance industry however, product exports are still subjected to much scrutiny in terms of their paperwork, documentation and associated product translations. Therefore, the use of STE to create technical content can support downstream translation processes in several ways:

  • A 900-word general vocabulary dictionary eliminates the need for other non-approved, and possibly uncommon synonyms. This reduces the likelihood of term-related clarifications and queries from translators, resulting in faster translation processes.
  • Enforcing STE rules strictly guarantees a high level of consistency at word-, phrase-, and sentence-levels.  This allows project managers to leverage on existing translation memories to substantially reduce translation costs.
  • With fewer technical terms to translate and a more uniform translation memory, translators can provide cheaper, faster and better translations thanks to STE.
  • Having STE content in place will result in exceptional translation quality with machine translations as well.

 

In a nutshell

For many years now, the use of STE as a controlled language authoring strategy has successfully taken off not just at large organisations, but also in small and medium enterprises.

With professional Simplified Technical English training that costs only a fraction of supposed “full implementation”, and yet achieves 75% – 85% of the benefits and results of an approach that includes checker software, getting started with STE is no longer the major and expensive investment it used to be.

Training technical writers and engineers to write in STE within two to three days may sound like a simple and straightforward undertaking. However, to change the way your technical authoring team works does require some managerial direction while the team transits to STE. Trained technical writers will experience on a more regular basis, the many benefits that STE as a controlled language writing strategy offers.


Shumin Chen

About the author

Since 2006, Ms Shumin Chen has been working as a consultant with customers in various industries worldwide: aerospace and defence, banking, consumer products, healthcare, IT, medical and fitness equipment. She has helped many companies with their documentation needs, based on standards where possible, and is widely regarded as a leading expert in ASD-STE100 Simplified Technical English training, aviation documentation and multilingual documentation.

Ms Chen now heads the ASD-STE100 training arm of Shufrans TechDocs. In her current role, Ms Chen continues to focus on the practical implementation of international standards to facilitate the efficient creation and management of multilingual documentation.

Copyright © 2015 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