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: Where does the glossary belong? From:Robert Plamondon <robert -at- PLAMONDON -dot- COM> Date:Fri, 31 Mar 1995 14:09:15 PST
I think the glossary belongs in the back, next to the index, where people
can find it. The existence of a glossary doesn't remove the requirement
that terms be defined in the running text, though. To my way of thinking,
putting definitions in footnotes or sidenotes is too cute. Documents
should make sense to the target audience even if the footnotes and end-
notes aren't read at all. This useful rule is violated if you move your
definitions of terms out of the running text.
In tech writing, in particular, getting terms introduced clearly and
at the right time is a big piece of the puzzle. It worries me to
think that they might be literally shoved aside.
-- Robert
--
Robert Plamondon * Writer * robert -at- plamondon -dot- com * (408) 321-8771
4271 North First Street, #106 * San Jose * California * 95134-1215
"Writing is like plumbing -- even people who know how to do it will
pay top dollar to keep their hands clean."
