technical writers Archives | Shufrans TechDocs Home // technical writers Archives | Shufrans TechDocs

VMI Group: Standardising Content for Enhanced Operational Excellence in High-Tech Machinery with Simplified Technical English

VMI Group: Standardising Content for Enhanced Operational Excellence in High-Tech Machinery with Simplified Technical English

Transforming Technical Communication and Training for Global Efficiency in Manufacturing

Client: VMI Group (Global Operations)

Industry: High-Tech Machinery (Tyre, Rubber, Can, and Care Industries)

Location: Epe, The Netherlands (On-site Training)

Challenge: Ensuring consistent, unambiguous technical documentation and training materials across diverse global teams and specialised functions within a complex machinery manufacturing environment.

Solution: A focused, three-day ASD-STE100 training and masterclass delivered by Shufrans TechDocs to a mixed group of technical communication and instructional design professionals. The third day was exclusively for masterclass participants who had previously completed an STE course.

Results: Enhanced clarity in documentation, improved efficiency in content creation, and strengthened precision in training delivery, directly impacting product lifecycle support and global communication.

 

The Challenge: Precision in a World of Complex Machinery

VMI Group stands as a global leader in designing and manufacturing high-tech machinery for demanding industries, including tyre, rubber, can, and care products. Their sophisticated equipment requires technical documentation and training materials of the highest clarity and precision to ensure operational safety, efficient maintenance, and effective knowledge transfer across their worldwide customer base and internal teams.

However, as with many global enterprises dealing with intricate technology, VMI Group faced the challenge of maintaining absolute consistency and unambiguous language across their varied documentation outputs. This complexity was compounded by a diverse team of professionals involved in content creation, including:

  • Instructional Designers & Curriculum Developers: Responsible for creating training materials that must be universally understood by operators and technicians.
  • Technical Writers & Senior Technical Writers: Tasked with authoring detailed manuals, specifications, and service guides for highly specialised machinery.
  • Linguists: Critical for ensuring accuracy in content that would inevitably be translated for international markets.
  • Engineers: Providing essential technical input that needed to be integrated into clear, actionable documentation.

Inconsistencies or ambiguities in any part of this documentation chain could lead to inefficiencies, rework, increased translation costs, and, crucially, potential operational errors in the field.

 

 

The Solution: Shufrans TechDocs’ Tailored STE Training & Masterclass

VMI Group partnered with Shufrans TechDocs for a comprehensive, three-day ASD-STE100 training and masterclass. Understanding the mixed bag of roles and diverse work areas (including extrusion processes) involved, Shufrans TechDocs delivered a programme designed to provide both foundational STE principles and advanced application for VMI Group’s specific needs.

The training was structured as follows:

  • Days 1 & 2 (Core STE Training): Covered fundamental STE principles, writing rules, and controlled vocabulary. This section was open to all participants.
  • Day 3 (Masterclass for Advanced Participants): Exclusively for individuals who had previously completed an STE course, this session delved into more complex scenarios, nuanced application, and advanced best practices for implementing STE across varied technical content.

The training emphasised practical application, utilising VMI Group’s own documentation examples where relevant, to ensure immediate and tangible skill transfer. Shufrans TechDocs’ expertise in ASD-STE100 ensured that VMI Group’s teams were equipped with the latest standards and best practices.

The Results: Unifying Communication, Enhancing Operational Excellence

By undertaking the ASD-STE100 training and masterclass with Shufrans TechDocs, VMI Group achieved measurable advancements in its technical communication:

  • Enhanced Documentation Clarity: All participants gained a unified understanding and application of STE, drastically minimising ambiguity in their technical documents and training materials. This directly translates to safer and more efficient machine operation and maintenance.
  • Improved Content Efficiency: Technical writers and instructional designers could create content more quickly and with greater consistency, reducing drafting time and internal review cycles.
  • Optimised Translation Workflows: Linguists gained highly consistent and unambiguous source text, leading to faster, more accurate, and more cost-effective translations for VMI Group’s global reach.
  • Stronger Cross-Functional Understanding: Engineers and field experts, now familiar with STE, could provide more precise input, fostering better collaboration with documentation teams.
  • Accelerated Professional Development: The training upskilled a broad range of professionals, enhancing their capabilities in critical communication, which is vital for continuous improvement in a high-tech manufacturing environment.

