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:Comprehensive Indexes? From:Jed Clark <jed -at- AUTOSIM -dot- COM> Date:Thu, 7 Jan 1999 08:49:22 -0700
Our company develops a simulation product that is highly customizable. The
product has now grown to the size where we have decided to produce two
manuals:
1. A user guide
2. A customization guide
We feel we've divided the information between the two guides intuitively.
However, we are concerned that our user's will not be able to easily find
information if they look in the wrong guide. Here's what we think the
options are:
1. Each manual has it's own index. The user's would be required to learn in
which guide they should look for information.
2. Several key terms are indexed in each guide that say to see the other
guide without referencing a specific page number.
3. Make the guides a two volume set with continuing page numbers so the
index can be completely comprehensive.
Has anyone else faced a similar decision? We're not sure which method of
indexing/organizing the information will be most useful for our readers.
Thanks,
Jed
**********************************
Jed Clark
Technical Writer
AutoSimulations
655 Medical Drive
Bountiful, UT 84010
801.294.1461
jed -at- autosim -dot- com <mailto:jed -at- autosim -dot- com>
**********************************
