News & Events | Shufrans TechDocs Home // News & Events | Shufrans TechDocs

The Perilous Afterthought: Why Product Documentation Cannot Be an After-the-Fact Endeavour

The Perilous Afterthought: Why Product Documentation Cannot Be an After-the-Fact Endeavour

In the fast-paced world of product development, especially within critical sectors like aerospace, defence, and manufacturing, the allure of rapid iteration and quick deployment can be overwhelming. However, this urgency often leads to a critical oversight: treating product documentation as an afterthought. This practice, while seemingly efficient in the short term, is a recipe for disaster, a potential malpractice that can have far-reaching consequences.

The Pitfalls of Post-Production Documentation:

  • Inaccurate and Incomplete Information: When documentation is created after the product is finalised, crucial details can be lost or misinterpreted. Developers, having moved on to new projects, may struggle to recall specific design decisions or implementation nuances. This leads to inaccurate or incomplete documentation that fails to serve its intended purpose.
  • Increased Risk of Errors and Accidents: In industries like aerospace and defence, where precision and safety are paramount, inadequate documentation can have catastrophic repercussions. Without clear and comprehensive instructions, operators and maintenance personnel are at a heightened risk of making errors, potentially leading to equipment malfunctions, accidents, and even loss of life.
  • Higher Maintenance and Support Costs: Troubleshooting and maintenance become significantly more complex when documentation is lacking. Support teams spend excessive time deciphering cryptic code or reverse-engineering design flaws, leading to increased costs and prolonged downtime.
  • Compliance and Regulatory Issues: Aerospace, defence, and manufacturing are heavily regulated industries. Comprehensive documentation is often a mandatory requirement for compliance. Failing to provide accurate and up-to-date documentation can result in hefty fines, legal penalties, and even product recalls.
  • Hindered Knowledge Transfer and Training: Effective documentation serves as a vital tool for knowledge transfer and training. When documentation is incomplete or inaccurate, it hinders the ability of new employees and operators to quickly grasp the intricacies of the product, leading to inefficiencies and potential errors.
  • Damage to Reputation and Trust: In industries where reliability and safety are paramount, inadequate documentation can severely damage a company’s reputation and erode customer trust. When customers encounter issues due to poor documentation, they are less likely to rely on the company’s products in the future.

Why This is Malpractice, Especially in Critical Industries:

In aerospace, defence, and manufacturing, the stakes are exceptionally high. Products are often complex, mission-critical, and subject to stringent safety standards. Treating documentation as an afterthought in these sectors is not merely an oversight; it’s a potential malpractice.

  • Safety-Critical Applications: In these industries, products are often used in safety-critical applications where human lives are at stake. Errors resulting from inadequate documentation can have dire consequences.

  • Long Product Lifecycles: Aerospace and defence products often have exceptionally long lifecycles. Proper documentation ensures that the product can be maintained and supported for decades.
  • Complex Regulatory Landscapes: These industries operate within complex regulatory landscapes that demand meticulous documentation. Failure to comply can lead to severe penalties.
  • High Cost of Failure: The cost of failure in these industries is exceptionally high, both in terms of financial losses and potential loss of life.

 

 

The Solution: Integrating Documentation into the Development Process:

The solution lies in integrating documentation into the product development process from the very beginning. By treating documentation as a core component of the product, companies can ensure accuracy, completeness, and consistency.

  • Early Planning and Collaboration: Documentation should be planned and initiated during the early stages of product development, with close collaboration between developers, technical writers, and subject matter experts.
  • Continuous Updates and Revisions: Documentation should be continuously updated and revised throughout the product lifecycle to reflect any changes or modifications.
  • Utilising Modern Documentation Tools: Leveraging modern documentation tools and technologies can streamline the documentation process and improve efficiency.

By prioritising product documentation and integrating it into the development process, companies can mitigate risks, enhance safety, and build trust, particularly in the demanding and critical sectors of aerospace, defence, and manufacturing.

🔗 Analyse your documentation needs and get recommendations and tailor-made solutions to help you establish and improve your documentation processes: https://www.shufrans-techdocs.com/services/consultancy/

ASD-STE100 Issue 9: Simplified Technical English Becomes a Global Standard

ASD-STE100 Issue 9: Simplified Technical English Becomes a Global Standard

The latest version of Simplified Technical English (STE), Issue 9 of ASD-STE100, arrived on January 15, 2025. This update, three years in the making, signifies more than just a revision; it marks STE’s transition from a specification to a full-fledged international standard.

