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've always understood a glossary to be a list of terms with short
definitions... much like dictionary entries. Certainly, that's in keeping
with what we do, and in keeping with any other glossary i've ever seen, and
in keeping with dictionary and Chicago Manual of Style definitions. In
short... what you are proposing is the industry standard.
In addition to the validations just pointed out by Geoff, its awkward,
annoying and disorienting for users to have to interrupt the flow of what
they're reading in the main body of the document by having to flip to the
back, find the entry they need, read what amounts to a long footnote that
takes them off on a different tangent, then go back to the main body. If the
"glossary" explains concepts essential to the user's ability to understand
what they are reading about, then for sure that info belongs within the
context of the main text.
If you really want to prove your point, maybe you could write up a short
sample text that contains many instances of terms defined in the glossary.
Read the passage to the group (or have them read a hard copy), including
each glossary definition... this will demonstrate how annoying and confusing
that methodology is.
Lynne Wright
Technical Communications
Positron Inc.
5101 Buchan St. H4P 2R9
(514) 345-2200
fax: 345-2272
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
