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:Janet Myers <myers032 -at- tc -dot- umn -dot- edu> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 23 Oct 2002 13:36:20 -0500
When I look at my first manuals of 15+ years ago, I'm amazed at how much background I used to write--and it was appreciated at the time.
I started with a brief introduction to concepts--2-5 pages--of both the application and the computer (user perspective: screen, keyboard, Hit ENTER). It was more narrative than a glossary and would have benefited from some graphics (not an option at the time).
Without giving the whole Windows manual, you could start with an introduction to computer concepts in the context of the application. It might include illustrations with callouts of a basic window, a mouse in action, a scroll bar... glossary or narrative descriptions of clicking, scrolling, and so on.
The information could be included in How to Use this Manual or Before You Begin
> The TW crew here just had a chat with the folks in Apps Support/Training. They are asking us to dumb down the User Docs even more. Our product's GUI has been designed to be extremely intuitive and user friendly. Ease of use is a primary selling point.
> We write at approximately the 6th grade level now. Short sentances and simple words are the rule. One problem is that we make the assumption that the user is familier with using Windows. Not so, say the front line trainers.
> The end users do not know how to use a computer. At a recent training session (10 students) three students picked up their mice and touched the screen with it when told to "Point at the icon with your mouse." The lady managing these users says that they can't understand the context sensitive on-line help that says, "Right-click on XXX and select YYY from the list." and includes a screen shot of the cursor pointing at XXX and another screen shot of the expanded list with YYY highlighted.
> The root cause of this is that even though our customers pay well over a million dollars for our product, they won't pay the users more than $6 per hour (minimum wage). People with a high school education and posibly some exposure to computers won't work that cheap.
> So the question is: Does anyone have any experience or ideas about writing a non-technical user's guide for the totally clueless?
> John Gilger
> Senior Technical Writer
> Acres Gaming
> Las Vegas, NV
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.