About online glossaries...

Subject: About online glossaries...
From: mbarwick -at- invatron -dot- com
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 10 Apr 2008 12:54:38 -0400

Greetings, all.

I'm in a position to determine what should happen in a new online help
system and I'm curious as to what people are doing with their online
glossaries (if they even have them).

Here are three possibilities I can envision:
1) All glossary terms in one topic, which is linked to from the main
introductory topic
2) All glossary terms in one topics, which is linked to from major topics
or all perhaps even all topics
3) All glossary terms as separate topics with links to occurrences in
topics (perhaps to appear as pop-ups)

#3 seems the right way to go because a single glossary topic is likely to
go unread. If the user can access a term's definition simply by clicking,
it seems to me it will more likely be used and frankly, it will be more
useful. The only trouble is that the task of building all those links
would be like indexing only worse, and take considerable time depending on
the size of the help system. :-(

If you build online help, tell me what you're doing with your glossaries
for I would dearly love to know. Only another tech writer could be so

Best wishes,

Michael Barwick
Senior Information Developer
Invatron Systems Corp.
mbarwick -at- invatron -dot- com


Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


Previous by Author: RE: Let the grammar wars begin!
Next by Author: Word 2003 so-o-o-o-o slo-o-o-o-ow
Previous by Thread: RoboHelp Search
Next by Thread: RE: About online glossaries...

What this post helpful? Share it with friends and colleagues:

Sponsored Ads