RE: User Guide - a newbie mistake?

Subject: RE: User Guide - a newbie mistake?
From: "Sean O'Donoghue-Hayes (EAA)" <Sean.O'Donoghue-Hayes -at- ericsson -dot- com -dot- au>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 20 Sep 2002 10:11:30 +1000


(a) Congratulation on doing your first user guide.

(b) If they review it properly they should identify lots of errors - this is
good for it means you know where you can improve, and will make the user
guide better - and always better to catch errors in-house rather than out!
(If they haven't found any, reread it yourself in two days time. Starting
from the back.....)

(c) Does it cover the information that the audience you identified for the
user guide will require? If so then a user guide could well only hold 10%
of a system's functionality and still be complete. However if the remaining
25% you said you missed is required by your expected audience for their job
- then it should/must be added.

regards and thanks,

-----Original Message-----
From: rbilbao -at- us -dot- amadeus -dot- net [mailto:rbilbao -at- us -dot- amadeus -dot- net]
Sent: Friday, 20 September 2002 7:05 AM
Subject: User Guide - a newbie mistake?

Hi everyone,

Dilemma: I'm almost done with my first document. It's 20 pages long. I
called it
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
depend on what the company/team/department has deemed "user guide" for


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: Role of Technical Writer in IT
Next by Author: RE: A grand, grand opening line...
Previous by Thread: RE: User Guide - a newbie mistake?
Next by Thread: re: User Guide - a newbie mistake?

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

Sponsored Ads