Blog | Shufrans TechDocs Home // Blog | Shufrans TechDocs

Simplified Technical English: From Aerospace Standard to Cross-Industry Success

Simplified Technical English: From Aerospace Standard to Cross-Industry Success

Simplified Technical English: Breaking Barriers Across Industries

Simplified Technical English (STE) has its roots in the aerospace industry, where it emerged as a solution to address language and documentation challenges. While it initially served the aerospace sector, STE’s versatility and adaptability have made it relevant and applicable to various industries. This article explores the evolution of STE from an aerospace standard to its potential in revolutionising documentation practices across diverse sectors.

The Aerospace Connection

Aircraft maintenance, a safety-sensitive domain, faced issues that stem from ineffective language and documentation practices. To address this, the aerospace industry spearheaded the development of the STE specification over the past 40 years. However, despite its origins, STE does not consist solely of aerospace-specific rules. In fact, a majority of the writing rules apply universally, with only a few minor adjustments necessary to suit different industries.

Fine-tuning the Vocabulary

While some aerospace- or defence related terminology exists in the general dictionary of STE, it comprises a mere 5% of the overall words. These highly technical terms, often related to nuts and bolts, require adaptation when dealing with software-based interfaces and non-aerospace contexts. By omitting these industry-specific terms and adding a handful of words relevant to specific industries, STE can be readily customised for a wide range of technical documentation purposes.

STE Beyond Aerospace

The power of STE lies in its versatility. Its applicability extends well beyond the aerospace industry. For instance, even financial institutions can benefit from the streamlined and precise language of STE when documenting banking processes. By embracing STE, organisations from diverse sectors can enhance clarity, efficiency, and comprehension in their technical documentation.

Adaptability to Specific Needs

STE’s flexibility allows for customisation to suit unique requirements. As the specification primarily involves additions to the dictionary, aerospace clients themselves often make customisations to cater to different systems onboard their aircraft. This adaptability has been demonstrated by unexpected users, such as a coffee machine manufacturer. Although seemingly unrelated to aerospace, their coffee machines are installed in a vast majority of passenger aircraft. Documentation for these machines, whether used in offices, medical practices, or cafeterias, can be effectively developed using STE, with only slight relaxation of the rules originally designed for aerospace.

Simplified Technical English, born out of the aerospace industry, has evolved into a versatile language specification capable of transforming documentation practices across various sectors. Its effectiveness in enhancing safety, efficiency, and clarity has made it applicable to industries far beyond its initial scope. With the power to streamline communication and promote comprehension, STE offers organisations a powerful tool to optimise their technical documentation, regardless of their industry.

Does Simplified Technical English make technical writers redundant?

Does Simplified Technical English make technical writers redundant?

On the contrary, adopting Simplified English requires a different approach and mindset. It does not eliminate the need for technical writers, but rather demands greater flexibility and creativity from them. Technical writers often face the challenge of monotony in their work as they focus on meeting deadlines and delivering accurate information. However, implementing Simplified English calls for a more imaginative and audience-oriented approach to writing, while adhering to specific rules to enhance the efficiency of the process. This does not imply that adopting Simplified English makes the job easier. Rather, it encourages technical writers to be more considerate of their readers while navigating the language’s unique regulations.

While not all technical writers may be able to implement Simplified English, the majority will find that it adds a new level of interest to their work. It requires more interaction with subject matter experts to ensure technical details are clear and accurate, a task that may be overlooked when writing in Standard English. Standard English permits vagueness while still being convincing, whereas Simplified English forces writers to choose between clarity and persuasion. Simplified English necessitates that technical writers have an in-depth understanding of the product to write meaningful, helpful text for their users. The use of software and specifications will not replace the writer’s role but rather enhance the effectiveness, accuracy, and usefulness of their work to their audience, making it more engaging and entertaining for the writer.

 

From Complexity to Simplicity: How Simplified Technical English Transforms Technical Writing

From Complexity to Simplicity: How Simplified Technical English Transforms Technical Writing

Technical writing is often dense and complex, making it challenging for readers to understand the information they need. This can be especially problematic in industries such as aerospace, defense, and transportation, where technical documentation plays a critical role in ensuring safety and compliance. Simplified Technical English (STE) offers a solution to this problem by providing a set of guidelines for writing technical documentation that is clear, concise, and easy to understand.

