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.
David Downing reports: <<I was just given two sets of instructions for our
new phone system -- one being the official manual from the company, and the
other being a simplified cheat sheet written by the trainer. The procedure
for programming number into the phone's memory is essentially the same un
both places, except that the cheat sheet has "Do NOT lift the handset" as
the first step. The author of the official manual apparently thought that
was implicit the omission of "Lift the handset," but the trainer told us
that everybody just automatically lift the handset -- and the procedure
doesn't work.>>
It's an interesting point. I'd bet that the people who wrote this actually
spent time watching how people work with the product, discovered that large
numbers of users made the same mistake, then figured out how to minimize the
problem it through documentation. Wouldn't it be nice if all documentation
projects included some kind of analysis of how readers could muck up a task,
then wrote in such a way as to guide them around the problems?
--Geoff Hart, geoff-h -at- mtl -dot- feric -dot- ca
Forest Engineering Research Institute of Canada
580 boul. St-Jean
Pointe-Claire, Que., H9R 3J9 Canada
"User's advocate" online monthly at
www.raycomm.com/techwhirl/usersadvocate.html
"The skill of writing is to create a context in which other people can
think."--Edwin Schlossberg, designer (1945- )
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Save up to 50% with RoboHelp Deluxe. Get 2 great products for 1 low price!
You'll get RoboHelp Office PLUS RoboDemo, the software demonstration tool
that everyone's been talking about. Check it out and save! http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.