Blog | Page 3 of 12 | Shufrans TechDocs Home // Blog | Page 3 of 12 | Shufrans TechDocs

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.

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.

STPA (System-Theoretic Process Analysis) is a relatively new hazard analysis technique based on an extended model of accident causation. In addition to component failures, STPA assumes that accidents can also be caused by unsafe interactions of system components, none of which may have failed.

This article explores how ASD-STE100 (Simplified Technical English or STE) can be effectively applied within the framework of System-Theoretic Process Analysis (STPA). While STPA primarily focuses on identifying and analysing hazards within a system, the incorporation of ASD-STE100 principles ensures that all documentation generated throughout the process is characterised by clarity, conciseness, and unambiguous language.

The Role of ASD-STE100 in Effective STPA:

• Clear Hazard Descriptions: ASD-STE100’s emphasis on precise language and the avoidance of ambiguity is crucial in ensuring that identified hazards are described clearly and unambiguously within STPA documentation. This clarity is essential for effective hazard communication and subsequent risk assessment.

• Consistent Terminology: By promoting the consistent use of terminology throughout the STPA process, ASD-STE100 facilitates a shared understanding of key concepts and terms among all stakeholders, including engineers, safety analysts, and project managers. This consistency minimises confusion and ensures that all parties involved interpret information in the same manner.

• Improved Communication: The clear and concise documentation facilitated by ASD-STE100 significantly improves communication and collaboration among all stakeholders involved in the STPA process. This enhanced communication fosters a better understanding of the identified hazards and facilitates the development of effective risk mitigation strategies.

• Reduced Misinterpretation: By eliminating ambiguity and promoting clarity, ASD-STE100 minimises the risk of misinterpretations of STPA findings. This reduced risk of misinterpretation leads to more accurate and effective risk assessments and subsequent risk mitigation strategies.

Specific Applications of ASD-STE100 in STPA:

• Hazard Identification: When documenting identified hazards, the use of clear and concise language, devoid of ambiguity, is paramount. This ensures that all stakeholders have a shared understanding of the nature and scope of each identified hazard.

• Control Structure Diagrams: The labels and descriptions within control structure diagrams should be clear, concise, and easily understandable. This ensures that the diagrams effectively communicate the system’s control logic and potential interactions between system components.

• Hazard Analysis Reports: The principles of ASD-STE100 should be rigorously applied when drafting hazard analysis reports. These reports should be written in a clear, concise, and easily understandable manner, ensuring that they are accessible to a wide range of stakeholders, including those without specialised engineering or safety expertise.

• Risk Mitigation Strategies: The documentation of risk mitigation strategies should adhere to ASD-STE100 principles, ensuring that they are presented in a clear, concise, and unambiguous manner. This clarity facilitates the effective implementation and monitoring of risk mitigation measures.

In essence, ASD-STE100 serves as a valuable tool for enhancing the overall quality and effectiveness of STPA documentation. By ensuring that all documentation related to the STPA process is clear, concise, and unambiguous, ASD-STE100 contributes to a more robust and effective hazard analysis process.

While generative AI offers exciting possibilities for streamlining STE content creation, it’s crucial to understand its limitations and the enduring value of human expertise.

AI as a Tool, Not a Replacement: Generative AI excels at tasks like:

• Drafting and Editing: Automating repetitive tasks, suggesting alternative phrasing, and identifying potential inconsistencies.
• Enforcing Standards: Checking for adherence to ASD-STE100 and other standards.
• Improving Clarity: Identifying areas of ambiguity and suggesting clearer language.

However, AI cannot fully replace the critical thinking and nuanced understanding that human writers bring to the table.

Addressing Missing Information:

• Human Expertise: Technical writers, with their deep domain knowledge and understanding of the target audience, are essential for identifying and addressing crucial information gaps.
• Thorough Planning: Careful planning, including detailed requirements gathering and thorough subject matter research, is paramount to prevent missing information from the outset.

• Human Review: Even with AI assistance, meticulous human review is necessary to ensure all mission critical information is accurately and comprehensively conveyed.

The Importance of Human Judgement:

• Nuance and Context: STE requires understanding subtle nuances, interpreting complex technical concepts, and tailoring the information to the specific needs of the audience. These tasks demand human judgement and expertise.
• Ethical Considerations: AI models can sometimes exhibit biases or generate inaccurate information. Human oversight is crucial to ensure the ethical and responsible use of AI in STE.

Generative AI can be a valuable tool for technical writers, enhancing efficiency and improving the quality of STE documentation. However, it should be viewed as an assistant, not a replacement. The unique skills and expertise of human writers, including critical thinking, domain knowledge, and the ability to understand and address complex technical issues, remain indispensable for creating high-quality, effective, and trustworthy STE content. By leveraging the strengths of both AI and human expertise, we can create a synergistic approach that maximises the benefits of both while mitigating the risks.

Introduction

In the age of automation and artificial intelligence, there’s a common misconception that technical writing is a dying profession. However, reality is quite the opposite. As technology continues to advance, the role of technical writers becomes even more crucial in ensuring that complex information is communicated effectively and accurately.

The Evolving Role of Technical Writers

Despite the advancements in technology, human interaction remains essential in the field of technical writing. Software and automation tools can assist with tasks like formatting and style checking, but they cannot replace the creativity, judgment, and interpersonal skills that a skilled technical writer brings to the table.

Today, technical writers are expected to be more than just writers; they are communicators, collaborators, and creative thinkers. The shift towards a more creative and collaborative approach is driven by the need to produce documentation that is not only informative but also engaging and user-friendly.