STE was developed in the early 1980s by the aerospace industry and has since been adopted by numerous other industries. The goal of STE is to eliminate ambiguity and complexity in technical writing, making it accessible to a wider audience. The guidelines for STE cover a wide range of topics, including grammar, vocabulary, and style.

One of the key features of STE is its emphasis on the use of a controlled vocabulary. This means that only a specific set of words and phrases are used, which have been carefully chosen for their clarity and simplicity. For example, instead of using the word “activate,” which can have multiple meanings, STE recommends using “start.” This helps to ensure that readers understand exactly what is meant by a particular term, reducing the risk of misinterpretation.

Another important aspect of STE is its use of simple grammar structures. STE recommends using short, declarative sentences, and avoiding complex sentence structures such as subordinate clauses. This makes it easier for readers to follow the logic of the text and understand the information presented.

In addition to grammar and vocabulary, STE also addresses style and formatting. STE recommends the use of bullet points, tables, and diagrams to present information in a clear and concise manner. This helps to break up dense blocks of text and make the information more accessible to readers.

 

No alt text provided for this image

 

The benefits of STE are numerous. By simplifying technical writing, STE makes it easier for readers to understand complex information. This can improve safety in industries where technical documentation is critical, such as aerospace and defense. It can also reduce the risk of errors and misinterpretation, which can have serious consequences.

In addition to these practical benefits, STE can also improve the efficiency of technical writing. By providing a set of guidelines for grammar, vocabulary, and style, STE streamlines the writing process, reducing the time and effort required to produce high-quality technical documentation.

Overall, Simplified Technical English is an effective tool for transforming complex technical writing into clear and concise documentation that is easy to understand. By adopting STE guidelines, technical writers can improve the accessibility and safety of their documentation while also streamlining the writing process.

Don’t settle for subpar technical writing. Upgrade your skills with STE training by Shufrans TechDocs today!

5 Key Principles of Simplified Technical English: A Guide to Writing Clear, Concise Technical Documents

5 Key Principles of Simplified Technical English: A Guide to Writing Clear, Concise Technical Documents

In the world of technical writing, clear and concise documentation is essential for effective communication. Simplified Technical English (STE) offers a solution by providing a set of rules and guidelines that simplify the language used in technical documents. By applying these principles, you can ensure that your documents are easily understood by a diverse audience. In this article, we will explore the five key principles of Simplified Technical English and how they can help you write clear and concise technical documents.

Standardized Vocabulary:

The first principle of Simplified Technical English is the use of a standardized vocabulary. This means using a limited and predefined set of approved words that are familiar to the target audience. By avoiding technical jargon and ambiguous terms, you can eliminate confusion and ensure that your message is conveyed accurately.

Simple Sentence Structure:

The second principle focuses on using a simple sentence structure. Complex sentences with multiple clauses and subclauses can be challenging for readers to follow. Instead, aim for short, declarative sentences that convey one idea at a time. This approach enhances clarity and reduces the risk of misinterpretation.

Clear Grammar and Syntax:

Proper grammar and syntax play a crucial role in creating comprehensible technical documents. STE emphasizes the use of clear and straightforward grammar rules, such as subject-verb agreement and consistent verb tenses. Additionally, avoiding passive voice and using active voice helps maintain reader engagement and ensures a direct and concise writing style.

Consistent Terminology:

Consistency is key when it comes to technical documentation. The fourth principle of Simplified Technical English emphasizes the importance of using consistent terminology throughout your documents. This means using the same word or phrase to describe a particular concept or component, avoiding synonyms or alternative terms that may confuse readers. Consistent terminology enhances understanding and helps readers navigate through complex technical information seamlessly.

Precise and Unambiguous Writing:

The final principle of Simplified Technical English centers around precise and unambiguous writing. Ambiguity can lead to confusion and misinterpretation, which can have serious consequences in technical fields. Use clear and specific language to describe actions, procedures, and requirements. Additionally, provide explicit instructions and avoid vague terms that may leave room for interpretation.

