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.
David Tinsley wondered: <<We have recently consolidated our glossary
terms from long explanations to one or two sentence definitions. Our
rationale is that we believe that the subject should be discussed in
detail at the appropriate place in the text. We had instances where the
glossary was as large as the main text!>>
That's the correct choice. As your dictionary will tell you, a glossary
is a list of definitions, not a comprehensive discussion of a subject.
It's purpose is to quickly explain something, not to provide a PhD
thesis on the topic. Add a cross-reference to the comprehensive
discussion and everyone should be happy, particularly if you're
printing the docs. Managers love cost savings.
<<We now have to "sell" this idea and new definitions to a wide range
of people, from Product Managers, Engineers and Tech Support to name a
few. I would like to go into what is going to be a subjective meeting
armed with some solid professional reasoning behind our decision.>>
See above. You can also bring your dictionary and read them the
definition of "encyclopedia" for the sake of comparison. <g>
--Geoff Hart ghart -at- videotron -dot- ca
(try geoffhart -at- mac -dot- com if you don't get a reply)
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.