VMI Group’s investment in STE training with Shufrans TechDocs has proven to be a strategic move, empowering their teams to produce clear, consistent, and highly effective technical documentation and training materials, thereby supporting their commitment to innovation and global operational excellence.

If your organisation faces similar challenges in global technical communication, discover how Shufrans TechDocs can help. Learn more about our ASD-STE100 training and consulting services:

🗓️ View our training calendar.

www.shufrans.com

Weatherford: Optimising Global Communication in Oilfield Services with STE

Weatherford: Optimising Global Communication in Oilfield Services with STE

Driving Unambiguous Communication for Enhanced Safety and Efficiency in Global Onshore Operations

Client: Weatherford (Global Operations)

Industry: Onshore Drilling & Energy Services

Location: Global (Online Training across Europe, US & Canada, APAC timezones)

Challenge: Ensuring consistent, unambiguous, and safe technical communication across diverse global teams and critical documentation, particularly concerning complex onshore drilling operations and other highly sensitive well completion activities.

Solution: Multiple batches of online ASD-STE100 training programmes delivered by Shufrans TechDocs, tailored for professionals across various timezones.

Results: Improved clarity and precision in technical documentation, enhanced safety protocols for critical operations, streamlined global communication, and professional development for a diverse range of technical roles.

 

The Challenge: Precision in High-Stakes Global Operations

Weatherford, a prominent global energy services company, operates at the forefront of onshore drilling and well completion. In such a high-stakes environment, which often involves highly sensitive downhole operations, the clarity and accuracy of technical documentation are not merely regulatory requirements but fundamental pillars of safety, operational efficiency, and environmental responsibility.

Maintaining a unified standard of communication across a globally dispersed workforce, with teams operating in different time zones (Europe, US & Canada, APAC), presents a significant challenge. Ambiguity in crucial documents, especially those related to complex drilling procedures or sensitive well completion activities, could lead to:

  • Serious safety incidents or operational errors.
  • Increased downtime and costly operational inefficiencies.
  • Misinterpretations during complex well interventions.
  • Challenges in compliance with diverse international regulations.
  • Difficulties in efficient knowledge transfer and training.

Weatherford sought a scalable solution that could standardise their technical language, ensuring every instruction was understood unambiguously, regardless of the reader’s location or native language, with particular emphasis on the critical safety aspects of their operations.

The Solution: Targeted Online STE Training for a Global Workforce

Shufrans TechDocs partnered with Weatherford to implement a comprehensive ASD-STE100 training programme delivered entirely online, accommodating their global presence and various time zones. This approach ensured accessibility and consistency across their international teams. The training was delivered in multiple batches for participants from Europe, the US & Canada, and the APAC regions.

While a significant portion of the participants were engineers, the training was highly beneficial for several other key roles crucial to Weatherford’s operations:

  • Technical Writers/Documentation Specialists: Direct authors of manuals and procedures, ensuring consistency and clarity from the source.
  • Field Service Technicians/Operators: Directly implement procedures; clear instructions are paramount for safe and effective high-risk operations.
  • Safety Officers/Compliance Specialists: Ensure adherence to safety protocols and regulatory standards, benefiting from unambiguous documentation.
  • Training & Development Personnel: Responsible for creating clear and effective training materials for new hires and ongoing professional development.
  • Supply Chain & Logistics Personnel: Who interpret specifications for equipment and materials, where precision avoids errors in ordering and handling.

 

The training focused on real-world application, working on the types of documents most critical to Weatherford’s operations:

  • Drilling Procedures & Protocols: For various onshore drilling techniques, ensuring step-by-step clarity.
  • Safety Procedures & High-Risk Operation Manuals: Covering all critical safety aspects, including the precise handling of specialised and sensitive materials used in well completion.
  • Tool Operation & Maintenance Manuals: For specialised drilling tools and equipment.
  • Technical Specifications & Data Sheets: Ensuring precise definitions for components and performance characteristics.
  • Emergency Response Procedures: Where immediate and clear understanding can mitigate severe risks.
  • Field Service Reports: For consistent and accurate reporting of observations and actions from the field.

