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:Planning a Help Project From:Steve Owens <uso01 -at- EAGLE -dot- UNIDATA -dot- COM> Date:Wed, 23 Mar 1994 13:10:27 +0700
I didn't respond the first time 'round because our current online help
system uses a hierarchical directory of topics (much like MSDOS or UNIX
file directories) and hence the organization somewhat resembles a book,
with chapters, sections, subsections, etc. This is pretty run-of-the-mill,
so I doubt anybody needs pointers on it.
In the future, I'll be going for a hypertextual approach. However, it'll
still start largely from a hierarchical directory, I believe, with more
conventional entry points into the structure, and then additional links
everywhere a cross-reference point could be added.
Essentially, I'll write the online help like ordinary documents, except
that everywhere a cross-reference *could* be added, I'll place a link to
the appropriate location. In a sense, this will be somewhat like indexing
Hm... I wonder if it'd be feasible to hyperlink a document in the same way
that you index one. That is, proceed through the document entering index
markers (assuming you're using Frame), using the same rules as when you're
indexing, periodically checking to make sure you're not indexing the same
thing with different names, and that you're using the same categories and
Generate the index and check for errors, fix any that occur. Generate
again. Now you have a rough map of how the hyperlink cross-references
should look - any two pieces of text that share an index entry should
probably be cross-linked.