Developed by the ASD Simplified Technical English Maintenance Group (STEMG) with input from national and multi-country Support Teams (STEST), Issue 9 reflects a commitment to clarity, safety, and alignment with international standards. The STEMG, comprised of industry experts and linguists, meticulously reviewed 160 items and change forms, including 11 specifically related to meta-terminology. This collaborative process ensures the standard meets the needs of technical writers and, ultimately, the end-users of the documentation.

 

👩🏻‍💻 Find the right expert to support you with ASD-STE100 training and consultancy: www.asd-ste100.net

From Specification to Standard: A Key Shift

This isn’t just a name change. The move to “standard” reflects STE’s broader applicability. While a specification governs individual projects, a standard establishes universal rules. The official document title now reflects its registered trademark: “ASD-STE100 Simplified Technical English: Standard for Technical Documentation.”

Originally designed for aerospace and defense, STE is now used across various sectors, including rail, medical, automotive, and renewable energy. Its focus on clear, unambiguous language reduces human error, especially for non-native English speakers, leading to improved documentation quality, enhanced safety, and smoother global communication.

The Core of STE: Rules and Dictionary

ASD-STE100 is built on two pillars: writing rules and a controlled dictionary. The rules provide strict guidelines for grammar, style, and sentence structure, making content easily understandable for a global audience. The dictionary lists approved words, their definitions, and usage examples, along with a list of unapproved words and alternatives. This standardization of terminology ensures consistency and avoids confusion.

What’s New in Issue 9?

While no new rules were added, 31 of the 53 existing rules were clarified. The dictionary saw significant updates, with 555 entries revised for accuracy and relevance. A major focus was the meta-terminology review. In the context of ASD-STE100, terminology refers to the words and phrases used within the standard itself, such as “technical noun” and “technical verb.” Meta-terminology, on the other hand, refers to the terms used to describe and categorize those terms, such as “noun” and “verb.”

Essentially, meta-terminology is the language we use to talk about the language of the standard. It provides a framework for understanding the relationships between different types of terms and how they should be used.

The distinction between terminology and meta-terminology is important because it helps to ensure that the standard is clear, consistent, and easy to understand. By using precise meta-terminology, the ASD-STE100 Maintenance Group can avoid ambiguity and ensure that the standard is interpreted correctly by technical authors and translators.

Meta-Terminology Refresh: Aligning with International Standards

Issue 9 aligns with ISO 1087-1:2019, modernizing legacy classifications. “Technical name” and “technical verb” are now “technical noun” and “technical verb (term).” Subject field classifications have also been refined, with new categories added under Rules 1.5 and 1.12.

User-Centric Approach: Balancing Precision and Practicality

The STEMG prioritized usability for technical writers, recognizing that most aren’t linguists. Simplicity was key, even while maintaining terminological precision. For example, the dictionary retains the “word” column designation instead of more complex lexicographic terminology. Balancing correct meta-terminology with practical application was a key challenge. The goal was always to empower authors to create clear, accessible documentation. Defining technical verbs, in particular, required careful consideration to ensure both accuracy and ease of understanding.

The Future: AI and Collaboration

The STEMG and STEST are now exploring how AI can enhance STE compliance checks, provide real-time feedback, and automate terminology updates. Collaborations with universities are examining AI-driven tools to streamline technical documentation, improve accessibility, and ensure interoperability.

Issue 9 represents a significant step for ASD-STE100. Its evolution to a global standard, coupled with meta-terminology updates and alignment with international standards, ensures its continued relevance. With a focus on AI and digital transformation, STE is poised to evolve further in the age of smart documentation and Natural Language Processing.

Celebrating a milestone in Simplified Technical English: ASD-STE100 Issue 9

Celebrating a milestone in Simplified Technical English: ASD-STE100 Issue 9

The release of ASD-STE100 Issue 9 is a significant advancement in Simplified Technical English (STE). This latest issue reinforces STE’s position as the leading controlled language for creating clear, concise, and consistent technical documentation across diverse industries.

The Importance of Simplified Technical English

In today’s interconnected world, technical documentation must be readily understood by a global audience, regardless of language proficiency. STE addresses this challenge by providing a structured set of writing rules and a controlled vocabulary that minimizes ambiguity and maximizes comprehension. This results in improved safety, increased efficiency, and reduced translation costs. STE is widely adopted in sectors such as aerospace, defense, manufacturing, energy, and increasingly, in other technical fields.

Key Improvements in Issue 9

ASD-STE100 Issue 9, developed and maintained by the ASD Simplified Technical English Management Group (STEMG), builds upon previous versions with key improvements designed to meet the evolving needs of the technical communication landscape. A primary focus of this release has been the comprehensive review and modernization of legacy terminology. Terms established in the 1980s during the early development of AECMA Simplified English have been meticulously examined and updated, ensuring alignment with contemporary usage and international standards, including ISO 1087-1:2019. This terminological refinement included the reclassification of technical nouns and verbs, enhancing precision and consistency within specific subject domains.