The Results: Elevated Clarity, Enhanced Safety, and Optimised Global Operations

By embracing ASD-STE100 online training with Shufrans TechDocs, Weatherford achieved significant improvements across its technical communication landscape:

  • Enhanced Safety & Reduced Risk: The primary benefit, especially for sensitive and high-risk operations, was a drastic reduction in ambiguity, leading to clearer, safer operational procedures and a lower risk of misinterpretation.
  • Improved Operational Efficiency: Clearer procedures streamlined onshore drilling operations, reducing downtime and costly errors.
  • Strengthened Global Consistency: A unified language standard ensured that documentation was consistently understood by diverse teams worldwide, regardless of geographical location or native language.
  • Optimised Knowledge Transfer: Training materials became more effective, accelerating the onboarding of new personnel and improving ongoing professional development for all technical roles.
  • Facilitated Compliance: Adherence to STE principles supported compliance with stringent industry regulations and safety standards globally.

Weatherford’s investment in STE training has transformed their technical documentation into a strategic asset, reinforcing their commitment to safety, efficiency, and operational excellence across their global onshore drilling and energy services.

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

🗓️ View our training calendar.

www.shufrans.com

 

 

Veeam Software: Securing Clarity in Data Protection with Simplified Technical English

Veeam Software: Securing Clarity in Data Protection with Simplified Technical English

Securing Unambiguous Communication for Enhanced Data Protection and Global Operational Efficiency

Client: Veeam Software

Industry: Data Protection, Backup, Disaster Recovery, Cloud Solutions

Challenge: Ensuring consistent, unambiguous, and highly effective technical documentation for complex data management solutions, impacting clarity for a global customer base and efficiency for a diverse writing team.

Solution: Tailored ASD-STE100 (Issue 8) training delivered by Shufrans TechDocs to key documentation and data science professionals.

Results: Significant enhancement in documentation precision, improved efficiency in content creation, and strengthened comprehension of intricate data protection concepts for end-users.

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.

 

Protecting Digital Experiences through Clear Communication for Global Efficiency

Protecting Digital Experiences through Clear Communication for Global Efficiency

Clarity for a Connected World: Driving Digital Security and Performance

Client: Akamai Technologies

Industry: Content Delivery Network (CDN), Cybersecurity, Cloud Services

Challenge: Ensuring consistent, unambiguous, and highly effective technical documentation for complex and rapidly evolving digital experiences, impacting clarity for a global user base and efficiency for documentation teams.

Solution: Tailored ASD-STE100 (Issue 8) training delivered by Shufrans TechDocs.

Results: Significant enhancement in documentation precision, improved efficiency in content creation, and strengthened comprehension of intricate digital security and delivery concepts for a global audience.

The Challenge: Precision in the Digital Edge

Akamai Technologies stands at the forefront of powering and protecting life online, delivering and securing digital experiences across its vast global network. In an environment where milliseconds matter for performance and a single vulnerability can have widespread impact, the clarity and precision of technical documentation are not just important—they are critical to operational integrity, security, and user adoption.

Akamai faced the challenge of ensuring its comprehensive suite of solutions—spanning content delivery, cybersecurity, and cloud services—was explained with absolute consistency and unambiguous language across all documentation. This complexity was magnified by the rapid pace of technological innovation and a diverse, global customer base ranging from developers to enterprise IT professionals. Without a unified standard, there was a risk of:

  • Ambiguity in complex technical explanations, potentially leading to misconfigurations or security vulnerabilities.
  • Inconsistency in terminology and style across various product guides, API documentation, and security advisories.
  • Inefficiencies in the documentation workflow, impacting authoring and review cycles for new product releases.
  • Challenges in effectively onboarding users and partners to Akamai’s advanced platforms.

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

The Solution: Targeted STE Training for Digital Clarity

Shufrans TechDocs partnered with Akamai to deliver a focused ASD-STE100 (Issue 8) training programme in November 2022.

