What would life be like if there were no instruction manuals you could read?

Illiteracy is, sadly, something that can greatly affect people’s lives. According  to The Literacy Trust, less than one per cent of adults in England can be described as completely illiterate and approximately 16 per cent as “functionally illiterate”.

There are various articles on the Web that indicate how people live with their illiteracy:

  • They depend on people (relatives or the kindness of strangers) to read and explain things for them.
  • They recognise places and the location of things based on colours or shapes.
  • They often have to trust people aren’t scamming them.
  • They generally work within more limited boundaries, keeping to a consistent routine.
  • They often memorise how they completed a task last time.

If we produce a product but do not supply user instructions with it, the user has nothing to read, whether they are literate or not. The user has to fall back on coping mechanisms similar to those used by people with illiteracy. They can function, but they would do much better if they had something to read.

Writing troubleshooting topics

It’s a fair bet that the introduction of the new Troubleshooting information type into the DITA 1.3 technical authoring standard will affect how all Technical Authors write troubleshooting topics, regardless of whether they use DITA or not. That’s because the proposed elements for troubleshooting topics make good sense, and it offers a standardised approach to writing these types of topics.

According to the Oasis DITA standards committee,

Troubleshooting topics provide descriptions of and solutions or workarounds for problem situations that users might encounter. Users refer to troubleshooting information to understand what condition or event generated their problem situation and to find out what they need to do to recover from or work around a problem, or to prevent a recurrence of the problem.

The user would see a topic that looks roughly like this:
Continue reading

Our next Advanced Technical Writing Techniques course – 24th April 2014

After a short break, our Advanced Technical Writing Techniques training course has returned. We’ve scheduled a public course for Thursday 24th April 2014, in South Kensington, central London.

Past clients include technical communicators from Citrix, GE, IBM UK, Lloyds Banking Group, Sage plc, Schlumberger and Visa International. One delegate commented:

“The way in which customers consume our content is changing, as are the different expectations customers have regarding user assistance and support. Your course provided further insight and ideas regarding how to review and adapt to ensure content is relevant and appealing to our customers.”

This course is ideal for Technical Authors and those developing assistance for users of software.

Discover the advanced new writing styles emerging in technical communication. Don’t get left behind. You can book a place via the webpage Trends in Technical Communication Workshop – Advanced Technical Writing Techniques.

Our next Advanced Technical Writing Techniques course – 2 December

We’ve scheduled another Advanced Technical Writing Techniques public course – on Monday 2nd December.

Discover the advanced new writing styles emerging in technical communication. Don’t get left behind: past clients include technical communicators from Citrix, IBM UK, Lloyds Banking Group, Sage plc, Schlumberger and Visa International.

To book your place, see Advanced Technical Writing Techniques public course.

This will be the last public course this year.

Advanced technical writing techniques training: Next classroom course (and potential online course)

Do let us know if you’d be interested in us scheduling another public course for our Trends in Technical Communication – Advanced technical writing techniques course. We need just a couple more people for us to schedule a course date for June. Do let us know if you’d be interested in attending this course.

Interested in an online version of the course?

For writers based outside of the UK, we’re also considering offering this course in a “live and online” format over the Web. Using Google+ Hangouts, the course would be spread over a number of days, rather than delivered as a full day’s worth of training. The price of the course would be the same. The first course would be limited to just 5 or 6 delegates. Do let us know if you’d be interested in attending this course.

About the course

In this course, you’ll find out how Technical Authors in leading companies are now applying techniques from other disciplines (such as psychology, copywriting, usability and elearning) into the information they create.

Using examples of Help pages from a number of applications (including from vendors such as Apple, Facebook, Google, HTC and Mozilla), you’ll learn how to spot where these techniques have been used, and you’ll have the opportunity to practise these in the workshop.

Do let us know if you’d be interested in attending this course.

What’s the best way to deliver distance learning for technical communicators?

You’ll find our latest post for the Society for Technical Communication on its Notebook blog. It’s called What’s the Best Way to Deliver Distance Learning for Technical Communicators?

One of the most frequent questions we’re asked at Cherryleaf is if we can deliver our advanced technical writing techniques course as a distance learning class. We only offer it as a classroom course, which effectively limits us to teaching students who are based in the United Kingdom, Ireland, or mainland Europe. Being able to offer a training course worldwide is tempting, but is it really possible to deliver distance learning when you want to get people to question and rethink the way they do things today?

See: What’s the Best Way to Deliver Distance Learning for Technical Communicators?

Next Advanced Technical Writing Techniques Course: 22 April 2013

Trends in Technical Communication Workshop – Advanced Technical Writing TechniquesYou’ll find our next public Trends in Technical Communication Workshop – Advanced Technical Writing Techniques training course is scheduled for Monday 22 April 2013.

We’ve added some more comments from delegates to the page.

“Excellent over-view and will be useful for practical application. Much food for thought – useful for starting ideas on improving (the) existing approach to Help files.”
“Very thought provoking.”
“I just wanted to say ‘thank you!’ for the excellent training session yesterday. I’m putting those principles to work today as I review the UA for one of our websites. The way I write has changed dramatically.”
Continue reading