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: Correct Wording for Examples (#932777) From:wburns -at- MICRON -dot- COM Date:Mon, 25 Nov 1996 07:40:53 MST
Elna responds,
>No, it is NOT correct to avoid using these abbreviations, which are in
>wide use in the non-technical audience.
>If you're getting static from a technical reviewer on this, point out
>that most users generally know what e.g. and i.e. mean. If you have
>doubts about the literacy levels of your user, you can spell them out.
Hmmm. This position flouts most of what I've read in technical writing style
guides. In fact, I work in a technical environment in which both of these
abbreviations are misused consistently. Very few of these folks know the Latin
for these abbreviations, and too many pick up the bad habits of writers who use
the initialisms indiscriminantly. Perhaps it's not that big an issue when an
experienced operator or technician running a machine comes across these
initialisms in a simple procedure, but it could definitely be an issue if, in a
safety document, someone confuses the two terms and we wind up in a lawsuit
because of the misunderstanding. I'll stick with "that is" and "for example."
Bill Burns
Assembly Documentation Supervisor
wburns -at- micron -dot- com
-----------------------------------------
This message brought to you by W.A.S.T.E.
and your local potsmaster.
-----------------------------------------