This was an online training delivered to colleagues in Chile, Poland, Germany, and India. Recognising the pivotal role of clear communication in Akamai’s operations, the training was specifically tailored for technical writers, technical enablement managers, and instructional designers.

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

  • Apply STE Principles: Consistently implement the core rules of ASD-STE100 across all their documentation.
  • Simplify Complex Concepts: Translate intricate network architectures, cybersecurity protocols, and cloud 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 and enhancing searchability.

Documentation Types and Job Roles That Benefited:

The STE training had a direct and positive impact on several critical documentation types and enhanced the capabilities of the participating job roles:

Documentation Types That Benefited:

  • Product Documentation: User manuals, installation guides, and configuration guides for Akamai’s CDN, security, and cloud computing products became significantly clearer and easier to follow.
  • API Documentation: For developers integrating with Akamai’s vast array of services, STE ensured that API calls, parameters, and responses were described with unparalleled precision, reducing integration errors and accelerating development.
  • Security Advisories and Bulletins: Unambiguous language in these high-stakes documents became vital for conveying security threats, vulnerabilities, and precise mitigation steps, directly impacting customer security posture.
  • Training Materials: Instructional designers applied STE principles to create highly effective and unambiguous training content, crucial for onboarding users and partners to Akamai’s complex platforms and solutions.
  • Solution Briefs and White Papers: Explaining intricate technical solutions to a broad audience, from technical experts to business stakeholders, became more concise and impactful.

Job Roles That Learnt a Lot:

  • Technical Writers: Gained mastery in crafting consistent, clear, and concise documentation for all of Akamai’s product lines, from web performance to advanced security.
  • Instructional Designers: Elevated their ability to design and develop highly effective and unambiguous training content, ensuring that users could quickly and accurately learn to utilise Akamai’s complex digital experience platforms.

The Results: Elevated Clarity, Enhanced Security, and Streamlined Global Operations

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

  • Enhanced Clarity for Global Users: The application of STE principles led to documentation that was easier for Akamai’s global customers to understand, directly improving the reliability of their CDN services, the effectiveness of their cybersecurity defences, and the usability of their cloud solutions.
  • Improved Efficiency in Content Creation: Technical writers and instructional designers benefited from the structured approach of STE, leading to more efficient content creation, reduced rework, and greater consistency across their documentation portfolio.
  • Strengthened Security Posture: Unambiguous security documentation meant that critical security advisories and mitigation steps were understood precisely, enhancing Akamai’s and its customers’ ability to defend against sophisticated cyber threats.
  • Optimised Content for Translation: The inherent consistency and reduced ambiguity of STE-compliant source text facilitated faster, more accurate, and more cost-effective translations, crucial for Akamai’s global reach.

Testimonial

Kasia Lelonek, Technical Enablement Manager at Akamai Technologies, shared:

“The STE training was a truly eye-opening experience that definitely met my expectations. The trainer’s delivery was exceptionally professional, respectful, and flexible, adapting seamlessly to our specific needs. I particularly valued Rule 4.1, which focuses on writing short and clear sentences, as this is incredibly helpful when considering our diverse audience and their language proficiency. What stood out most was the trainer’s professionalism and readiness to tweak the material on-the-go, making the learning experience highly effective and engaging.”

Conclusion

Akamai’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 digital experiences 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, explore how Shufrans TechDocs can help. Learn more about our ASD-STE100 training and consulting services:

🗓️ View our training calendar.

www.shufrans.com

 

 

 

Europe Online STE Workshop: 2-day Training Course

Europe Online STE Workshop: 2-day Training Course

Write effective user manuals & instructions with Simplified Technical English

Europe Online STE Workshop

Dates: 16 & 17 January 2020

Plan later: 

  1. 30 & 31 January 2020
  2. 11 & 12 February 2020.

Time: 09:00 to 17:00 Central European Time [Europe]

Length of training: 2 days

Course registration ends one week before training commences.

**Course fee includes exercises, learning aids, certificate of completion, and 90-day post-training support.

Summary of Simplified Technical English (STE)

Simplified Technical English (STE) or ASD-STE100 is a controlled language that is used to write technical manuals in such a way that they can be more easily understood by an international audience. STE helps to make translations cheaper and more accurate. Often a formal requirement for aircraft and defence maintenance documentation, STE can easily be adapted to all technical industries and beyond. Ms. Shumin Chen will teach participants how to correctly and effectively use STE in practice. She will also address some of the mistakes commonly found in technical writing and the frequently incorrect use of common STE writing rules.

Shumin gave us a an all-rounded presentation to Simplified Technical English. Personally, rule 1.3: To use only approved words with their approved meaning holds the key to successful controlled language implementation. Rules 3.4, 3.6, 4.1, 5.3, and 5.5 are also among my favourites. The approved verb TO MAKE SURE THAT can come in very handy for technical writers as well. The presentation of STE rules offers quite a detailed overview that includes not only language rules but good, old technical authoring principles in general. It has been very helpful for us to learn and understand the concept of STE. I have found Shumin to be very competent in STE and will definitely recommend her course! Eric, Head of Corporate Technical Documentation (CTD), Schindler Group.

STE Course Outline*

This 2-day Europe Online STE Workshop includes interactive training and exercises.

  • Day 1: Classroom Training
    1. Practical overview of Simplified Technical English
    2. How STE helps both native & non-native speakers of English
    3. Benefits of adopting the STE international writing standard
    4. Writing rules and how to apply them in practice
    5. How to use the general vocabulary.
    6. Approved and non-approved words discussion and the rationale behind.
  • Day 2: Application, Review, & Exercises
    1. How to deal with industry-specific terminology
    2. How to use STE for various documentation types
    3. How to implement STE with minimal disruption to on-going production and existing documentation
    4. Practical workshop session for applying STE rules to your own documents
    5. Review, edit, and discuss participants’ own documents to reinforce learning
    6. Classroom presentation of own documents.

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

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. Lauren Gelli, Senior Technical Writer, Aerotech Inc.

Who should attend this technical writing workshop?

  • Compliance managers
  • CIO, COO, CTO
  • Customer support managers
  • Documentation managers
  • Editors
  • Engineering managers
  • Engineers and SMEs who create documentation
  • Graphics specialists
  • ILS managers
  • Maintenance managers
  • Operation managers
  • Product managers
  • Project managers
  • Quality managers
  • Software research engineers
  • Technical illustrators
  • Technical writers
  • Translation managers
  • Translators.

What technical writing outcomes to expect?

Our interactive training, exercises and workshop, will teach participants to standardise content to:

ASD-STE100 Trainer’s qualifications

Ms. Shumin Chen, principal trainer & consultant at Shufrans TechDocs received her professional on-the-job training in the field of STE under the tutelage of Dr Frans Wijma, a linguist and documentation expert. Together as an experienced global team, they provided their combined knowledge and dedication to benefit customers worldwide. To date, they have provided training and consultancy services to over 200 companies. Shufrans TechDocs is the only company with such vast experience in providing certified STE training.

Shumin has supported various companies with their STE and other documentation needs, based on standards where possible. Although STE was developed for the aerospace industry, more specifically for aircraft maintenance documentation, she found that it made a lot of sense to apply the same principles to other industries and types of documents as well. Few -if any- changes to the specification are necessary to adapt STE to industrial sectors ranging from machinery to IT, automotive to medical equipment.

Simplified Technical English STE examples

 

NIMR (EDGE Group): Enhancing Operational Readiness through On-Site STE Training

NIMR (EDGE Group): Enhancing Operational Readiness through On-Site STE Training

Clarity and Multilingual Efficiency in Critical Defence Documentation

Client: NIMR (A subsidiary of EDGE Group)

Industry: Defence Manufacturing & Technology

Location: Abu Dhabi, UAE (On-site Training)

Challenge: Ensuring absolute clarity, consistency, and a unified communication standard in critical technical and support documentation, vital for operational readiness, effective customer support, and seamless English-Arabic translation in the defence sector.

Solution: A bespoke, three-day on-site ASD-STE100 training programme delivered by Shufrans TechDocs to key personnel including Customer Support Officers, Field Engineers, Technical Writers, and Documentation Experts.

