As you may or may not know, I’m a strong advocate for documentation in electronic formats. Whenever possible, I avoid printing — documentation, or anything else for that matter. Part of that is the environmentalist in me. But I also don’t see the need for having a pile of paper, whether or not it’s bound, in front of my while I’m using or learning software.
Everything I need can be in a PDF file or an online help system. If I find some useful bit of documentation on the Web, then I bookmark it. Services like Delicious and Google Bookmarks make it easy to get access to those bookmarks no matter where I am.
Over the holidays, I was playing with my nephew’s iPod Touch. While getting my fingerprints all over that device, a few of the thoughts I’d been having about not having printed documentation bubbled to the surface of my brain.
In fact, electronic documentation can be a pain to use on or with a device like a iPod Touch or a smartphone. You have to flip between the help screen and the application. That slows you down. And forget about the average mobile phone or MP3 player. Who really wants to boot up their desktop or laptop computer to read the documentation, especially when you want to start using the device ASAP? Not me!
That’s where printed documentation definitely comes in handy. Depending on the device, printing a manual doesn’t need to kill all that many trees. A short 10-12 page guide, which literally fits into the palm of your hand, is usually more than enough. That, according to my nephew, is about the size of the manual that came with his iPod Touch. An even shorter one came with a device called the WikiReader that I reviewed last year.
Admittedly, both the iPod Touch and the WikiReader are simple devices — the WikiReader more so. But even with complex devices, like medical equipment or various types of machinery, it’s easier to have a printed manual on hand than it is to read a PDF or help file on a screen.
For technicians in the field repairing large pieces of equipment, like printers or copiers, hard copy documentation is a must.
That could work in some situations, but mobile devices have their limitations. They tend to run out of juice just when you need them the most. They can easily be lost, stolen, or damaged. Some people might find it hard to read small screens. As well, people working in the field might not have wired or wireless network access, so getting to a central repository of information will be impossible.
Sure, they could have the documents on a laptop but there might not be enough space for these devices in a work area. Again, there are the ever-present dangers of the battery running dry and not being able to plug in. Once, I saw a printer repair technician knock a laptop computer off its precarious perch on to the floor three feet below. A grown man crying isn’t a pretty sight …
Printed manuals can be lost and damaged, too. But it’s cheaper to replace them than to replace an expensive piece of electronics.
Thoughts? Feel free to leave a comment.
Photo credit: cohdra from morguefile.com
Related posts:
10 Responses
Craig
January 13th, 2010 at 10:20 am
1The company for which I work uses printed docs. The sales people like to print the PDFs I write. They mark them up with highlighters and stickie notes and toss the printouts into their briefcases or messenger bags. Web accessibility is important, but the bedrock is print. Unlike web connectivity, print does NOT go down. When the power goes out, print remains.
Tweets that mention When to go with printed documentation by Communications from DMN -- Topsy.com
January 14th, 2010 at 2:07 am
2[...] This post was mentioned on Twitter by DMN Communications, Julio Vazquez and Fabrice Talbot, Kandis Weiner. Kandis Weiner said: There are a few good contexts for printed docs: RT: @dmnguys: http://bit.ly/7YwR5x #techcomm #yam [...]
Ben
January 14th, 2010 at 4:05 pm
3As you and Craig have illustrated, it’s about knowing your audience—where and how they’ll be using the docs. I don’t buy in to “one size fits all” philosophies. Remember what you learned about taking tests in elementary school: Any time a true or false statement contained words like “always,” it’s most likely false. We shouldn’t assume that it will be right for all users to have one certain type of documentation, electronic or otherwise, in all projects we work on.
Ben´s last blog ..Documentation Needs Usability Testing, Too
Technical Writing Newsletter – Camtasia, Crystal Balls, Salaries, Metrics & Twitter « Microsoft Word Tips and Tricks
January 15th, 2010 at 12:08 am
4[...] When to go with printed documentation [...]
Technical Writing Newsletter – Camtasia, Crystal Balls, Salaries, Metrics & Twitter « Business Plan Templates
January 15th, 2010 at 12:37 am
5[...] When to go with printed documentation [...]
Technical Writing Newsletter – Camtasia, Crystal Balls, Salaries, Metrics & Twitter « User Guide Templates
January 15th, 2010 at 2:03 am
6[...] When to go with printed documentation [...]
Technical Writing Newsletter – Camtasia, Crystal Balls, Salaries, Metrics & Twitter « Software Testing Templates
January 15th, 2010 at 3:12 am
7[...] When to go with printed documentation [...]
Technical Writing Newsletter – Camtasia, Crystal Balls, Salaries, Metrics & Twitter « Case Study Templates
January 15th, 2010 at 6:32 am
8[...] When to go with printed documentation [...]
Technical Writing News – Crystal Balls, Salaries, Metrics & Twitter | I Heart Technical Writing
January 15th, 2010 at 1:48 pm
9[...] Meanwhile over in Edinburgh (really great place!), Alistair Christie writes, “You know how sometimes you read something and it niggles away at you and you can’t quite get it out of your system? You might never be able to prove that customers are happier because of the work you do, but if you’re able to prove that customers are less annoyed with the products and increasingly able to get on with their business without calling support, then you might just be able to convince people that documentation is valuable.” When to go with printed documentation [...]
Principles for Organizing Print Material [Organizing Content #21] | I'd Rather Be Writing
July 30th, 2010 at 9:55 am
10[...] When to go with printed documentation. Scott Nesbitt [...]
RSS feed for comments on this post · TrackBack URI
Leave a reply
Blogroll
Past Entries
Communications from DMN is proudly powered by WordPress - BloggingPro theme by: Design Disease