Search results

Quick Reference Guide Formats -- Tips for Finding Attractive Layouts

Series: Quick reference guides

by Tom Johnson on Dec 31, 2008
categories: technical-writing quick-reference-guides

Quick reference guides provide one or two page condensed instructions. Formats for quick reference guides vary dramatically and can involve complex, multi-colored layouts, or just simple text callouts next to a few images.

The other day I stopped by a local thrift store (Desert Industries) and picked up a few magazines for $.25 cents a piece, looking for attractive layouts that I could use as quick reference guide formats. The format most appealing to me was this image from Fast Company:

A possible layout for a quick reference guide from a magazine
A possible layout for a quick reference guide from a magazine

I used this layout as a guide in Adobe InDesign and created the following quick reference guide format:

The quick reference guide I ended up creating in Adobe InDesign
The quick reference guide I ended up creating in Adobe InDesign

(By the way, here's the Adobe InDesign file if you want to use this.)

Notice several elements of the layout. The red task titles contrast sharply with the text beneath them, as well as the paragraph subheads. Also, the text is placed near the image it refers to, with an arrow that leads the reader's eye down the page. Additionally, the tasks are aligned vertically so they have equal spacing in the margins. I haven't crammed too much text on the page -- the white space allows it to breathe.

The purpose of this quick reference guide is to provide a snapshot of a complicated-but-frequently-used task in the application. It's not intended as an overall how-to for everything -- just a popout of a process users may find confusing.

You can find a lot of ideas for attractive quick reference guide formats by looking through magazines. Here are few of the other layouts I found:

Good table layout for the back of a quick reference guideAnother layout option for quick reference guidesA layout with a large picture and side column

Nice tri-column layout, allowing for brief descriptions of tasksDouble column layout for a quick reference guide -- perhaps too symmetrical

A colleague and I are presenting on quick reference guides at the next STC Summit. In preparation, I'm trying to gather as many attractive quick reference guide layouts as I can find. If you have any, feel free to send them my way. See my contact page for how to contact me.

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.