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: These users have us stumped! From:"Paul Strasser" <paul -dot- strasser -at- windsor-tech -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 23 Oct 2002 12:38:05 -0600
Keith's comments are right on the money. You've found the starting level of
many users, which is one of the big questions I always have for clients.
You need a basic tutorial at the opening of the user's guide that leads
these people through the simplest tasks. You're writing at a 6th-grade
level. Fine. This basic tutorial should be at the 3rd grade level.
Describe the mouse, describe the mouse pad. Have them move the mouse on the
mousepad. have them press the left button while the little arrow is on this
picture (known as an 'icon.') Pressing a mouse button is known as
"clicking...." And so on.
It's interesting. I'd guess that a lot of us are writing user's guides and
system docs for god-awfully complicated programs used by sophisticated,
knowledgeable people. Does the idea of explaining how a mouse works (and
the basic jargon for computer use) make us break into a cold sweat?
My only other suggestion is to write a decent draft of your tutorial, give
it to one of the neophyte users, and see the results first-hand. You've
gotten great feedback before on their needs. Now see how your efforts help
them.
Good luck.
Paul Strasser
Windsor Technologies, Inc.
2569 Park Lane, Suite 200
Lafayette, Colorado 80026
Phone: 303-926-1982
FAX: 303-926-1510
E-mail: paul -dot- strasser -at- windsor-tech -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250). http://www.componentone.com/d2hlist1002
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at 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.