RE: Quick Reference Material in User Guide?

Subject: RE: Quick Reference Material in User Guide?
From: "Spreadbury, David C." <David -dot- Spreadbury -at- marconi -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 18 Sep 2002 16:24:40 -0400

I have seen this done but the Quick Reference section was it's own section
at the front of the User's Guide. This was also offered independently from
the main User's Guide. I can't see it being interspersed throughout the User
Guide. It think it would cause some confusion, especially if the complete
procedures are complex. An experienced user could then just make a copy of
the Quick Reference section, if it wasn't offered as a separate smaller
document/pamphlet/card, of the User's Guide and keep the main manual on the
shelf for reference or refresher.

-----Original Message-----
From: Jim Hager [mailto:jhager -at- techrx -dot- com]
Sent: Wednesday, September 18, 2002 3:18 PM
Subject: Quick Reference Material in User Guide?


I'm working on a user guide for a complex application for the medical
industry. It involves lots of screens with lots of fields and some complex
tasks for the user.

I'm contemplating adding some quick reference material inside the user
guide. These blocks of material would be like a quick summary of the tasks
that are rather compex. These would interspersed throughout a chapter as
need and would be in adition to the chapter summaries.

Naturally, these would also be in the online help for the application.

Has anybody here used this technique?

If so, can you provide any guidance?

If you have not used this technique, what do you think of this? (Note. I'm
not asking about separate quick reference guides, I'm asking about imbedding
some quick reference material inside the user guide.)

Thanks for your input.

Jim Hager
Lead Technical Writer
jhager -at- techrx -dot- com

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!

FrameMaker-to-PDF TimeSavers Assistants let you enhance & automate navigation
in PDF doc sets (chapter tabs, next/prev chapter/pg, bookmarks, popup menus);
create interactive PDF forms, rollover popups; presentations:

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: FrameMaker - Changing Conditional Text
Next by Author: Re: Seeking Folio users
Previous by Thread: Re: Quick Reference Material in User Guide?
Next by Thread: Quick reference material in user guide?

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

Sponsored Ads