Best Practices for a Quick Start Guide
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/27/2008
Research shows that placing a great "Start Here" foldout in the box will significantly improve the out-of-box experience for users and reduce the number of support calls. The following list shows best practices for this type of guide:
The guide should be the first item the user sees when the box is opened.
If the guide is in a prominent position in the box, the user is less likely to ignore it and start exploring the device without additional guidance.
Use an accordion-fold guide format if possible.
A guide that is folded accordion style has shown to work better than a guide in booklet form. Users are most likely to use this type of format and complete all of the steps because it shows all of the getting-started tasks at one glance.
Use a simple page layout that includes a call to action.
The following list shows suggestions for page layout:
- Use a clear call to action on the cover page, for example, "Start Here."
- Use one page per major task.
- Number the mandatory tasks that need to be done in order.
- Use large, bold numbers that clearly stand out. Users are more likely to follow steps with this type of formatting.
Use concise, consistent, and user-friendly terminology.
It is important to provide only information that is absolutely necessary for starting and initially using the device. Too much information will drive users away from using the Quick Start guide.
Use terminology that is consistent with the user interface and with other documentation, such as the user guide. The following list shows suggestions for terminology usage:
- Avoid using different names for the same thing.
- Provide examples when necessary. For example, if the user will have to type a Web address, show an actual Web address.
Use pictures or illustrations in the guide.
Often, a picture or illustration makes a point better than words. Clear illustrations make users more confident. Without clear guidance, users may be afraid of damaging the hardware, especially if it is an expensive device.
Examples of when an illustration would be helpful include showing the contents of the box, explaining the various parts of the device, or showing how to connect the parts.