The Cost-Effective Solution

One strategy that can enhance the effectiveness of technical writing is the use of Simplified English. While it might seem counterintuitive to simplify technical language, adopting Simplified English can actually make documentation more clear, concise, and accessible to a wider audience. By eliminating unnecessary jargon and complexity, technical writers can ensure that their content is easier to understand and apply.

Investing in training and development for human technical writers is a far more cost-effective solution compared to investing in expensive AI tools which do not always guarantee results.

While these tools can be helpful for certain tasks, they cannot fully replicate the nuanced understanding, critical thinking, and creative problem-solving skills that human writers bring to the table. By investing in training, organisations can empower their technical writers to excel in their roles and produce high-quality documentation that meets the needs of their audience.

Beyond Cost-Effectiveness

Investing in technical writer training offers several additional benefits beyond cost-effectiveness. Human writers can:

• Provide context and nuance: They can understand the broader context of a project and tailor their writing accordingly.
• Build relationships: They can foster strong relationships with subject matter experts and stakeholders, leading to better collaboration and understanding.
• Adapt to change: They can quickly adapt to changes in project requirements or industry trends.
• Innovate: They can contribute to innovative solutions and approaches to technical communication.

While technology can certainly assist technical writers, it cannot replace the unique skills and abilities that human writers bring to the table. By investing in training and development, organisations can ensure that their technical writing teams are equipped to meet the challenges and opportunities of the future.

🔗 Learn more about this international writing standard: www.asd-ste100.net.

🔗 Learn more about what the STE standard can do for you: https://www.shufrans-techdocs.com/simplified-technical-english-case-study/

🔗 Ongoing STE workshops: https://www.shufrans-techdocs.com/online-ste-workshop-2-day-training-course/

The Challenge: Unifying Clarity in a Complex Digital Landscape

Veeam Software stands as a global leader in data protection, backup, and disaster recovery, operating at the forefront of virtual, physical, and cloud-based workloads. In an industry where precision is paramount, and a single misinterpretation can have significant consequences for data integrity and business continuity, the clarity of technical documentation is not just beneficial—it is fundamental.

Veeam faced the challenge of ensuring its comprehensive suite of solutions, from Veeam Backup & Replication to Veeam ONE, was explained with absolute consistency and unambiguous language across all documentation. This complexity was amplified by a rapidly evolving technological landscape and a diverse global customer base. Without a unified standard, there was a risk of:

• Ambiguity in complex technical explanations, leading to user errors or support queries.
• Inconsistency in terminology and style across different product manuals and guides.
• Inefficiencies in the documentation workflow, impacting authoring and review cycles.
• Potential for misinterpretation of critical recovery procedures, jeopardising data resilience.

Veeam sought a solution that could standardise its technical language, ensuring every instruction and explanation was understood unequivocally, regardless of the reader’s technical background or native language.

The Solution: Tailored STE Training for Enhanced Precision

Shufrans TechDocs partnered with Veeam to deliver a focused ASD-STE100 (Issue 8) training programme. Recognising the varied expertise within Veeam’s content creation ecosystem, the training was specifically tailored for nine key individuals, comprising mostly technical writers, senior technical writers, a crucial data scientist, a handful of Knowledge Managers, and a technical writing lead.

The programme focused on equipping these professionals with the practical rules and vocabulary of STE, enabling them to:

• Apply STE Principles: Learn and consistently implement the core rules of ASD-STE100 for all their documentation.
• Simplify Complex Concepts: Translate intricate data protection methodologies and software functionalities into clear, concise, and unambiguous language.
• Leverage Personal Pronouns: Understand and effectively utilise “You” and “We” to create direct, actionable instructions, particularly vital for user guides and procedural documentation.
• Standardise Terminology: Adopt a controlled vocabulary to ensure consistent use of terms across all documents, reducing confusion.

The inclusion of a data scientist and a Knowledge Manager in the training was particularly strategic, highlighting Veeam’s commitment to clarity even at the intersection of advanced analytics, information organisation, and practical application.

The Results: Elevated Documentation Quality and Operational Efficiency

By investing in ASD-STE100 training with Shufrans TechDocs, Veeam achieved significant, measurable improvements in its technical communication:

• Enhanced Documentation Clarity and Precision: The application of STE principles led to documentation that was easier for Veeam’s global customers to understand, reducing the potential for misinterpretation of critical backup and recovery procedures. This directly contributes to higher operational reliability for their clients.
• Streamlined Authoring Efficiency: Technical writers benefited from the structured approach of STE, leading to more efficient content creation, reduced rework, and greater consistency across their document portfolio.
• Improved Comprehension of Complex Solutions: For the data scientist, STE provided a framework to articulate complex data models and analytical insights with greater clarity, ensuring that even highly specialised information was accessible and actionable for its intended audience.
• Unified Documentation Standard: The technical writing lead gained a powerful tool for enforcing a consistent, high-quality standard across the team, facilitating better internal collaboration and a more cohesive documentation suite.

Veeam’s proactive investment in STE training with Shufrans TechDocs has transformed its technical documentation into a strategic asset, reinforcing its commitment to delivering clear, reliable, and high-quality data protection solutions worldwide. This success story underscores the power of targeted communication training in ensuring operational excellence and customer satisfaction in the rapidly evolving technology sector.

If your organisation faces similar challenges in achieving uncompromising clarity and operational excellence through precise communication, discover how Shufrans TechDocs can help. Learn more about our ASD-STE100 training and consulting services:

🗓️ View our training calendar.

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.

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.

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.