Simplified Technical English is a game changer in the field of technical writing. It improves the clarity and consistency of technical documentation, makes it more accessible to a wider audience, reduces the risk of misinterpretation, and can save organizations time and money. As more and more industries adopt STE, it is clear that this controlled language will continue to play an important role in technical communication for years to come.

Conclusions:

Mastering the five key principles of Simplified Technical English can significantly improve your technical writing skills and enhance the clarity and effectiveness of your documents. By adhering to a standardized vocabulary, utilizing simple sentence structures, maintaining clear grammar and syntax, employing consistent terminology, and writing precisely and unambiguously, you can create technical documents that are easily understood by your target audience. Embrace these principles and witness the transformation of your technical writing into a powerful tool for effective communication.

Make Technical Writing Simple Again: How Simplified Technical English is Changing the Game

Make Technical Writing Simple Again: How Simplified Technical English is Changing the Game

Simplified Technical English (STE) is a writing standard that is gaining popularity in the technical writing industry. It is designed to help writers create clear and concise technical documentation that is easily understood by a wide audience. If you’re a technical writer who is hesitant about using STE, here are some reasons why you should consider giving it a try.

First and foremost, using STE can improve the clarity of your writing. Technical documents can often be dense and difficult to understand, especially for those who are not familiar with the subject matter. By using STE, you can simplify your language, making it easier for readers to understand what you are trying to convey. This is especially important for industries such as aviation, where misinterpretation of technical documentation can have serious consequences.

In addition to improving clarity, using STE can also make your writing more consistent. The language rules of STE provide a standardized way of writing technical documentation, ensuring that all documents follow the same format and style. This can be especially useful for companies that produce a large volume of technical documentation, as it can help to ensure that all documents are consistent and easy to understand.

When writing technical documentation, it can be time-consuming and costly to have to constantly edit and revise your work to make it clearer and more concise. By using STE, you can reduce the amount of time and money you spend on editing and revision, as your writing will be clear and concise from the outset.

Using STE in technical documentation can also help ensure compliance with regulations and standards. For example, the European Union Aviation Safety Agency (EASA) mandates the use of STE in the documentation of safety-critical systems and equipment in aerospace. Similarly, the International Electrotechnical Commission (IEC) and the International Organization for Standardization (ISO) require the use of STE in their standards for electrical and electronic equipment where possible.

Approved words in the aerospace & defence industry.

 

Simplified Technical English is a game changer in the field of technical writing. It improves the clarity and consistency of technical documentation, makes it more accessible to a wider audience, reduces the risk of misinterpretation, and can save organizations time and money. As more and more industries adopt STE, it is clear that this controlled language will continue to play an important role in technical communication for years to come.

Don’t let confusing technical jargon get in the way of your customers’ success!

Don’t let confusing technical jargon get in the way of your customers’ success!

The writing style of the original text is highly technical and precise, which is suitable for conveying important safety information regarding the use of exercise equipment. The language used is formal, and the tone is serious, emphasizing the importance of safety precautions.

However, technical jargon can sometimes make it challenging for customers to understand the instructions and warnings, leading to improper use of equipment, which may result in serious injuries.

For instance, phrases such as “musculoskeletal discomfort” may not be easily understood by customers who are not familiar with medical terminology. Similarly, terms like “Qualified Trainer” may not be clear to some users, who may not know who qualifies as a “qualified” trainer.

To avoid such issues, it is crucial to communicate safety information in a way that is easy to understand and accessible to the general public. It is important to use simple, clear, and concise language that is understandable by a broad audience.

Moreover, providing visual aids such as diagrams, pictures, and videos can be helpful in supplementing written instructions and enhancing customer understanding. Using a conversational tone, instead of a formal or technical one, can also make safety information more accessible and relatable.

In conclusion, while technical jargon is essential in certain contexts, it can hinder customer understanding in safety-related matters. Therefore, it is crucial to communicate safety information in a way that is easy to understand and accessible to a broad audience. This can be achieved through the use of Simplified English, clear and simple instructions, and avoiding technical terms or jargon wherever possible. By doing so, customers can more easily understand the instructions and use the equipment safely and efficiently.

🧑🏻‍💻 Sign up for our Simplified Technical English workshop and learn how to communicate clearly and effectively.

