Picture of Mike Unwalla
Get a clear mandate from management

Dodgy user manuals are a waste of time and effort

BCS view: Why is bad documentation so common?

Written by Mike Unwala

The concepts of “professionalism” and “IT as enabler” are high on the IT agenda. Dumping problems on users is neither professional nor enabling, so why do many companies still do it?

People often need help with using software and IT systems, even if the interface itself is intuitive to use. Help comes in many ways, such as through support desks, training, and product documentation.

Documentation is not an end in itself, but if it is necessary, an organisation should do it properly. Don’t waste customers’ time with “enter the widget code in the widget code field, and click continue to continue”.

A while back, I purchased a router made by a major international manufacturer. After a fruitless weekend trying to set it up, I phoned the helpdesk. The support person was extremely helpful, told me that the manual was wrong, and gave me precise instructions on how to set up the router. So, because of incorrect documentation, that company cost me the best part of a weekend.

Sadly, you have probably had similar bad experiences. Whether it is for a commercial off-the-shelf product or an in-house IT system, poor documentation has a cost.

Sometimes the user pays, sometimes an organisation does, and it may not even be quantified. What is the cost of employees wasting time trying to figure out how to perform tasks with which they are not familiar? What is the cost of jobs carried out incorrectly, which then need to be put right?

Poor documentation can give an organisation a bad reputation and can hurt the bottom line.

Couldn’t the router manufacturer have made a small investment in an accurate manual? Despite the router being effective, I probably won’t buy that company’s products again. Even no manual would have been better than an incorrect one. “For help, phone the helpdesk,” would have prevented a weekend of frustration.

However, it’s not all doom and gloom. For example, Triangle’s new software, mPOS, extends the functionality of the InfoGenesis point of sale software onto handheld terminals. Triangle integrates mPOS with customers’ existing InfoGenesis systems.

Historically, Triangle’s hospitality customers are in the UK, and Triangle gives a customer’s staff about 15 minutes of training on the terminals.

To release the software to a global market, Triangle developed mPOS into a commercial off-the-shelf product. It commissioned the development of train-the-trainer and technical documentation, which means that the firm has empowered its customers to help themselves, and can use resellers to install and support mPOS globally. Now, that’s what I call both professional and enabling.

Given the shoddy state of much documentation, it is no wonder that people have an aversion to reading user manuals.

With a bit of vision, and a clear mandate from management, an organisation could improve the overall “user experience”, which in turn can lead to increased revenue and the opening up of new markets.

Mike Unwalla is a BCS member

reader comments

related articles

The pIT stop panelSkills

In peril? You need a pIT stop

Your IT questions are answered by our panel of industry experts 12 Jun 2008

 

Cognizant expands digital rights knowledge

Global systems integrator adds media and entertainment specialist SVC to its ranks 10 Jun 2008

Government rejects more web regulation

Forcing ISPs to monitor content will not work 06 Jun 2008

Google facing court battles on copyright

Google has defended its services and will challenge Viacom's complaint in court 05 Jun 2008

Google battle sparks debate

Copyright squabbles in Europe and the US would make life uncomfortable for Google if they transferred to UK 05 Jun 2008

related whitepapers

today's top stories

How to maximise the value of your IT networking investment

A panel of experts discuss networking strategies that deliver real value to business 03 Jul 2009

Habitat gets a web site makeover

The furniture retailer is revamping its online presence to provide a fully transactional web site. CIO Jacques Dekock explains why 02 Jul 2009

Government aims to bolster UK's cyber defences

Is the UK’s first national cyber security strategy up to the task of co-ordinating the country’s response to digital threats? Computing investigates 02 Jul 2009

Focus resources on what really matters

IT has become too caught up in the drive for efficiency, at the expense of business success 02 Jul 2009

From tracks man to tax man

Phil Pavitt, outgoing chief information officer for Transport for London, talks to Rosalie Marshall about the lessons he will take to his new role at HMRC 02 Jul 2009

Advertisement

Newsletter signup

Sign up for our range of FREE newsletters:

More available - click 'submit' to view

Existing User

Newsletter user login:

Advertisement

Jobs

Related jobs

Job of the week

Job alerts

Sign up here

Find your next job

IT Salary Checker

Check salary here

Advertisement

White papers

Search white papers

Top categories

VPN, Extranet and Intranet Solutions

WAN/ LAN Solutions

Network Security

Interoperability-Connectivity

Grid/ Utility Computing

Latest poll

Would you use social networking sites to look for a job?

Would you use social networking sites to look for a job?

Tell us what you think about job hunting through LinkedIn, Facebook, Twitter etc

View poll results

Latest audio and video articles

network cablesVideo

How to maximise the value of your IT networking investment

A panel of experts discuss networking strategies that deliver real value to business 03 Jul 2009

green footprintsVideo

How to manage enterprise energy use - and the role IT can play

A panel of experts explore how firms can get to grips with their carbon footprint and make smarter use of energy 01 Jul 2009

Latest in-depth articles

Phil PavittAnalysis

From tracks man to tax man

Phil Pavitt, outgoing chief information officer for Transport for London, talks to Rosalie Marshall about the lessons he will take to his new role at HMRC 02 Jul 2009

UPS worker making a deliveryAnalysis

Global standardisation delivers benefits at UPS

Delivery giant sees benefits of central IT solution 02 Jul 2009

Advertisement

Primary Navigation