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.
Subject:Re: (Was Glossaries etc.) From:Len Olszewski <saslpo -at- UNX -dot- SAS -dot- COM> Date:Tue, 29 Mar 1994 13:32:53 -0500
Chad Hill asks:
> What I'm wondering is this: Would my audience (typically uninitiated
> technologically) benefit from BOTH an index AND a glossary, or margin
> definitions AND a glossary. I seem to think that the later of the two would
> be most helpful to my particular audience (but I'm quite interested in your
You need an index no matter what. Always.
Nothing stops you from providing margin definitions and a formal
glossary. However, you may want to just *emphasize* a text definition
(like Mike Pope and I do in our books, evidently) rather than
marginalize it, based on how many you have. Your call.
So they want you to make your book *shorter*, do they? That argues
against margin-anything. Consider multiple columns and more tables and
> I'm the pup around here (literally) so I'm rather interested in my elders'
> responses. You folks have had much more experience with this sort of thing.
Now *that's* encouraging. Well, young feller, back when I first started
out, why, we didn't even have *ink pens*, nossir. We used charcoal and
the backs of shovels - *wooden* shovels. No durn glossaries; our readers
had to *guess* what we meant. And they *liked* it! Heh.
|Len Olszewski, Technical Writer |"Thou gettest no bread with one |
|saslpo -at- unx -dot- sas -dot- com|Cary, NC, USA| meatball." - Robert Sheckley |
| Opinions this ludicrous are mine. Reasonable opinions will cost you.|