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.
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."
HTH,
Marguerite
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 http://www.ehelp.com/techwr-l
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). http://www.componentone.com/d2hlist1002
---
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 http://www.raycomm.com/techwhirl/ for more resources and info.
