Search results

Quick reference guides

Quick reference guides refer to short, compressed guides that users can refer to instead of the longer manual or help site. The quick reference guide often condenses and distills the most important points, core tasks, and other key information into 1-2 pages. A similar deliverable is a getting started guide, which is oriented to setup and configuration for new users, while the quick reference guide aims to be a regular reference even after the user gets started.

The following content is in the quick-reference-guides category:

Webinar Recording: Designing Quick Reference Guides

Starting Points with Quick Reference Guides: Gathering Before Designing

Documentation Usability: A Few Things I've Learned from Watching Users

Quick Reference Guides: Short and Sweet Documentation

Quick Reference Guides Right Where You Need Them

Lessons Learned with Quick Reference Guides: Timing and Truth

Quick Reference Guide Formats -- Tips for Finding Attractive Layouts

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.