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: injecting a little whimsy into grey text From:"Michael West" <mbwest -at- bigpond -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 9 Oct 2008 09:01:23 +1100
> I was once writing a journal article on spinal motor control.
> Describing why one type of circuit was in the frog but not in the cat,
> I wrote "cats do not swim voluntarily." I was told to take it out.
That's a good example of why "humour" is a problem in technical material.
What someone might think is terrifically clever will sound stupid,
incorrect, or offensive to many others.
As your editor probably understood, iit is well known that many cats will
choose to swim when there is sufficient reward on offer, and the comment you
inserted might be taken by some readers as making light of cruelty to
animals.
Many technical writers I have known were culturally ignorant or insensitive.
They might know a lot about a TV show or a fantasy novel, but they know
little about the real world. This doesn't make them different, as a group,
from other professions, but it does make them ill-suited to decide what a
diverse audience will and won't find "funny".
The best way to make technical writing "not boring" is to make it clear,
concise and free of irrelevencies.
--
Mike West
Melbourne, Australia
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-