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.
A couple of days ago, Nancy posted the suggestion that terms be defined both in
the text (in the margins perhaps), as well as being included in the glossary.
I think she has a great idea.
Some of the other recent postings have pointed out that for a user's guide the
in-text approach would be better. On the other hand for a reference manual the
glossary method would be better (although even in a user's guide the same term
might be used in many places). As an ex engineer, I've certainly read all
kinds of manuals. I would certainly appreciate having both methods in the
same manual.
As a new tech writer, I never hought about including index entries for the
glossary. Someone who's message I unfortunately deleted too fast suggested
this-great idea.
Love this mailing list...
Dick Harris
Millipore Corp.
usrhr -at- bedford -dot- millipore -dot- com
