Skip to main content
UsabilityNews.com - for all the latest in usability and human-computer interaction
The British HCI Group
 
 
The All the Latest section presents all general usability news articles


 
  advanced search
 

All the Latest

Andrew’s Usability in the Real World: Fantasies of the Technical Writer


Source: UN, 17 May 2004
Submitted by Andrew Swartz

Andrew

"I’m afraid I’m going to give the pub a miss tonight, there’s a new manual I want to read."

"Early night tonight for me. There’s a help system I can’t wait to dive into."

These are words, alas, that the average technical writer will never hear. It may be grossly unfair, but the sad fact is that most of us will do just about anything to avoid opening a manual or thumbing through a help system.

I spent years writing manuals and help systems, and have the utmost respect for the profession. On the whole, it is a startlingly dedicated group, working hard, and often for little reward or respect. And saddest of all, for many writers there is a constant nagging feeling that the fruit of all the labour is going to waste. Is anyone reading it?

Of course, some people do read it. Programmers and engineers are brilliant technical readers, but most of us leave the manuals suffocating in their shrink wrap. And then there's The Martin Effect. You know, there's the one friendly guy who actually knows how to do mail merge and make tables, and doesn't mind explaining it. In one of my offices, that was a fellow named Martin, and he was the one who read the manuals. If those manuals were good, we all benefited.

So well done, all you technical communicators. Your work may not be as popular as Tom Clancy, but it does make a difference, and the people who matter do notice. But I'm not going to let you off the hook completely. You need to do more, and get more involved with your products.

To explain, here are some findings from some studies I've been involved with:
• Some years ago, I wrote manuals for a specialised software product. To study how effective the manuals were, I visited the offices of the users, hoping to find information such as whether the table of contents was used more, or the index, whether the callout style in screen shots was effective, and if the tasks were clearly laid out. What I found instead was that no one could find the manuals. Either they were locked in a cabinet for safekeeping and no one had the key, or they were lined up on a shelf with lots of other manuals, and every one of them had the same black wire binding. It took 10 minutes just to find the right manual.
• At Apple, we studied a help system in a user lab by giving people tasks so difficult they couldn't possibly figure them out without resorting to looking up the answers in Help. In the first days of two hour sessions, users never once turned to Help, despite our ever more desperate pleas and hints. People, it seemed, would rather suffer hours of frustration than open a help file.

What's going on here? The usability issues in technical writing are still at a more basic level than most of us acknowledge. The problem is that the writing is too far away from the action. The instructions aren't where the users are – and we users, frankly, are much too lazy to go find the instructions when we need them.

So here's my basic argument: for the most effective user experience, reduce the distance between the instruction and the action.

To understand, imagine one of those doorknobs that usability guru Don Norman writes about. Norman points out that the design and look of a doorknob communicates its function. Some handles just want to be pushed, and others demand to be pulled. And, on an otherwise slow day, you can have hours of amusement watching a door with the wrong kind of handle make person after person stub their toes or dislocate their shoulders.

The best thing to do with a door that has a bad handle is to replace the handle. (This is a metaphor. As I write 'handle' or 'door knob' you should be thinking of 'software' and 'dialogue boxes'.) But sometimes this is not possible. To help the poor door user, you need some kind of written communication – some words or pictures to tell people how the door works.

Now if we were to take the typical technical writer approach, we would do this by shipping a short manual with the door, and hope that everyone approaching the door would flip through the manual to find the instructions about pushing and pulling, and there would be about as much chance of that happening as your neighbour reading the manual for his new computer.

The best place to put the instruction is on the handle itself – a short and eloquent word would do – PUSH, or PULL.

(If you want a good live illustration of this, ride one of the new British trains with wheelchair accessible restrooms. Their doors open and close using pushbuttons, and the buttons are usually on the wall opposite the door. When these trains first came out, you could watch one person after another struggle to close the door by hand, and many would give up because the instructions were so far away from the door.)

The same rules apply to software instructions. If you are writing instructions for a consumer-oriented product, especially discretionary interfaces on the Web, do everything you can to bring your instructional words and pictures closer to the audience. There are four types of distance, both virtual and real, to consider reducing:

