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:30:36 -0400
Hi, guys...I'm having a discussion with someone at my company, and
unfortunately, he's several layers above me in the company pecking
order, so I have to be careful how I approach this with him.
In a nutshell, he's telling me that users will approach a User's Manual
and read it like a novel...they start from the from and read it page
after page.
My position is that readers enter the book at any place that contains
the content to address their issue at hand.
The impact to this is that he feels information should be organized so
that as you get further in the book, you can assume the person already
knows whatever it is about the application that got them to that point
and never have to address it again, even in passing.
I'm taking the position that anywhere in the book, they need to know
something about what got them there, either in description or through
sufficient cross-referencing (which he also dislikes).
Opinions?
John Posada
Senior Technical Writer
Isogon Corporation http://www.isogon.com
"Realizing Your Business Goals
Through Software Asset Management"
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.