Refining the STE Standard 

While Issue 9 does not introduce entirely new rules, it features important revisions to the wording of 31 of the existing 53 rules. These changes reflect current best practices in technical communication and ensure clarity and ease of application. Furthermore, 555 entries in the STE dictionary, comprising words, definitions, and illustrative examples, have been updated to reflect the latest linguistic and technical conventions.

A Collaborative and Rigorous Development Process

The development of ASD-STE100 Issue 9 exemplifies the collaborative nature of the STE community. STEMG worked closely with academic experts and STE users worldwide throughout the process. A two-month global feedback period allowed for extensive review and input from practitioners, ensuring that the final release is robust and validated by real-world application.

McLaren Receives First Official Copy

In a demonstration of STE’s broad applicability, the first official copy of ASD-STE100 Issue 9 was presented to McLaren, the 2024 Formula 1 Constructors’ World Champions. As a pinnacle of high-performance engineering, McLaren understands the critical importance of precise and unambiguous technical communication. This presentation highlights STE’s value in complex, technically demanding environments beyond the traditional aerospace and defense sectors.

STE is widely adopted in sectors such as aerospace, defense, manufacturing, and energy.

Green, safe, and reliable power | DEIF

Green, safe, and reliable power | DEIF

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

Established in Denmark in 1933, today the DEIF Group is a global market leader in green, safe and reliable control solutions for decentralised power production on land or at sea. In simple terms, DEIF makes sure that power is always available.

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:

  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.. | DEIF A/S

Helene Birkebaek, Technical Writer, DEIF | Power Efficiency “Shumin’s delivery was really good. The STE specification contains a lot of information and she managed to condense it into manageable chunks. This made it easier to grasp the different rules and concepts.

Complex verbs, noun clusters, “ing” words and using the active voice. These are my favourites, because our documents can benefit from using these rules, as these are some of the “common offenders” in terms of STE. I have realised reading through the documentation, that we tend to use complex verbs a great deal along with “ing” words.

The course was brilliant, but for me the biggest benefit was re-writing our own documentation, so I wish I could have spent a bit more time focusing on that. The workshop was managed really well, and this was my favourite part of the course. It was brilliant that Shumin had time to go through some of the re-written text and provide feedback.

Just wanted to say that you have been absolutely brilliant. Not only throughout the course, but also providing brilliant feedback afterwards. Thank you!”

Jeanine Shepstone, Senior Technical Writer, DEIF | Power Efficiency “I love and hate the list of Simplified Technical English (STE) approved and non-approved verbs list. IMHO it’s the strongest tool in STE to stop bad behaviour. The quizzes, worksheets, and exercises were good, but I’d like to have more of them.

With regards to the rewriting workshop, it was great to be able to work on our own content, and to get Shumin’s input as we did so. Thank you! Overall a good course which I’d most likely recommend. Some rework of the way the exercises are done would push the course to be among the very best! Once again, thank you.”

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.

Precision motion control & automation | Aerotech Inc.

Precision motion control & automation | Aerotech Inc.

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:

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

 

 

Unrivalled quality and reliability | Komatsu Mining

Unrivalled quality and reliability | Komatsu Mining

STE as part of your global content strategy

Simplified Technical English as part of your content strategy

Since 1921, Komatsu has stood for unrivalled quality and reliability. These defining principles, along with an emphasis on safety, compliance, and social responsibility, remain part of our Komatsu DNA. With each brand and company added to the Komatsu family, we expand our capabilities, leveraging our global teams to push beyond what can be done to create what can be imagined.

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

Keiko Kawamura, In-house translator, Komatsu Ltd. “I was really satisfied with Shumin Chen‘s easy-to-understand explanation and delivery on the subject of Simplified English. My favourites are “Rule 4.1 Write short and clear sentences.” and “Rule 4.3 Use a vertical list for complex test.” because we can change our long and ambiguous sentences drastically for the better! It was great to have this kind of opportunity to rewrite our documents as a core team because we were able to rediscover gaps between our documentation and STE to be bridged. The rewriting workshop was totally up to my expectations. Shumin, we, all of us, very much appreciate your support! We are very satisfied with your training and eager to learn more about the STE Specification going forward.”