PRODUCT DISTANCE. The best option is to improve the product so that it is obvious how it works – in the door example, it's to make sure that the handle tells the user correctly whether it is a PUSH or a PULL door. While technical writers typically don't see product design as their role, often they are the first people to see how the product will look to naïve users and so are well placed to lobby for product changes.

GEOGRAPHIC DISTANCE. Make sure your instructions are physically close to the interface they describe. Put prompts next to the text boxes they describe, or at least on the same page. Every pixel matters.

CLICK DISTANCE. If you can't get the text on the same page as the interface, reduce the number of clicks between where the user notices the problem and where they find the solution.

CONTEXT DISTANCE. Users have a great deal of problems learning special help interfaces. Make sure the rules in the help system are either already familiar to the user, or are similar to the rest of your product.

In short, stay close to the user.

I once worked on a new inkjet printer, and discovered that my company was getting thousands of support calls that their new printers weren't working. In almost every case the cause was the same – users had failed to remove the sticky orange tape from the printer cartridge before installing it. The manual of course described this in detail, but these people didn't read the manual.

We moved the instructions to a small bit of card stock which was incorporated into the tape that needed to be removed, and the problem went away. Thousands of customers happy, thousands of dollars saved in customer support, and our reputation for quality intact.

That's what can happen when a technical writer moves beyond the bindings of a book.

Andrew Swartz
Principal Consultant
Serco Usability Services
www.usability.serco.com
020.7421.6499

© 2004 Serco Limited, All Rights Reserved.

 


External link to another web site Associated Link:
Serco Usability Services


Other News

Rest your Wrists when you're Writing on the go
Source: UN, 25 July 2008
 
Computer Intelligence, Inc. has launched Intelligels(R), a line of wrist rests for laptop computers.

Brits more hooked on mobile tech than Yanks are
Source: RegisterHardware, 24 July 2008
 
According to the latest edition of Carphone Warehouse’s Mobile Life Report, 94 per cent of British youngsters own mobile phones, compared to just 80 per cent of those in the US.

Five ways to Improve online cross- and up-selling
Source: Webcredible, 23 July 2008
 
Increasing cross-selling and up-selling on your website will help sell more items and keep customers coming back.

Say goodbye to the Computer Mouse
Source: BBC, 22 July 2008
 
It's nearly 40 years old but one leading research company says the days of the computer mouse are numbered.

LowBrowse: a web browser for the Visually Impaired
Source: UN, 21 July 2008
 
An innovative new add-on software tool will enable millions of people worldwide with low vision to access previously inaccessible web pages.

Now you can See your Voicemail
Source: UN, 19 July 2008
 
Speech Design's new Visual Voice Mail 'pushes' voice messages directly to mobile handsets, eliminating push-button retrieval.

User-centred research into mobile law enforcement recognised
Source: UN, 18 July 2008
 
C-innovate, a user-centred consultancy based at the Sussex Innovation Centre at the University of Sussex, has won an award for its research into mobile technology and innovation in the public sector.

The Web speaks up
Source: UN, 17 July 2008
 
Textic Limited has just announced the commercial launch of Talklets, a Web 2.0 service that ‘voice enables’ text-based Web content.

All-in-One Devices ride again
Source: Wall St Journal: Market Watch, 16 July 2008
 
Evolutions of all-in-one devices and internet-TV functionality will fuel the nascent home theatre PC market, according to ABI Research.

How to Succeed as a First-Time UX Manager
Source: UXMatters, 15 July 2008
 
Being a manager of UX is no better — and no worse — than being a great designer or user researcher, but the roles are very different.

 
 

 

home | contribute | subscribe | news feed/RSS | search | contact us | disclaimer

UsabilityNews.com (version 1.4), along with its associated web site and content,
are all strictly © Copyright of the British HCI Group 2001-2008. All rights reserved.

Joanna Bawa (editor), Dave Clarke (founder, designer and developer). Ian Parry (graphics).