TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: documenting a mess From:"Gerry Gaffney" <gerry -at- infodesign -dot- com -dot- au> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 12 May 2000 09:57:01 +1000
Given that you can't fix user interface problems in the documentation, is
there any possibility of conducting usability testing?
Even cheap and informal testing can be extremely effective politically,
provided the right people either participate, view the tests, or see video
or documentary evidence of the results.
I've been on more than one project that was *completely* revamped (in one
case, abandoned) after usability testing finally forced developers and
managers to face facts.
Usability testing can be easy and cheap to conduct. Even if you only get 2
people to try to use the system, you should uncover the extent of the
problems from the user interface point of view. (You need to make sure you
use 'real people' and give them realistic tasks.) You can even do it using
paper prototypes.
Good luck!
_____________________
Gerry Gaffney
Information & Design
PO Box 1255
Windsor VIC 3181
Australia
_____________________
----- Original Message -----
From: Kim Forbes <kim_portonova -at- hotmail -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Thursday, 11 May 2000 11:55
Subject: documenting a mess
> Hi All,
> I have been given a project from hell.
[depressingly familiar details snipped]
>
> I have to write a system admin guide and a user guide.
> Does anyone have any ideas about sorting through this mess.
>
> Thanks
> Kim Forbes
> Children's Hospital
> Boston, MA 02188