Re: Combined doc/help index

Subject: Re: Combined doc/help index
From: Earl Morton <WorkgWords -at- AOL -dot- COM>
Date: Thu, 9 Jan 1997 03:24:48 -0500

In a message dated 97-01-08 16:26:26 EST, Suzy Hosie writes:

>>
Background: I'm working on a project where the documentation set consists
of a smallish (48p) user's guide, setup instructions (fold-out card) and
then all info in online help.

Issue: My client has asked that the user's guide index include references
to Help so the user knows the info is available, even if it's not in the
user's guide.

Questions:
1. If you have done this, was it successful (measured by client/employer
satisfaction as well as customers not complaining/calling because they
can't find the info)?
2. Do any of you have ideas re how to present this to the user? I've tried
a few things but haven't hit on anything I really liked.
>>

I did something similar recently. We did not index the Help topics in the
smallish printed manual, but we did include several cross-references to the
online Help. We sited the Help location with a phrase such as "For more
information, in the online Help search for ________." This release of the
product is still quite new, and I haven't had any feedback on its success.

Earl Morton
WorkgWords -at- aol -dot- com

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Re: Beta testing documentation
Next by Author: Re: Revision Numbers
Previous by Thread: Combined doc/help index
Next by Thread: Re: Combined doc/help index


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

Sponsored Ads


Sponsored Ads