[PizzaBob]

In designing what can be considered boring technical manuals, and the subject matter in my case is O&M for wastewater facilities, I'm always looking for new and eye-catching formats, styles, etc... that can make technical reading less on the heavy eyelids and more on the eagerness to learn.

Any suggestions and I mean ANY... would be appreciated.

Bob C.

[Chrissy Scivicque]

I find that most people respond best to writing that is easily scanned. When they're looking for information, they want the bullet points. I like to make sure that most of my writing has clear headings, sub-headings, bullet point lists, and lots of white space. Even if it makes the document longer, it simplifies things.

Also, don't underestimate the use of a few pictures or diagrams to describe what you're talking about. Don't go over board, but if there is something that can be helped with an illustration, add it. And lastly, a little humor or light-hearted somethin' might help move things along. Add a funny story, a comic that is especially relevant, or something that breaks up the monotony of technical know how.

I have a great user manual for the "Snowball" which is a new, fancy microphone. It's super cute because the writer has added quotes from "Frosty the Snowman" and "The Abominable Snowman." It starts with: "We know you hate to read manuals. So do we!" Quick tips are labeled with the words "Heads up!" Overall, it's a good read...which is unusual for a manual of any sort.

Hope this helps!

[topshelfma]

Originally Posted by PizzaBob

In designing what can be considered boring technical manuals, and the subject matter in my case is O&M for wastewater facilities, I'm always looking for new and eye-catching formats, styles, etc... that can make technical reading less on the heavy eyelids and more on the eagerness to learn.

Any suggestions and I mean ANY... would be appreciated.

Bob C.

Hello Buddy, I've been a technical writer for over 20 years. Of course, pleasing your manager/ subject matter expert is key in designing the course/ manual. However, I've discovered that short, concise bullets that begin with a VERB, definitely get the points across effectively and with less confusion.

One hint I'll offer is asking questions in your subheadings. For example, "How do you prevent .........?" That way they instantly think of how it relates to their job, versus just reading boring topics.

By the way, I've done a bunch of contracting assignments as a tech writer and earned twice the money.

You may find some other helpful hints at this blog -- http://BiblicalBusinessSense.blogspot.com