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.
About twelve years ago, my senior writer at Microware Systems was working on
a networking manual in which she needed to explain master/slave
relationships for the OS-9 NFS network. In her example, she named the
master, Mick, and the slave, Keith. The ensuing discussion of Mick's and
Keith's relationship was accurate as far as networking was concerned, but it
was a hoot as far as the Stones were concerned.
My favorite example of humor in manuals (also from about 12 years ago) comes
from the FrameMaker 1.0 and 2.0 manuals (maybe even 3.0). All of their
example documents in the manuals were created in the fictional world of
Buckaroo Banzai (sp?). Letters from John Bigbootie, etc. They were
consistent throughout the 1000 or so pages. It made for quite entertaining
reading while learning Frame 1.0.
I have attempted to follow in FrameMaker's footsteps to some degree in our
company's style manual. Consistent humor in all examples of accepted and
unacceptable styles. The writers that have used the style manual over the
years have generally enjoyed it. Only one writer that I can remember
"didn't get it." But even without understanding the silly humor, that
writer could use the style manual effectively.