February 23, 2012
Text Size

Quick-Start Guides

Users need to use the products you sell. People have problems using online Help systems; this has been often documented. For many, it’s too hard to page through subject after subject in online Help just to find what hotkey they can use to conduct an operation much more quickly. I can’t blame those people; I hate Help, too. In most cases, it just doesn’t help.

Teach Your [Customers] Well…

Okay, the point is valid even if it’s borrowed. Is one of your organization’s goals retention of customers? If so, it’s important to provide quality training and reference materials that help them use your products. What happens otherwise?

  • Confusion
  • Help Center calls
  • Poor reviews
  • Lost sales

These can happen, that’s what.

Analysis: How Do Adults Learn?

Adults most often learn by directing themselves and evaluating, on their own, the quality of their learning. In part, this reflects the different influences and demands upon an adult as opposed to a child. The science of teachig children is known as pedagogy whilst that of adult learning is andragogy. When an adult attends a class at a university or an instructor-led seminar, she or he is being taught pedagogically. On the other hand, when your customer installs, opens, and tries to use your product—either hardware or software—he or she is learning andragogically since the adult learner directs his or her own training.

Customers use your documents only as references. They want to quickly obtain an answer to a specific question of immediate concern to them.

That’s why Quick-Start references and user guidebooks are so important to you—your customers depend on your documentation to easily and properly use your products.

The Quick Reference Guide

A Quick-Reference guideThe Quick-Start Reference, or Quick Reference guide, is an operational roadmap for your product. It shows and briefly describes the shortcuts that may be taken to accomplish a task using your product. The content does not attempt to explain why the user should push a button; it merely shows what button or buttons may be used to execute a simply identified task.

Typically, I organize a Quick-Start reference by the operations a user can execute with your product. The requirements analysis used to guide your design specifications is critical to the organization of this reference. After all, the requirements were based on analyses of your customers’ needs and wishes, weren’t they?

What’s a “User?”

Users are also widely characterized as the class of people that use a system without complete technical expertise required to fully understand the system. In most hacker-related contexts, they are also divided into lusers and power users. [Wikipedia]

Distribution

You can distribute quick reference guides as:

  • 3"x5" cards
  • Printed rochures
  • Printed fold-out sheets
  • Electronic portable document files (PDF)

 

jrtc logo