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.
How to get them to be consistent? I'd suggest giving the authors a
few simple examples and trust the tendency of human nature to imitate.
How should they do it? Here's my $0,01 (I never over-value my own
opinion). Start with the term you're defining, in _italics_ (or the
text-based cheat I use here) , give measurements units where they're
available, and a simple definition. An additional statement or two
puts each term in context:
_Homeostasis_ is the stable equilibrium of the body's internal
states, such as temperature or pH. Deviations from equilibrium may be
a sign of stress or disease.
_Heart rate_, measured in beats per minute, is the rate at which the
heart muscle rhythmically expands and contracts. Heart rate increases
with excitement, exercise or stress. Fast, slow or irregular heart
beat may be a sign of illness.
_Blood pressure_, measured in mm Hg, is the pressure at which the
heart pumps blood out into the body. Blood pressure increases with
higher heart rate, amount of blood pumped with each beat (_stroke
volume_), and hardening or narrowing of blood vessels.
Heart rate and blood pressure are both considered_vital signs_, easily
measured indicators of the patient's health.
****************
Your mileage may vary, of course.
On 7/20/05, Gretchen StahmerDemoss <gstahmer -at- vernier -dot- com> wrote:
>
> I am in the final stages of editing a lab manual that consists of 24 separate labs. Now that they are all in the same place at the same time I see that the authors were not very consistent with the way in which they handled technical terms that are new to the user. Here are some of ways in which they handled it:
> (I hope the italics come through.)
>
> 1. Homeostasis refers to the body's ability to maintain internal conditions (e.g., temperature, pH, hydration).
>
> 2. Heart rate has been recognized as a vital sign-an indicator of health disease, excitement, and stress.
>
> 3. The cardiovascular system responds to exercise with an increase in heart rate resulting in a higher cardiac output (quantity of blood pumped through the heart per unit of time).
>
> 4. Major determinants of blood pressure are heart rate, amount of blood pumped with each beat (stroke volume) , and the resistance of the arterial system which is receiving the blood.
>
> What is the right way to handle the technical terms? Any suggestions on how I can get them to be consistent throughout the manual?
>
> Thanks in advance,
>
> Gretchen
>
--
I can answer any question.
"I don't know" is an answer.
"I don't know yet" is a better answer.
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.
