TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Combined doc/help index From:Peter Gold <pgold -at- NETCOM -dot- COM> Date:Thu, 9 Jan 1997 06:03:43 -0800
The last time I read a Microsoft manual for Word or maybe it was Excel, I
recall that simple and common things were explained on paper, but deeper
or more complex things had pointers to online help such as, "search for
xxx in Help." The books were thinner, of course, for this approach. Maybe
a Microsoft writer is lurking and cares to comment on user feedback.
Peter Gold
pgold -at- netcom -dot- com
On Thu, 9 Jan 1997, Earl Morton wrote:
> 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
>
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