Leonard Smith, Technical writer, Komatsu Mining Corporation “The trainer felt competent and confident in her delivery on the subject matter Simplified English (STE) and its wider application in the industry. The introduction to the STE specification has been very useful for my understanding and application at work. In terms of STE writing rules that demonstrate flexibility, rule 1.6 – Use a word that is unapproved in the dictionary only when it is s technical name or part of a technical name lets us incorporate technical names and verbs unique to Komatsu Mining to be used as part of our industry- and project-specific terminology.

As STE is a new way of writing for us, it is too early to make a judgement at this point. I enjoyed the training, and standards were aligned with expectations. The rewriting exercise was challenging as we had to think in STE terms, the exercise was a learning experience based on our own material which we related to. Shumin, I enjoyed your course, thank you for helping me better understand!”

Komatsu Mining

Kenichi Nagashima, Simplified Technical English (STE) evangelist, Komatsu Ltd. “As the global coordinator who creates and spreads rules to write Simplified English in our company, I am fully aware of the benefits of STE and have found the trainer’s delivery on the subject matter to be very useful. Because I am not a writer, it is difficult to remember all STE rules. When there are any other important rules, rule 3.6 which promotes the use of active voice in procedural sentences making sentences easy to understand is my favourite rule. The rewriting workshop was very useful for me in two ways. I could recognise that the quality of our documents is not satisfactory, and I learned how to make them better. I feel that Shumin Chen has great ability to rewrite sentences in our field (construction equipment), and it is very likely that I will want to recommend this course to others.”

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.

 

 

Making sense together | AMADA Automation

Making sense together | AMADA Automation

STE as part of your global content strategy

Simplified Technical English as part of your content strategy

AMADA Automation Europe Ltd. is committed in the delivery of superior automation solutions for material handling. We believe that Occupational Health and Safety is an important quality indicator. Our vision is that everyone should be able to work and retire healthy. This is achieved by continuously and systematically improving an already safe and secure working environment. It is the basis of all our operations.

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

What customers are saying.. | AMADA Automation

Rasmus Kempe, Technical writer, AMADA automation Ltd “The trainer is well informed on the subject at hand, professional, and to the point. The rule for splitting up noun clusters is such an easy fix (even for standard English) to make text more readable and understandable. Exercise and practice are the only way to learn. This is especially true for this kind of relearning the way we are taught to write in school. I think it was good that real-time assistance was rendered to both teams in an effective manner. I certainly would recommend this course to technical writers and documentation managers who are looking to improve the quality and clarity of their written documentation!”

Jonas Ena, AMADA Automation Europe Ltd “The introduction to Simplified Technical English was very information and highly educative. Writing rule 1.1 to only use approved STE words in the dictionary is a powerful tool that facilitates STE implementation. The rewriting workshop was well managed and lived up to our expectations. I’d recommend this training to anyone who plans to introduce clear writing to their documentation using the principles of Simplified English.”

 

Ronny Flink, Machine Safety Expert and Documentation foreman, Amada Automation “The introduction to Simplified Technical English has been most useful for my understanding of what the specification entails and how it can be applied to our daily work. The trainer’s delivery on the subject matter has been very good. To use only STE valid words is an easy to remember technical writing rule that also yields the greatest benefit for our documentation processes. Overall, the presentation style was clear and easy to understand, and I would most definitely recommend this course to colleagues who wish to implement a robust documentation support work culture within their organisations.”

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.

 

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!

 

 

Safety, cost efficiency, & reliable performance | HIAB Loader Cranes

Safety, cost efficiency, & reliable performance | HIAB Loader Cranes

STE as part of your global content strategy

Simplified Technical English as part of your content strategy

Hiab loader cranes promise safety, cost efficiency and reliable performance. World class safety features keep operators safe and in control, minimising risk to individuals or the environment. State-of-the-art design and build is covered by Hiab’s service and maintenance contracts that guarantee the longevity of your investment.

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

What customers are saying.. | HIAB Loader Cranes

VICTOR MARTINEZ YAGÜE, Certified STE Masterclass participant, Hiab Cranes SL “During the introduction to Simplified Technical English STE, Shumin explained to us the relevance of using a controlled English standard and how this could improve our documentation quality. We reviewed and discussed several STE and non-STE examples to help reinforce our learning and memory. Although the rewriting process of our documents was arduous, the trainer tried to make the learning process as enjoyable as possible. Overall, I liked the rewriting workshop and working group review because we got to apply our learning and practised writing in STE a lot. I’d most likely recommend this course to technical writers who are looking to advance, polish, or refine their STE writing skills as part of their career progression.”

