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.
The largest inconsistencies seem to be the use of parenthases and en dash.
If the standard is that we eliminate confusion, then the question is
whether the inconsistency of use of the italicized terms actually
present any difficulty to follow or understand the material.
I would probably pick one of the forms now containing parentheses or
en dashes, and alter the other examples correspondingly.
However, it would seem rather difficult to say the form in the first
example is ambiguous or confusing in any way.
I presume in the original there was some sort of punctuation between
"health" and "disease" in the second example?
If these lab manuals are done in Information Mapping format or a
reasonable facsimile thereof, I'd consider pull quotes in the large
margin separately introducing definitions. That makes them easier for
the reader to find and use, and make them more memorable. Then,
collecting these definitions in a glossary makes a quick review.
David
On 7/20/05, Gretchen StahmerDemoss <gstahmer -at- vernier -dot- com> wrote:
>
> David,
>
> It was more the inconsistent use of italics and relevent placement of the technical term vs. layman's term or definition that concerns me. The italics didn't show up in the emails so I've marked before and after the word that the author italicized. Hopefully this will make it easier to see:
>
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
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 lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
