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.
Re: Should i put all glossary terms in the index/serach engine online?
Subject:Re: Should i put all glossary terms in the index/serach engine online? From:Chet Ensign <Chet_Ensign%LDS -at- NOTES -dot- WORLDCOM -dot- COM> Date:Tue, 24 Jan 1995 17:18:59 EDT
Chuck Martin writes:
<-- So should each term be in the search engine? Or does it depend on the
term? Or does a well-crafted Help file take care of that with all uses
of terms in the glossary linked to pop-ups?
My own feeling is that consistency is the most important thing. If you have a
definable and growing list of glossary terms and many of them are already part
of the search list, then you *must* continue to add terms to that list as you
go. I get frustrated whenever I get an expectation about how an online product
is organized (e.g., I can always find the glossary terms in that search list)
and then suddently find my expectation violated. In the case you are
describing, if I were I reader who routinely turned to the search dialog box,
expecting to find glossary terms included, and suddenly I encountered one that
didn't get a response in that dialog box, I would assume that the term didn't
exist -- *not* that you as writer chose to include it.
Also, since Winhelp doesn't have a full-text search feature in most
incarnations, I'd doubly argue for making that search list as exhaustive as
possible. It is one of the key weaknesses of Winhelp and anything that you can
do to extend or enhance that search list helps your readers in the long run.
Chet Ensign Phone: (908) 771-9221
Director, Electronic Publishing Email: chet -at- lds -dot- com
Logical Design Solutions, Inc. Email(home): censign -at- interserv -dot- com