Skip to content.

TalkBMC

Sections
You are here: Home » Blogs » Michele Marques » Write On » Are printed manuals a thing of the past?

Are printed manuals a thing of the past? Are printed manuals a thing of the past?

Document Actions
I still find paper instructions with my software and hardware products, but there are fewer manuals, and the manuals are getting smaller. What sort of documentation do you get with the iPod?

For many years I've heard the debate over whether to include printed manuals with the products. It seems like the move to PDF, online help, wikis, and blogs must finally be making a dent in how much we print, because one of the printer manufacturers is running a big ad compaign in an attempt to get people to print more.

What sort of documentation do you get with the iPod?

Recently, I finally got an iPod. Of course, as a writer, I find myself paying attention to how they provide documentation, and it gives me some ideas for documentation minimalism. Even with their simple design, Apple includes a small printed manual. More of a mini-brochure with just a few basics to get started.

You have to go online to get a more complete manual. But what a great idea! Besides not wasting paper on printing (I didn't print my copy), I have the latest version.

But even if you don't look at the manual, some of the less obvious features are displayed on the iPod where you need it. For example, a note in the Contact section provides instructions on how to load contacts if you don't synchronize with outlook. Or when I accidentally created an on-the-go play list, an additional on-the-go play list appeared and included a note explaining the feature.

 What does this mean for documenting larger products?

The iPod is a simple consumer device. Although it's a great device, it supports only limited functionality (not that I necessarily want it to do more). Does the iPod's documentation offer any suggestions to how to improve the documentation experience for products that offer greater functionality, such as BMC Remedy Service Desk?

To me, it seems like there are a few lessons that can be learned:

  • In the box, include printed materials only to cover the bare minimum of what people need to know to get started. This highlights what is needed to get started, and doesn't overwhelm people with information that they need only later.
  • Make the bulk of the manuals available on-line (although electronic copy included with the product distribution media might also work).
  • Provide help where they need it. Does this mean context-sensitive help? Field-level help? Help panels embedded in the product at key points? I'm not sure.
What about you?

How do you like to receive your product information? Do you have any examples of what works for you? and what doesn't? Leave a comment - I'd love to read your thoughts.


  Add to Technorati Favorites    Save this page to del.icio.us


_____
tags:
Saturday, September 01, 2007  |  Permalink |  Comments (2)

paper-based documentation

Posted by David Farbey at 2007-09-03 08:12
Here's a snippet of research based information for you: in March 2003, 87% of 305 technical writers who responded to a survey I undertook as part of my MA dissertation research stated that their work included the creation of printed manuals.
See: http://www.farbey.co.uk/js_summary.htm
I would love to see more recent research to see if there's a trend.
Michele Marques

Subscribe to Michele's blog Subscribe to Michele's blog

Michele Marques Bio

Technorati - Michele Marques
 

Powered by Plone

This site conforms to the following standards: