plain english Archives | Shufrans TechDocs Home // plain english Archives | Shufrans TechDocs

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/

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

• Author more efficiently
• Communicate more effectively with a global audience
• Improve operational safety
• Reduce AOG / downtime
• Facilitate modular writing and reuse
• Facilitate teamwork
• Facilitate translation
• Maximise consistency
• Optimise product lifecycle support
• Reduce the cost of creating and maintaining technical publications.

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.