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: How do you read a User Manual From:"John Posada" <JPosada -at- isogon -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 15 Jun 2004 17:47:38 -0400
The difference is that you write manuals, so you have an interest in the
manual itself. To our customers, the application is a tool to accomplish
their job. Do I expect a person on par with an Accounts Payable clerk to
read a 200 page User Guide?
Senior Technical Writer
Isogon Corporation http://www.isogon.com
"Realizing Your Business Goals
Through Software Asset Management"
Subject: RE: How do you read a User Manual
Someone who is new to the application may very well read the manual from
front to back while people familiar with the application will look for
specific topics. I do both, especially when I get a new third
party-book about some app like Photoshop.
So you are both right. One question to ask is the manual a reference
manual like commands and such. In that case I couldn't image reading it
like a novel. I wouldn't organize a book as getting more advance the
farther you get into it, but I would consider organizing each chapter
that way if the circumstances permitted.
The key, so that you can satisfy both types of readers is to have a good
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. http://www.componentone.com/doctohelp .
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.