Re: Quick Reference Material in User Guide?

Subject: Re: Quick Reference Material in User Guide?
From: "Susan W. Gallagher" <sgallagher5 -at- cox -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 18 Sep 2002 13:38:01 -0700

I've taken this approach occasionally for explaining
complex programming tasks -- sort of. Generally, I
provided an "overview" at the beginning of a set of

In general, the steps you'll perform to
complete a stamafragit include:

1. Bung the dorp (see <hyperlink>"Bunging the Dorp" </> on
page 12)

2. Stamis the fragimuffin (another xref)

3. Store the stamised fragimuffin in the appropriate
directory (another xref)

... and so on. In pdf or html, the xref embedded in the overview
takes you to the section of complete instructions. Users can perform
the procedures they are sure of from the overview info and access the
step-by-steps quickly for the procedures they are less familiar with.

The overview also works as a checklist for long and complicated
procedures; and if the procedure gets interrupted, (IMO) it's
easier to pick up where you left off.

-Sue Gallagher

At 04:18 PM 9/18/02 -0400, Jim Hager wrote:


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.

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:

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.

Quick Reference Material in User Guide?: From: Jim Hager

Previous by Author: Re: Resources on designing forms
Next by Author: Re: Funny Tech Writing
Previous by Thread: Re: Quick Reference Material in User Guide?
Next by Thread: RE: Quick Reference Material in User Guide?

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

Sponsored Ads