Archive | Technical Writing

Effective Business Process Mapping

Perhaps your organisation wants to automate a process, improve efficiency, or move from one infrastructure provider to another. Whatever the motivation, business process mapping is often the first step in transforming business processes within an organisation. Business process mapping involves detailing the steps in a process, identifying the roles responsible for carrying out each step, […]

Continue Reading · 0

Looking Forward to TCUK 2019

Organised by the ISTC, Technical Communication UK (TCUK) is always a highlight of the conference calendar for technical communicators in Europe. This year’s event promises to be no different. Taking place over three days from September 10th to 12th in Warwickshire, UK, the 2019 programme features a great line-up of speakers on the theme 10. […]

Continue Reading · 0

Writing FAQs: Dos and Don’ts

In recent years, FAQs have become a controversial issue in the web design and technical writing world. FAQs originated in the 1980s on discussion boards where regular contributors compiled lists of FAQs so that they wouldn’t have to repeat information for newcomers. Since then, FAQ pages have become a standard part of most websites, without […]

Continue Reading · 0

Writing User Manuals: Five Top Tips

Writing user manuals is a common requirement of the technical writer’s role across many different industries. It’s also not uncommon for this task to fall to someone who is not a technical writer by trade — and in this case, writing user manuals can seem like a daunting task. We’ve drawn on our expertise in […]

Continue Reading · 2

Broaden Your Audience With Improved Accessibility

According to the WHO, approximately 15% of the world’s aging population lives with some form of disability. Accessibility involves a wide range of disabilities, including visual, auditory, physical, speech, cognitive, language, learning, and neurological disabilities. What can we as technical communicators do to ensure we are providing accessible help documentation and content for all our […]

Continue Reading · 0

Using DITA Creatively to Develop Training Material

When we developed our Technical Writing Skills training course, we created the course materials using the Darwin Information Typing Architecture (DITA), to test its usefulness for small content production projects. DITA is an open XML standard for creating, organising, and publishing topic-based information. The content team who developed the course material acted as ‘customers’. They […]

Continue Reading · 0

Creating Effective Work Instructions: Kyle Shropshire’s “The Error Free Workplace”

Kyle Shropshire’s The Error Free Workplace explores the significance of well-written instructions and highlights how well-written instructions can contribute to an error free workplace. If you want to reduce workplace errors, this book explains how technical writing can help you achieve your objective. Errors and Consequences To commence, the book outlines why some work instructions […]

Continue Reading · 2

Information 4.0 – Making Content Intelligent

As the industrial revolution enters its fourth stage, technical communication is evolving in parallel. The challenge for technical communicators is to develop new methods of creating, managing, and storing content that are compatible with the latest delivery channels – to close the gap between the more traditional technical communication methods and the requirements that Industry […]

Continue Reading · 2