RE: Word selection and highlighting for glossaries

Subject: RE: Word selection and highlighting for glossaries
From: "Marguerite Krupp" <mkrupp -at- cisco -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 25 Oct 2002 14:59:15 -0400

Hi Rebecca!

I used to italicize the first occurrence of such terms, but that's not the
company standard where I now work. We do have a corporate glossary of terms,
accessible online (but you have to know it's there), but IMHO (and I helped
compile one such glossary), it's too far removed from the user's immediate
need to do much good.

So, as usual, "it depends." I agree that all that bolding is ugly. If you
make it obvious that the term's definition appears in context immediately
after the first occurrence of the term (and maybe say so in the Preface),
you should be OK without any typographical enhancement. I do think it's
useful to include such terms in the Index, usually (if you can slip it by
the editorial/template police) with an indicator that points specifically to
the definition; for example, "obscureterm (defn.), 1-7."


All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at

Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250).

You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Word selection and highlighting for glossaries: From: Stevenson, Rebecca

Previous by Author: RE: Legal Requirments for a User's Manual
Next by Author: RE: Analysis Documents -- planning, writing, etc.
Previous by Thread: Word selection and highlighting for glossaries
Next by Thread: Using Bold Fonts instead of making Font Bold

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

Sponsored Ads