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.
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
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
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. http://www.DocToHelp.com/TechwrlList
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-