technical writing Archives | Page 3 of 4 | Shufrans TechDocs Home // technical writing Archives | Page 3 of 4 | Shufrans TechDocs

The common denominator for credible & concise documentation across industries

The common denominator for credible & concise documentation across industries

TCLoc Master article on The common denominator for credible & concise documentation across industries by Ms. Shumin Chen, Principal ASD-STE100 Trainer & Consultant.

First published on TCLoc Master Blog • University of Strasbourg • 4 December 2017

Safety, efficiency, and readability are the main considerations for the use of ASD-STE100 Simplified Technical English (STE) in the aerospace and defense industries. For many other industries, such as machinery, automotive, electronics, IT, and medical equipment, another important consideration is to save on translation costs without compromising on translation quality. As technical communicators, navigating the tricky terrains of cost, quality, and efficiency in project management can be an extremely delicate equilibrium to maintain.

Standards

To technical communication professionals, it makes a lot of sense to use standards whenever possible to achieve similar results. However, standards in the documentation field are often disregarded. Documentation always kicks in when the product is already behind schedule, and over budget for the product life-cycle. However, we still want to stand behind what we do and make sure we provide a quality product. How does a written language standard potentially help us to achieve this and why do we need a controlled language such as STE to begin with?

Consider the following example:

Standard English:

Follow these instructions to prevent potential failures and damage and to ensure as safe and trouble-free functioning of the product as possible. Read this manual before starting to work with the filter system, familiarize yourself with the functionality and operation of the product and follow the instructions.

STE:

FOR SAFE OPERATION, OBEY THESE INSTRUCTIONS TO PREVENT POSSIBLE FAILURES.
READ THIS MANUAL BEFORE YOU START TO DO WORK WITH THE FILTER SYSTEM. KNOW THE PRODUCT FUNCTION AND OPERATION, AND OBEY ALL INSTRUCTIONS.

Which set of instructions lets you understand and complete the procedure with greater ease?

 

2018 ASD-STE100 Simplified Technical English training workshops in Singapore

2018 ASD-STE100 Simplified Technical English training workshops in Singapore

Write effective user manuals & instructions with Simplified Technical English

18 – 19 April 2018

13 – 14 August 2018

3 – 4 December 2018

Location: Singapore

Length of training: 2 days

Deadline: Registration ends two weeks before the commencement of every workshop

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.

This two-day professional training course is intended for technical authors to familiarise themselves with the ASD-STE100 controlled language specification through a series of classroom- and workshop-type instruction and interaction.

STE improves quality, both in the aviation and defence industries, where it is often mandatory for safety & security reasons, and in any other technical industries. 

We use the latest version of the ASD-STE100 specification: Issue 7, January 2017.

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

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

“The introduction to the ASD-STE100 gave me a nice and clear overview of what to expect in the two training days that followed. Consistent language and spelling in STE are the rules I like best. The list of approved and unapproved verbs was a nice surprise for me. Shumin gave a highly practical STE training using relevant and pragmatic examples that relate closely to our field of work.” Maikel Kornuit, Technical Author, Triview.

This training workshop is organised in collaboration with Asia Technical Services Pte Ltd, our preferred training partner in the ASEAN region.

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 will I learn?

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

 

 

 

 

ASD-STE100 Simplified Technical English workshop for all industries, 27 – 29 September 2017 in Ankara, Turkey

ASD-STE100 Simplified Technical English workshop for all industries, 27 – 29 September 2017 in Ankara, Turkey

Quick facts

Dates: 27 – 29 September 2017

Location: Ankara, Turkey

Length of training: 2.5 days

Early bird registration: 5 September 2017

Sign up early to enjoy a 20% training discount

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*

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

 

 

Customise your Simplified Technical English Workshop with us today!

Customise your Simplified Technical English Workshop with us today!

Design your own Simplified Technical English writing and editing workshop in Holland

Amsterdam, 9 – 11 April 2018

Eindhoven, 4 – 6 June 2018

Utrecht, 10 – 12 December 2018

Length of training: 1, 2, or 3 days

Deadline: Registration ends two weeks before the commencement of every workshop

Cost per participant: From 395 EUR onwards

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. Language standardisation helps us to achieve a number of benefits. We become more consistent on a word level that 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. The same happens to sentence structures or phrases.

Followed this course last February and truly learned a lot. Shumin is very experienced and really knows what she is talking / teaching about. Recommended for all manual writers!

– Hans Harlé, Entecst Technical Communication

Course outline*

Participants have the flexibility of attending a 1, 2, or 3-day training session with us.

  • Day 1: Classroom Training
    1. Practical overview of ASD-STE100 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.
  • Day 2: Application, Review, & Exercises
    1. Approved and non-approved words discussion and the rationale behind.
    2. How to deal with industry-specific terminology
    3. How to use STE for various documentation types
    4. How to implement STE with minimal disruption to on-going production and existing documentation
  • Day 3: Extended Writing Workshop
    1. Practical workshop session for applying STE rules to your own documents
    2. Review, edit, and discuss participants’ own documents to reinforce learning
    3. Classroom presentation of own documents.

* Shufrans also offers customised technical English training solutions tailored to meet your specific requirements. These courses are normally provided at the customer’s premises or at our offices in Singapore.