Simplified Technical English (STE) saves businesses time and money. Here are 4 compelling reasons why.

Simplified Technical English (STE) saves businesses time and money. Here are 4 compelling reasons why.

🚜 🛫 🚛 Simplified Technical English (STE) is a controlled language that aims to make technical documentation easier to understand for non-native English speakers and those with limited language proficiency. It is used widely in various industries such as aerospace, defense, and transportation.

Here are some reasons why investing in Simplified Technical English can be a good decision:

  1. Clear communication: STE provides a standard vocabulary and grammar, making technical documentation clear and concise, and reducing ambiguity. This can lead to more efficient communication and better understanding between technical writers, engineers, and end-users.
  2. Improved safety: In high-risk industries such as aerospace and defense, using STE can help reduce the risk of accidents caused by misunderstandings in technical documentation. By ensuring clear and unambiguous instructions, STE can contribute to improving safety and reducing risk.
  3. Cost-effective: Simplified Technical English can help reduce the cost of translation and localization of technical documents. By using a standardized language, companies can simplify the translation process and reduce the need for costly and time-consuming revisions.
  4. Compliance: STE is widely recognized as an industry standard for technical documentation in many sectors, and its use can help companies comply with industry regulations and standards. This can be particularly important for companies operating in highly regulated industries.

In summary, investing in Simplified Technical English can improve communication, increase safety, reduce costs, and support regulatory compliance. By adopting STE, companies can ensure that their technical documentation is clear, concise, and effective, which can ultimately contribute to their success and competitiveness in the global market.

📊 💻 Review the STE localization case study here.

 

🌐 Learn more about this international writing standard at our upcoming lectures and writing workshops in Q2 2023:

Europe Online STE Workshop | 2-day Training Course

April 13 – April 14

US, Canada | Certified Simplified Technical English workshops

April 17 – April 19

Asia Pacific: 2-day certified online STE workshop (APAC)

April 24 – April 25

Middle East & Africa (MEA) Simplified Technical English Writing Workshop | A language for all industries

May 8 – May 9

▶️ Sign up now!

Do you struggle to communicate technical information to your audience? Here are 9 Simplified Technical English best practices.

Do you struggle to communicate technical information to your audience? Here are 9 Simplified Technical English best practices.

Simplified Technical English (STE) is a controlled language that is used in the aerospace and defense industries to simplify the language used in technical documents. Here are 9 best practices of Simplified Technical English:

  1. Use a limited vocabulary: STE restricts the vocabulary used in technical writing to a specific set of words. This helps to reduce ambiguity and ensures that the meaning of the text is clear.
  2. Use simple sentence structures: STE encourages the use of simple sentence structures that are easy to understand. Complex sentence structures can lead to confusion and misunderstandings.
  3. Use active voice: The active voice is preferred in STE because it is clearer and more concise than the passive voice when writing procedural text.
  4. Use present tense: Present tense is preferred in STE because it is more immediate and makes the text easier to understand.
  5. Use the imperative mood: The imperative mood is used in STE to give commands and instructions. This is because it is a clear and direct way of communicating.
  6. Use standardized terminology: STE requires the use of standardized terminology to avoid confusion and ensure consistency.
  7. Use clear headings and subheadings: Headings and subheadings should be clear and concise so that the reader can quickly identify the topic.
  8. Use illustrations: Illustrations can help to clarify complex concepts and make the text easier to understand.
  9. Comply with established STE guidelines: To ensure consistency and accuracy, it is important to follow established STE guidelines when writing technical documents. This will help to ensure that the text is clear and easy to understand.

Looking to advance your technical writing career? Our Simplified Technical English workshop is the perfect opportunity to enhance your skills and stand out from the crowd. Don’t miss your chance to master this essential skill with our workshop.

 

🌐 Learn more about this international writing standard at our upcoming lectures and writing workshops in Q2 2023:

Europe Online STE Workshop | 2-day Training Course

April 13 – April 14

US, Canada | Certified Simplified Technical English workshops

April 17 – April 19

Asia Pacific: 2-day certified online STE workshop (APAC)

April 24 – April 25

Middle East & Africa (MEA) Simplified Technical English Writing Workshop | A language for all industries

May 8 – May 9

▶️ Sign up now!

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.