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:Assumptions, the audience and arithmetic? From:"Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 15 Aug 2001 09:27:21 -0400
John Fleming reports: <<At one point in the procedure is a series of steps
where the person... subtracts one number from another. The number
subtracted is often negative (meaning, in layman's terms, change the sign
and add). When we hit this spot, my SME went into some pretty convoluted and
arcane descriptions of this process. Points about remembering when to
change the sign and add and so forth. Scary thing is, she had a yellow
sticky to remind her of some of these more arcane gyrations.>>
This person sure sounds like an expert--with few exceptions (e.g., Steven
Gould, David Suzuki) experts tend to understand the nitty-gritty details so
well that they can't explain their subject simply to any non-expert. That's
why God invented technical writers. "Note: If you're subtracting a negative
number, change the sign and add" is about as complicated as you need to get
outside of a course in introductory mathematics; _there_, the "convoluted
and arcane descriptions" might well be appropriate. Provide an example or
two that illustrate how this works and you've provided a concise, effective
explanation for anyone who needs it.
<<Now, the intended audience is generally clerical/accounting staff. That
is, while they are capable of doing a lot of accounting functions, they are
by no means professional accountants or people with BCOM degrees.>>
That lack of professional accreditation should make no difference. If they
already routinely subtract negative numbers, and the software emulates the
same processes they would already do without the software, then they already
know what to do. If that's not the case, then the simple explanation (above)
will tell them everything they need to know. But I have to ask an awkward
question: why isn't the software doing this calculation for the user? It
seems a bit odd to me that someone is doing "back of the envelope"
calculations when the software can do them faster and with far less risk of
error.
<<Can I safely assume that my audience can understand the procedure if
explained in the basic mathematical terms.>>
Not a safe assumption. As writers, we complain about low literacy levels,
but innumeracy is commonly stated to be an even more serious problem. (I
have no actual statistics other than personal experience to support this
assertion. It certainly fits my experience-based prejudices.) The people who
already know how to solve such problems will simply go ahead and do so
without coaching; the ones who don't or who aren't confident in their
ability will need some kind of support (such as the example) to help them
accomplish the task.
--Geoff Hart, FERIC, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca
"User's advocate" online monthly at
www.raycomm.com/techwhirl/usersadvocate.html
"Arthur C. Clarke had suggested that any sufficiently advanced technology
would be indistinguishable from magic--referring to a possible encounter
with an alien civilization--but if a science journalist had one
responsibility above all else, it was to keep Clarke's Law from applying to
human technology in human eyes."--Greg Egan, "Distress"
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
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.