Comments on: Technical Writer vs. Daydreamer: Not So Distant After All

By: Ben

Ben — Sat, 29 Mar 2008 17:11:13 +0000

I agree that generally, we want to avoid something like humor in documentation, but I think it also depends on the nature of the product you’re working on. If you’re documenting a product that is all about fun, then I think it wouldn’t be out of line. One way to look at it is whether humor or lightheartedness would get in the way.

That said, I can’t think of a set of documentation or instructions I’ve used recently that was anything but straightforward and dry. That’s probably why tech writers have the reputation that we do. Instructions for games probably come the closest to being informal. Using humor in some form or degree may help to catch readers’ interest, but you have to know your audience. Examples of casual or lighthearted documentation would be interesting to see, so feel free to post them here if you come across any.

By: Susan

Susan — Sat, 29 Mar 2008 13:12:19 +0000

Generally, technical writers have to avoid humor in documentation at all cost (Rule #1: Never make users feel stupid) . . . but wouldn’t it be fun if we could be creative and add some humor hidden in the help manual for the heck of it? Software developers add easter eggs, why can’t we do something similar.

By: Timber

Timber — Sat, 22 Mar 2008 21:58:15 +0000

I would compare the challenges of Technical Writing to be similar to literary analysis type papers. The paper’s topic may be fairly dry analytical, but there must be an element of creativity in the writing style, or no one will want to read it. The challenge is keeping the ideas clear and your style professional while keeping the reader engaged. You do well, Ben. I think your voice is formal, but also amusing and amused. I like that you laugh at yourself.

By: Ben

Ben — Sat, 22 Mar 2008 16:45:32 +0000

Thanks, Tom. I don’t think I explored the topic very deeply, however. Sounds like future blog material…

By: tom johnson

tom johnson — Fri, 21 Mar 2008 02:11:06 +0000

Ben, I lke your perspective. I’d never thought of creativity transferring into problem-solving slills in technical writing. I definitely agree with you.