Results: Significant uplift in documentation precision, improved efficiency in field and customer support interactions, enhanced cross-functional communication, optimised translation processes, and accelerated professional development, directly contributing to NIMR’s mission of delivering mission-ready solutions.

 

The Challenge: Uncompromising Clarity in Defence Communications

NIMR, a leading manufacturer of wheeled military vehicles and a pivotal subsidiary within the UAE’s advanced technology and defence group, EDGE, operates in an environment where clarity is not merely beneficial—it is critical. The precision of technical documentation directly impacts the operational readiness, safety, and effectiveness of defence assets in demanding environments.

NIMR faced the challenge of ensuring that all its technical and support communications, from maintenance manuals to field service reports and customer interactions, adhered to an uncompromising standard of clarity and consistency. This was particularly complex given the diverse roles involved in creating and delivering this information, and the crucial requirement to translate documents accurately between English and Arabic for various customers and end-users:

  • Customer Support Officers: Needing to convey precise solutions and guidance efficiently to end-users, often in both English and Arabic.
  • Field Engineers & Technicians: Requiring unambiguous instructions for maintenance, troubleshooting, and on-site support of complex military vehicles, with the knowledge that these would be translated.
  • Technical Writers & Documentation Experts (from various backgrounds): Tasked with authoring and managing a vast array of critical technical content, with a direct impact on the quality of subsequent translations.

Any ambiguity could lead to misinterpretations in critical operational contexts, potentially compromising safety, delaying field repairs, impacting training effectiveness, or introducing errors during the English-Arabic translation process. NIMR sought a solution that would embed a culture of precise communication directly within their operational teams, with a clear benefit to their multilingual documentation needs.

 

 

 

The Results: A New Standard for Operational Clarity and Multilingual Efficiency

By investing in on-site ASD-STE100 training with Shufrans TechDocs, NIMR achieved significant, measurable improvements in its technical and support communications:

  • Enhanced Operational Clarity: A unified approach to language drastically minimised ambiguities in all forms of documentation, directly improving the understanding and execution of critical procedures by both internal teams and external customers.
  • Improved Field Efficiency: Field Engineers could more effectively diagnose issues and follow maintenance protocols, reducing downtime and ensuring rapid response in operational scenarios.
  • Streamlined Customer Support: Customer Support Officers provided clearer, more concise guidance, leading to reduced resolution times and enhanced customer satisfaction.
  • Boosted Documentation Quality: Technical Writers and Documentation Experts consistently produced high-quality, compliant content, streamlining workflows and reducing rework.
  • Optimised Translation Processes: With a consistent and unambiguous English source text, the translation of documents into Arabic became faster, more accurate, and more cost-effective, ensuring seamless communication with diverse customer bases.
  • Accelerated Professional Growth: The hands-on training significantly upskilled personnel across critical roles, fostering a collective commitment to precision communication and supporting their long-term professional development within the defence sector.
  • Strengthened Communication Chain: A common language standard facilitated seamless information exchange between engineering, documentation, field support, and translation teams, underpinning NIMR’s commitment to delivering superior defence solutions globally.

NIMR’s proactive investment in on-site STE training with Shufrans TechDocs has transformed its communication landscape, reinforcing its position as a leader in defence manufacturing through unparalleled clarity, operational excellence, and enhanced multilingual capabilities. This success story underscores the vital role of targeted communication training in ensuring readiness and reliability for critical industries operating on a global scale.

If your organisation faces similar challenges in achieving uncompromising clarity and operational readiness through precise communication, especially when translation between English and Arabic is a key requirement, discover how Shufrans TechDocs can help. Learn more about our ASD-STE100 training and consulting services:

🗓️ View our training calendar.

www.shufrans.com

Case Study: Achieving Clarity and Consistency in Technical Documentation for Schindler Elevators

Case Study: Achieving Clarity and Consistency in Technical Documentation for Schindler Elevators

A Strategic Approach to Unambiguous Communication and Operational Excellence

Industry: Urban Mobility (Elevators, Escalators, Moving Walks)

Client: Schindler Group

Training Locations: Ebikon, Switzerland (on-site) & Shanghai, China (online)

Service Provided: Simplified Technical English (STE) Training & Documentation Rewriting

Introduction

