Five Quick Tips on How to Create a Good Cheat Sheet

Mar 29, 11 • technical writing • 1 Comment • Read More »

Projects usually have user manuals that are in-depth how-to guides for users. However, user manuals, even if they are online, do not make sense all of the time. When you get a new gadget, it usually comes with a quick reference that is a one-page pullout sheet, and a user manual that has more pages. You should have the same approach to end-user documentation.

I just created a few cheat sheets for a project that I’m writing end-user documentation for. Here are five tips that I want to share on how to create a cheat sheet that is of use to the users:

1. No More Than One Page

Cheat sheets should only be one page. They are called “cheat sheets” for a reason. The person should have the basic information that he/she needs without having to scramble around looking around for the information. You would see cheat sheets that have useful keyboard shortcuts, how to get through an entire process, and even quick codes for development. Whatever it is, remember to not go over a page.

2. Don’t Over Explain

In a user manual, you would go into every minor detail about each functionality. Don’t do that on a cheat sheet. If the user has to divert his/her eyes to more than two places, then you have lost the battle.

3. Don’t Reference Another Document

You need to have all the information right in front of the user, so he/she can access it. If you reference another document, then you are doing it wrong.

4. Make it Visually Appealing

You don’t have to be a graphic designer to make cheat sheets visually appealing. You can use color to specify the change in topic. White space is also a great way to visually show that is the end of a step. The best ones I have seen are very colorful and are smart in their use of white space.

5. Use Tables

A good way to separate different thoughts is to use tables.

Bonus Tip: Use Smaller Font

Yes, you might hurt the eyes of some of the users. But, it’s a cheat sheet. They will forgive you…eventually.

Some Examples of Good Cheat Sheets

Written by: Shevonne on March 29, 2011.
Last revised by: Shevonne on April 21, 2011.

Tags: Cheat sheet, how to cheat sheet, quick reference guide

Pingback: 6 Help Tools to Help Your Users Out | Chicwriter | Chicwriter