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[2]: Using Humor Judiciously From:Arlen -dot- P -dot- Walker -at- JCI -dot- COM Date:Mon, 20 May 1996 14:57:00 -0600
I absolutely hate humor in documentation for software and/or hardware
products.
Humor is difficult to judge. Too many times it suffers from terminal
cuteness. For example, I hate the "x for Dummies" series. The kind of humor
that I've always enjoyed shows up in the examples, rather than the text. I
love it when you give me puns in the example text and file names.
Beyond the examples, about the only places humor can organically fit are in
the warnings and cautions. Face it, most error conditions can easily be
made the object of a joke. Just make sure you're ridiculing the computer,
not the user.
I think too often you have to strain to fit humor into the text, and
strained humor always fails (like most stews, humor is chunky). You need to
make it come naturally out of the situation you're describing. My all-time
favorite line from a user manual employed a small degree of humor. The
manual for a program called "hTest," a hard disk optimization and testing
package contained the sentence:
"While this operation should not damage the data on your hard drive in any
way, no sane person would try this without a backup."
Not only simple, clear and to-the-point, but "...no sane person..." makes
it memorable. Which is perfect for a warning.
Have fun,
Arlen
Chief Managing Director In Charge, Department of Redundancy Department
DNRC 124
Arlen -dot- P -dot- Walker -at- JCI -dot- Com
----------------------------------------------
In God we trust; all others must provide data.
----------------------------------------------
Opinions expressed are mine and mine alone.
If JCI had an opinion on this, they'd hire someone else to deliver it.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Post Message: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Get Commands: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "help" in body.
Unsubscribe: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "signoff TECHWR-L"
Listowner: ejray -at- ionet -dot- net