Clear, unambiguous, and consistent technical documentation is paramount in the complex and safety-critical world of urban mobility. This case study highlights a successful engagement with Schindler Group, a global leader in elevators, escalators, and related services, focused on achieving their technical communication through comprehensive Simplified Technical English (STE) implementation.

Client Background

Schindler Group, headquartered in Ebikon, Switzerland, is renowned for its innovative and sustainable mobility solutions. With a vast international presence and a diverse workforce, ensuring that technical manuals, maintenance procedures, and product documentation are universally understood is a strategic imperative, particularly for safety and operational efficiency.

The Challenge

Prior to the engagement, Schindler, like many multinational corporations, faced the inherent challenges of technical documentation:

  • Ambiguity: Standard English, with its rich vocabulary and complex grammatical structures, can lead to misinterpretations, especially among non-native English speakers.
  • Inconsistency: Multiple authors and external vendors, potentially across different regions, could result in varied writing styles and terminology, hindering clarity and increasing translation costs.
  • Translation Efficiency: Complex source texts often led to higher translation costs and potential errors in localised versions, impacting global operations.
  • Safety Criticality: In the elevator and escalator industry, any misunderstanding in technical instructions can have severe safety implications.

Schindler recognised the need for a standardised approach to technical English to mitigate these risks and improve the overall quality and efficiency of their documentation.

Phase 2: Document Rewriting and Refinement Following the initial training, a direct engagement commenced with key personnel to apply STE principles to existing documentation. This involved close collaboration with:

  • Principal Corporate Technical Author: To ensure the practical application of STE rules and to establish internal champions for the standard.
  • Head of Corporate Technical Documentation: To oversee the strategic implementation and integration of STE into Schindler’s documentation workflows.

This hands-on rewriting process ensured that the theoretical knowledge gained during training was immediately put into practice, demonstrating tangible improvements in clarity and consistency.

Phase 3: Global Expansion of Training Recognising the success and the need for global consistency, the training was extended to other critical regions. A dedicated online training session was conducted for:

  • Corporate Technical Documentation colleagues in Shanghai, China: This expanded the reach of STE adoption, ensuring that documentation produced in a key international hub also conformed to the new global standard.

www.shufrans.com

Key Stakeholders and Organisational Impact

The success of this initiative was a testament to the collaborative effort across various departments and external partners, demonstrating how STE benefits different parts of the organisation:

  • Leadership and Management: Gained strategic alignment and understanding of STE’s business value in achieving safety, efficiency, and global reach.
  • Engineering and Product Development Teams (including Subject Matter Experts): Benefited from improved clarity in technical specifications, design documents, and maintenance requirements, ensuring precise input and reduced ambiguity from the source.
  • Technical Documentation Teams (in-house and external partners): Acquired practical skills in applying STE rules, leading to more consistent, unambiguous, and efficient content creation for manuals, procedures, and other technical assets.
  • Terminology and Language Specialists: Enhanced their ability to manage and control technical vocabulary, ensuring consistency across all documentation and facilitating improved translation quality.
  • Translation Teams: Experienced streamlined translation processes due to the reduced ambiguity and increased consistency of STE-compliant source texts.

Results and Impact

The implementation of STE at Schindler Group yielded significant benefits:

  • Achieved Clarity and Readability: Documents became easier to understand for a global audience, including non-native English speakers, reducing the risk of misinterpretation.
  • Improved Consistency: A unified writing style and controlled vocabulary ensured consistency across all technical documentation, regardless of the author or origin.
  • Increased Efficiency: Streamlined writing processes and clearer source texts led to more efficient documentation creation and review cycles.
  • Reduced Translation Costs: The unambiguous nature of STE significantly lowered translation costs and improved the quality of translated materials.
  • Strengthened Safety: By eliminating ambiguity in critical instructions, the overall safety of operations and maintenance procedures was achieved.

 

Testimonials

This impact was echoed by participants:

Roland Kiser, Terminology Coordinator at Schindler, noted: “This course shares a good overview of structure, purpose, history, and contextual information about STE. The limited vocabulary and restricted list of words, short sentence constructions, active voice, and imperative verb usage are valuable takeaways messages to act upon in Simplified English. The examples used in this training are quite realistic and it is very likely that I will recommend this STE training to someone else.”