Who should attend?

  • Compliance managers
  • Communication managers
  • Content specialists
  • Content strategists
  • Content quality analysts
  • CIO, COO, CTO
  • Customer support managers
  • Documentation specialists
  • Editors
  • Engineering managers
  • Engineers and SMEs who create documentation
  • Field support engineers
  • HSE managers
  • ILS managers
  • Information developers
  • International process managers
  • Operation managers
  • Product managers
  • Programme managers
  • Project managers
  • Quality assurance managers
  • Safety inspection engineers
  • Service & Maintenance managers
  • Supply Chain Managers
  • Technical administrators
  • Technical documentation consultants
  • Technical information managers
  • Technical linguists
  • Technical publications managers
  • Technology services advisors
  • Technical writers
  • Translation managers
  • Translators

What will I learn?

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, will teach participants to standardise content to:

  • Author more efficiently
  • Communicate more effectively with a global audience
  • Improve operational safety and reliability
  • Reduce AOG / downtime
  • Facilitate machine and human translation
  • Facilitate modular writing and reuse
  • Facilitate teamwork
  • 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.

 

 

ASD-STE100 Simplified Technical English training workshop for individual writers in the UAE

ASD-STE100 Simplified Technical English training workshop for individual writers in the UAE

Quick facts

Dates: 15 – 17 January 2018

Location: Abu Dhabi, UAE

Length of training: 1 to 3 days

Participants have the flexibility of attending a 1, 2, or 3-day training session with us.

Deadline for registration: 8 January 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.

Course outline*

  • Participants have the flexibility of attending a 1, 2, or 3-day training session with us.
    • Day 1: Classroom Training
      1. Practical overview of ASD-STE100 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.
    • Day 2: Application, Review, & Exercises
      1. Approved and non-approved words discussion and the rationale behind.
      2. How to deal with industry-specific terminology
      3. How to use STE for various documentation types
      4. How to implement STE with minimal disruption to on-going production and existing documentation
    • Day 3: Extended Writing Workshop
      1. Practical workshop session for applying STE rules to your own documents
      2. Review, edit, and discuss participants’ own documents to reinforce learning
      3. 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.

 

Learning how to optimally use a documentation standard like ASD-STE100 is a substantial boost to our technical writing team’s capabilities and significantly improved our compliance rating! Raja Sureshbabu, Global Head of Aerospace Vertical, Tata Consultancy Services.

 

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.

 

 

 

 

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.

 

 

Open Simplified Technical English workshop in Tampere, Finland

Open Simplified Technical English workshop in Tampere, Finland

Quick facts

Dates: 27 – 28 October 2016

Location: Tampere, Finland

Length of training: 2 days

Early bird registration: Before 7 October 2016

Sign up early to enjoy a 20% training discount

Deadline for registration: 20 October 2016

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.

STE is a ‘way of life’ in the field of technical writing and documentation. The ASD-STE100 exercises covered a wide spectrum of topics from choosing between approved and non-approved words to recreating documentation in STE. Shumin expertly guides us from classroom learning mode to real-life practical application of STE rules. The materials that she presented were informative and very convincing.” Martin Broekhuis, Technical Editor, Webasto.

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

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

This training workshop is hosted by Citec Finland, our preferred training partner in Finland.

STE workshop Tampere by Shufrans

 

 

 

International Standards at Shufrans TechDocs

International Standards at Shufrans TechDocs

Safety starts with quality. The best product is only as good as its documentation and technical data allow the customer to make optimum use of it. Formerly known as Simplified English, Simplified Technical English (STE) is an international standard (ASD-STE100) that helps to make technical documentation easy to understand.
Simplified Technical English standardises vocabulary, grammar and style, while letting users control their specific terminology.

Although Simplified Technical English originates from the aerospace and defence industries, it can easily be customised and applied to any other industry.

Using guidelines from the ASD-STE100 specification, writers and editors can take document clarity and consistency to the next level. Text written in Simplified Technical English shows improved readability and translatability. These benefits should not be overlooked as products and their accompanying documentation are increasingly shipped to many countries worldwide where English is not the main language used. Consequently, whether the majority of your audience is made up of native or non-native speakers of the English language, getting your message across clearly becomes faster and easier.

Text based on Simplified Technical English is also cheaper and faster to translate. Users of your documentation will benefit from higher translation quality, and mistranslations become less of a concern.
Injuries, losses and costly legal liabilities can happen as a result of unclear documentation and ambiguous translations. Simplified Technical English is based on standardised terminology and simple grammar rules. Consistent terminology facilitates your task of indexing and helps users to find pertinent information faster by eliminating unnecessary synonyms and spelling variants.

 

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
How ASD-STE100 Simplified Technical English can help you save time and cost

How ASD-STE100 Simplified Technical English can help you save time and cost

STVY (Finnish STC) article on ASD-STE100 Simplified Technical English by Dr. Frans Wijma. Nakyma-STE-article

First published in Suomen teknisen viestinnän yhdistys ry. • The Finnish Technical Communications Society • Näkymä Joulukuu/December 2012

Rules regulate the choice and use of words, building phrases and sentences, the use of articles, the verb tenses that can be used and (to some extent) the punctuation. Some of the rules are specific to procedural or to descriptive text. Part of the rules is generally known to professional communicators, but the overall set is in general rather nicely balanced while going beyond most corporate and general style guides..