Mauro Rovinetti, Technical Data Manager, Hiab – Effer loader cranes “The trainer’s delivery and introduction to Simplified English is very good as she helped us understand what the specification entails and its relevance to my work. The training workshop and overall delivery of Simplified Technical English content has been simply explained, yet complete and exhaustive. Clear English writing is the way to go also for a non-native English speaking audience who may have difficulty understanding the language at times.”

 

Ricardo Belsue, Technical Support & Documentation Engineer, HIAB Loader Cranes “The introduction to Simplified Technical English was quite useful for my understanding of what the specification entails and how it can be applied to our daily work, with very good materials shared during the workshop. I like STE rule.3.6 Use of active voice. Because sometimes it is not easy to identify when to use active or passive voice, mainly for non-native english speakers. With this rule, it makes more clear when you have to write technical texts.”

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.

 

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!

 

 

Simplified Technical English as the basis for your global documentation needs

Simplified Technical English as the basis for your global documentation needs


Event information Registration
Join us for another online meet-up, where we welcome Shumin Chen for a talk about Simplified Technical English.

Simplified Technical English as the basis for your global documentation needs

Dates: Thursday, 7 October 2021

Time: 15:00 to 16:30 CEST

Event location: Online

Field(s) of interest: Compliance, Technical Writing, Globalisation and Localisation.

Presentation description

ASD-STE100 Simplified Technical English (STE) is the international standard for accurate and efficient documentation. STE helps to make technical documentation easy to understand by standardising vocabulary, grammar, and style while letting users control their specific terminology. It includes a set of approximately 53 technical writing rules and a basic general vocabulary dictionary of approximately 900 approved words for writing technical documentation.
May 4th 2021 marks the release of Issue 8 of the Simplified Technical English (STE) specification. A few salient points worth considering, and in the words of the STE Maintenance Group Chair: – Issue 8 concludes the global review process that started with Issue 7 in 2017. While Issue 7, mainly focused on the technical writing rules of STE, Issue 8 is dedicated to the improvement of the sentence examples provided in Simplified English. – There are 706 revised words that correspond to 32% of the total number of dictionary word entries. The sentence examples in the new issue are much easier for technical writers to relate to as the focus is on the correct replacement of unapproved words with related approved words or suitable sentence constructions in STE. – This is also the first time since 1983 that changes are driven by users who actively participated in the general review of the pre-release version. 140 revised words to be exact!


Agenda

  1. Welcome and short introduction
  2. Simplified Technical English as the basis for your global documentation needs by Shumin Chen
  3. Q&A

The event is open to everyone interested in tekom Denmark. The event language is English.
When you sign up for the event, you agree to us recording the meeting via our meeting platform.

About the Speaker

Since 2006, Ms Shumin Chen has been working as a consultant with customers in various industries worldwide: aerospace & 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 Singapore. 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.


tcworld China 2021 | Sept 16-17 | Shanghai & Online Hybrid Event

tcworld China 2021 | Sept 16-17 | Shanghai & Online Hybrid Event

tcworld will organise the seventh international conference for technical communicators and language professionals in China. This is a hybrid event that will take place on Sept 16-17 in Shanghai and online.

Simplified Technical English, Issue 8, May 2021, International Specification for the Preparation of Technical Documentation in a Controlled Language

Dates: Thursday, 16 September 2021

Time: 15:55 to 17:35 GMT +08:00

Field(s) of interest: Legal and Compliance, Technical Writing.

Programme Highlights

As the first technical communication professional in the field of STE to launch an e-learning course to train technical writers and subject matter experts (SMEs) in the use and effective implementation of STE, Shumin Chen, Head of ASD-STE100 Simplified Technical English training & implementation firmly holds onto the ethos of clarity in documentation.

On 16 September 2021, 15:55 hrs (GMT+8), Shumin will show conference participants how to use STE correctly and effectively in practice. The main objective of this presentation is to help the audience identify and simplify technical subjects into straightforward content that is often accompanied by a few long overdue ‘aha’ moments. STE content makes for a compelling and positive impact on all document types in the technical field, especially when implemented over a period.

Substantial cost-savings in human and machine translations are easily achieved by simplifying your technical English content because when sentences are simpler and less ambiguous, they become easier and less expensive to translate. Simplified Technical English (STE) drives this change towards efficient content management, re-use, and ultimately sustainability.

Originally developed for the aerospace industry during the 1980s, STE is now widely used also outside the aviation industry, including companies in the defence, diagnostics, electronics, machinery, medical equipment, healthcare, semiconductor, IT, and Hi-Tech industries.

💻 Secure your conference seats today: https://lnkd.in/fPRqJjV

 

About the Speaker

Since 2006, Ms Shumin Chen has been working as a consultant with customers in various industries worldwide: aerospace & 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 Singapore. 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.