Cécile Roos, Corporate Translation Manager, added: “Entertaining, short, and clear presentation of the STE specification and rule sets. Overall, a good mix of rules, examples, and exercises. The course was very much on point and encouraged me to write in a more structured way. This will help the readers to properly understand my message even in business writing. Shumin had a very calm way of leading all of us through the training. Her style of teaching is rather empathetic and she keeps the group working effectively with timely breaks in between. Thanks Shumin for an enjoyable course with the perfect score of 10/10 in terms of trainer evaluation.”

Marco Valtangoli, Senior Corporate Technical Author at Schindler, also provided valuable feedback: “A very important and highlighted point during the introduction is that STE is an English language specification that is not only applicable for companies in the aerospace & defence industry. Rule 5.2 where you only have one instruction per sentence is important to us. Not being able to use the verb “CHECK’ that is only used as an approved STE noun poses a challenge to me all the time. I really appreciate the STE writing rules that give us the possibility to improve the consistency of our documents. The workshop exercises were of high interest value and drive home the point that it is important to learn by doing. Although a time-consuming process, the writing workshop impressed on me that the need to prioritise the analysis of our internal documents. Shumin is a competent trainer who does not only focus on explaining and enforcing the “writing rules”, but is always available to understand and empathise with the training needs of the class.”

Conclusion

The comprehensive STE training and document rewriting initiative with Schindler Group stands as a strong example of how strategic investment in technical communication can drive operational excellence, improve safety, and foster global consistency within a leading industrial enterprise. By empowering their diverse teams with the tools and knowledge of Simplified Technical English, Schindler reinforced its commitment to delivering clear, reliable, and high-quality documentation worldwide.

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

🗓️ View our training calendar.

 

Your Tactical Advantage | Emirates Defence Industries Company

Your Tactical Advantage | Emirates Defence Industries Company

STE as part of your global content strategy

Simplified Technical English as part of your content strategy

EDGE is creating opportunities in autonomous capabilities, directed energy, cyber-physical systems, advanced propulsion systems, robotics and smart materials, with artificial intelligence embedded across its products and services. Transforming how we live, and ensuring a more secure future, is what we do. Our mission is to bring innovative technologies and services to market with greater speed and efficiency.

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 then 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.. | NIMR Automotive

Thuraya Al Mehrzi, Production Engineer, NIMR Automotive
“Shumin gave a good introduction to Simplified Technical English. Instead of writing long sentences that are difficult to read, I prefer the STE rule of presenting long sentences in a list that makes it much easier to understand the work that is required to be completed. The STE exercises were pretty engaging, and this is particularly so for day 2 of the rewriting workshop that gave the team a lot of insight into our documentation. Trainees also had the opportunity to replace many unapproved standard English words with STE ones that helped us better appreciate the application of STE rules in a real-world context. This is a training that I have rated 10/10 for.”

Nour Bazuhair, Engineer Trainee, NIMR Automotive “The introduction to Simplified Technical English (STE) was simple to follow and understand. Rule 1.4 to use only the approved forms of verbs and adjectives from the STE dictionary is something that I appreciate very much. Applying the rules faithfully was a challenging albeit enjoyable process. There is a lot of good writing rules to learn here. I’ve found the exercises to be very useful for learning reinforcement, and they have helped me to apply STE rules in a more efficient manner and I’ve gained a much better understanding of STE as a result. Shumin’s training methodology is easy to follow, and she offers us great technical writing advice and has simplified the process for us. Every aspect of this training is a 10/10 for me.”

Abdel Alazeem Arafah, Service Coordinator, NIMR Automotive “This was a great course with very useful and practical knowledge for my work. Simplified Technical English (STE) encourages users to always refer to the approved list of verbs and nouns in the STE dictionary before writing their technical documentation. The active voice is also a very useful and powerful tool in sending loud and clear instructions to our users. Starting a warning or caution with a simple and clear command is also very crucial in my line of work. Shumin’s delivery of the training is highly organised, and she has been most patient with our comments, questions, and feedback the whole time.”

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!