Re: User Guide - a newbie mistake?

Subject: Re: User Guide - a newbie mistake?
From: Andrew Plato <gilliankitty -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 20 Sep 2002 20:52:29 -0700 (PDT)

Do you know exactly how the product works, how it will be implemented and used,
and what the possible problems might be? Are you an expert user of the product?

In order to pick the "important 75%" you had better know that product and all
related technologies backwards and forwards - otherwise its just guessing.

Yestersday I read a technical manual from, oh I won't even tell you who, but
suffice to say I know their products very well. The document was utterly devoid
of any useful information. It focused almost exclusively on meaningless things
like how to open a menu or copy files. Given the type of people using this
product (highly technical folks), this kind of "granny" level info was totally
worthless. And in the process they left out mammoth chunks of important technical

Andrew Plato

> Dilemma: I'm almost done with my first document. It's 20 pages long. I called
> a user guide and sent it for review. Then I realize, I didn't really cover
> absolutely every aspect of the software. I covered about 75%. The important
> Is it okay to have called it a user guide? Is there a rule that says when
> calling a document a user guide it has to cover 100% of everything? Or does it
> depend on what the company/team/department has deemed "user guide" for
> consistency?

Do you Yahoo!?
New DSL Internet Access from SBC & Yahoo!

Enhance, optimize and automate your FrameMaker-to-PDF workflow with TimeSavers:
Define all PDF features in your source FrameMaker files ONCE, distill MANY.
Bookmark Controller, Link Controller, UnBloat & more :

Experience RoboHelp X3! This new RoboHelp release combines single sourcing,
print-quality documentation, conditional text and much more, into the most
monumental release of RoboHelp ever!

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

Previous by Author: Re: Anyone know anything about NetScreen?
Next by Author: Re: Drafts -- some people not clear on the concept...
Previous by Thread: re: User Guide - a newbie mistake?
Next by Thread: Anyone know anything about NetScreen?

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

Sponsored Ads