RE: How do you read a User Manual

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 18:21:41 -0400

What you are describing is trending toward a fractal information model
where every topic needs to contain all the information of all topics.
That gets messy fast, and eliminates any efficiency you would otherwise
gain from modular topics. I'll admit though that cross-referencing may
be unavoidable for bigger complex docs.

I agree that you cannot include all information about everything
everywhere. I try to follow the approach that somewhere in the document,
everything is discussed in detail, as the organization of the manual
dictates. Then, when it's needed as background for something else, to
include enough information to get most people on the right track and to
include a cross-reference of some type to the greater detail. Example
from something I wrote just today (first draft, may be tweaked):

"All Users must belong to at least one User Group if they are going to
be able to have access to [application]. By default, when Users are
added, they are given the association of "All Users".

See "Manage Security Access Rights for a User Group" starting on page
191 and "Working with Group Associations" starting on page 194 for
information you must know when working with Group Associations.

John Posada
Senior Technical Writer
Isogon Corporation
"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!

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. .

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 for more resources and info.

Previous by Author: RE: How do you read a User Manual
Next by Author: What windows mode do you run
Previous by Thread: RE: How do you read a User Manual
Next by Thread: Re: How do you read a User Manual

What this post helpful? Share it with friends and colleagues:

Sponsored Ads