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:Indexing HTML documents From:Gretchen Toth <glt -at- ICONOVEX -dot- COM> Date:Thu, 26 Oct 1995 10:03:53 -0500
We've had the online vs. paper documentation discussion
on this list; did anyone inquire about how indexes are
handled for online documentation, specifically when
the medium is HTML documents?
In considering the option of moving our documentation
to some online form (WAY in the future, probably), I
was wondering how writers have dealt with indexes for
online docs. Do you just stick with a search engine
and glossary or do you develop an 'index' page that
acts like an index in the back of a paper manual?
What kinds of tools are you using to make online docs
useful for the user? I'm glancing at a list of
HTML editors here and it LOOKS like most of them
just help you create a basic HTML document or convert
from some other format (I'm gleaning this from two-
sentence descriptions, mind you). 4W Publisher is the
only one that mentions indexes-- keyword indexes.
With all the hyperlinking in HTML documents, is it
necessary to create an index as in a paper manual?
I've heard some say that a Web site was so well
organized they didn't really see a use for any kind
of index page.
Lori Lathrop, if you see this before your next trip :-),
do you discuss creating 'indexes' for online documentation
in your workshops?
Gretchen
<><><><><><><><><><><><><>
Gretchen L. Toth
Technical Writer
The Iconovex Corporation
gretchen -dot- toth -at- iconovex -dot- com
<><><><><><><><><><><><><>