RE: Glossary structure

Subject: RE: Glossary structure
From: "Goldstein, Dan" <DGoldstein -at- DeusTech -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 8 Sep 2004 16:06:17 -0400


Try to address the following in your presentation:
* What is the document's target audience?
* What is the document's purpose?
* How does the current glossary obstruct that purpose?
* How would the proposed format better serve that purpose?

Target audience feedback on the proposed change would also be helpful, but I
assume you don't have the time or resources for that (who does?).

Dan Goldstein

> -----Original Message-----
> From: David Tinsley
> Sent: Wednesday, September 08, 2004 3:51 PM
> To: TECHWR-L
> Subject: Glossary structure
> Greetings,
> I would like to solicit opinions on glossaries, 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!
> 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. This
> is where this
> group comes in :) Thank you in advance for your experiences
> or opinions.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.



Previous by Author: RE: Asking for Author Credit In The Documentation?
Next by Author: RE: Placement of cautions in procedures
Previous by Thread: Re: Glossary structure
Next by Thread: Glossaries


What this post helpful? Share it with friends and colleagues:


Sponsored Ads