A couple of weeks ago I gave an STC webinar called Designing Quick Reference Guides. This was a general STC webinar, and usually I am not allowed to repost the recording, but due to some audio difficulties, I had to re-record it, and the STC gave me permission to post the re-recording. Here are the files to watch or download the webinar: Webinar recording | … more »

I’m giving an STC webinar this week on designing quick reference guides. Here are the details: Designing Quick Reference Guides Date: Wednesday, 25 January | 1:00–2:00 PM EST (GMT-5) Condensing a manual into an attractive quick reference guide requires a poet’s precision with language, but it also requires you to exercise skill with visual design and page layout. These short guides blend marketing with instruction, … more »

A few years ago, I was scouring magazines to get ideas for quick reference guide layouts. In particular, I found that WIRED magazine has some of the most creative and engaging layouts, often with text laid out in three or four columns, or along the side of a graphic, or in various quadrants about the page. I was trying to figure out the right layouts … more »

In my previous post (“Less Text, Please”), I argued that users want shorter texts. I also explained how social media and Internet sites have possibly rewired our brains to incline us toward shorter content — according to some, our gnat-like attention spans can only consume a few short paragraphs before tapping out. The Onion has a great parody of how a single block of uninterrupted … more »

Last year I started a series on organizing content that spanned nearly 30 posts. I want to return to this thread with a summary of why findability becomes an issue for technical writers, and what the information paradox is that we encounter. Then, in an usual ethical twist, I’ll explain why findability might not actually be an issue. The Documentation Scenario The help scenario starts … more »

I was surprised and mildly pleased this weekend to see my sister-in-law Karin give a quick reference guide or “cheat sheet,” as she called it, to her grandma for her birthday. The guide focused on accessing and sending email in Gmail. Grandma was grateful and elated to see the work and detail that went into the guide, which was laminated and narrow enough to prop … more »

One of my readers, Shweta, asks the following question: I am a Technical Communicator working in a software services company in India. I have been reading your posts daily from a long time now. I am developing end-user documentation for an access control product. The current application that I have is huge and so is the user manual (550 pages, which I am sure not … more »

For years I prided myself on single-sourcing both online help and printed guides. When I used RoboHelp, I created custom macros in Word to clean up and adjust the print formatting. With Madcap Flare, I hammered out the print styles until everything looked clean. And then I made a major mistake: I more or less single sourced the online help to the printed guide in … more »

Catalyst 1: Audiovisual Role With the instability of contract renewal pending and the lack of housing in the desert, I switched jobs to a non-profit organization, the LDS Church, which had an agile environment and about 600 IT employees and was growing rapidly. They had already been coding an application for about six months and realized that they would need a professional technical writer to … more »

Some months ago I created a half a dozen quick reference guides for an application that would have a potential audience of thousands of users (after it cleared the beta phase). The size of the audience gave me hope that I would actually create documentation to be used by more than a handful of people outside the internal workings of my organization. I created the … more »

Chrysler moved their car manuals from the traditional thick paper manual to a shorter format  accompanied by a DVD. Chrysler says the switch will not only save 20,000 trees a year, the videos on the DVD will also be more helpful to users trying to perform tasks. The shorter quick reference guides will still be 60-80 pages long (judging from the photo below, they also … more »

I’m currently reading Trees, maps, and theorems: Effective communication for rational minds, a new book by Jean-luc Doumont. The reason I wanted to read the book is for Jean-luc’s expertise in visual design and page layout, because I thought it could help me design better quick reference guides. Although very little of the book deals with design and is more geared toward engineers (the “rational … more »

14 Essential WordPress Development and Design Cheat Sheets : Speckyboy Design Magazine. Great examples of quick reference guides, which they call cheat sheets intead.

In The Back of the Napkin, Dan Roam explains that drawing pictures can help you solve problems. He says the first rule is to “collect everything possible up front” (p.58). After collecting all your information, you then “lay it all out where you can look at it” (p. 61). By laying out all the information, you can grasp the whole of it, make connections between … more »

Have you ever tried to adjust your office chair but couldn’t remember how to do it? Do you ever look at all the little levers under your seat and wonder how they work with the myriad muscles in your back? Don’t you wish you could just pull a quick reference guide … out of the arm of your chair?