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.
I was flipping through a newly updated American software product's user guide
that is intended for an
audience of software testers. I was flipping through the pages when
the following instruction conjured up a hilarious image of someone
literally following the directions:
"...press the Ctrl and F5 keys at the same time and then lift them up."
I could see the user press the keys, then physically lift the keys up and off
their little pegs, and wonder how that action is going to help them do the
operation on the screen. Plus, the action doesn't say what to do with the
keys once they are lifted up!
There is something to be said about testing all procedures in a document,
or at least have someone else carefully read the guide!