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:Value of ToC and Index in HTML or help? From:"Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA> To:"Techwr-L (E-mail)" <TECHWR-L -at- lists -dot- raycomm -dot- com> Date:Mon, 27 Mar 2000 09:21:29 -0500
Joh G wondered <<... how important an Index and a Table of Contents (ToC)
are for HTML help?>>
Let's put it this way: in all the software I currently use, I've yet to
reliably find topics solely using the "find" function. Even following the
TOC hierarchy rarely works. On the assumption that designers of online help
are not completely incompetent, my conclusion is that these two approaches
to finding information work only when you're looking for simple topics. When
your information needs get more complex, there's no substitute for a
manually generated index created by someone who understands how people look
<<How can I create a "real" HTML ToC and Index?>>
A table of contents is easy: group the topics you've created into logical
groups that show the document structure (hierarchy) clearly. That structure
is unlikely to be clear from the help file itself unless you've specifically
created a browse sequence that creates this structure for the reader, and if
you have done this, then you've already done 90% of the work required to
generate the TOC. For an index, there's no substitute for examining each
topic carefully, applying a series of appropriate keywords in your help
authoring software, and compiling an index. If those tools won't do the job
for you, have a look at something like HTMLindexer
(http://www.html-indexer.com/) and see whether it meets your needs. But
you're still going to have to invest some skull sweat creating a good index.
No way around that given current technology.