Choose the most important information to accomplish a particular task or that otherwise conveys what you want to show. Boil down complex concepts into their most basic form.
Know what to leave in and what to leave out. Remember, you can always create another quick-reference guide to cover other important topics.
If your quick-reference guide isn’t visually appealing and easy to follow, your users won’t find it useful.
You don’t have to create a total work of art to make a good quick reference guide. Sometimes a simple screenshot annotated with arrows, text, etc. can be enough to get someone the information they need.
I feel like I can’t emphasize this enough: Your quick-reference guide just won’t be as effective, engaging, and useful as it can be without good images, icons, screenshots, or other visual elements.
Images draw the eye and help provide anchor points to your content, helping your users quickly and easily identify important points of information.
In fact, our Value of Visuals research found that people learn better with images and text vs. text alone.
Infographic showing that 58% of people believe they remember information better when it's visual, that 67% of people complete tasks better when instructions are provided with visuals or video, and that employees absorb information 7% faster when communications are visual.
You can learn all about how valuable visual communication can be with this awesome infographic.
And, have you ever heard the terms a picture is worth a thousand words? Well, it turns out the best way to show something is to actually SHOW it.
Buy Website TemplateA good image can convey a ton of information and help reduce the text density of your content and make it more user-friendly.
Our friends at Venngage have some more information on the importance of visual content.
Quick-reference guide dos and don’ts
Not all quick-reference guides will be as simple as the one I created. Some will need more text, others will need more images. Some will need more complex layouts. Depending on the subject, it may be longer.
There is a wide range of types of and uses for quick-reference guides, and it would be impossible to cover them all here. But, there are some common dos and don’ts that are pretty universal:
Quick-reference guide dos and don'ts. Text is repeated below the image.
Do
Use a sensible, easy-to-follow layout, with clear headings and subheadings as needed.
Website Templates BlogMake it stand on its own. Users shouldn’t have to look in your manual to understand your quick-reference guide.
Cram in too much information. You’re not trying to fit your whole user manual into this one guide.
Make your font sizes so small no one can read them without an electron microscope.
Quick-reference guides are a great way to provide your users and customers with fast and handy instructions for the most common features of your product or service.
From screenshots and image editing to templates and image assets, makes it incredibly easy to create useful, engaging, and visually appealing quick-reference guides
A quick-reference guide is any documentation that provides a one- or two-page set of condensed instructions on how to use a product.
Yes! A quick-start guide helps a customer or user quickly get started with your product or service without having to know the more intricate or advanced features.
Guide templates provide a mechanism that allows a consistent format to be applied to all or a subset of guides deployed in an application. The format can be easily referenced, making it easy to create a large number of consistently styled guides quickly. Templates hide HTML/CSS customizations from users, allowing non-technical users to create and edit guides in a simple form-field interface.
Administrators and Users with template creation privileges can create and modify guide templates in Pendo. See the "User Roles" article for more detail on how to set user privileges for guide creation and editing. Guide templates are created in the same interface with the other guide settings. In Pendo, go to the “Guides” option, select “Manage Guides In App”, and then select “Global Settings” in the top-right corner.
Selecting “Templates” will show a list of existing templates that can be edited, copied, or deleted. Several templates are provided by default. To create a new template guide from scratch, select the “+ Create Template” button. You can also elect to copy an existing template by clicking the "clone" icon next to a template in the list.
The guide template editor assumes a baseline knowledge of HTML / CSS. The template layout and design are controlled through markup styling only. Like guide design there is a preview, but there is no WYSIWYG editor for the templates themselves.
Specify a name for the new template, and select whether the template is for a lightbox, tooltip, or banner. An individual template can only be developed for a single guide style.
Website Template Code Html FreeDefine the elements of the template that will be customized when the template is used to create a guide. These will become empty input areas to be filled out when building guides with the template.
Common variables may be the title of the guide, or the body text. For each variable, you specify a form label, default content, or prompt text, optional character limit, and a variable name. The variable name is used within the template’s HTML source to sub in the user-provided input for each instance of the guide. These variables will be inserted into the HTML automatically after they are saved.
Any variables created will automatically populate within the HTML tab in the form <% template.variableName %>. Once you have the variables defined, you can then design the layout of the template. Move the variable designations to their desired location in the rendered guide.
The CSS and JavaScript tabs allow you to apply further customization to the appearance or behavior of the template. CSS created within the template applies only to guides using that template and will not overwrite any other CSS defined within your application. JavaScript can be utilized to add custom scripts or behavior to the guide.
The Settings tab allows you to set a default height and width for the template. You can either set a fixed height, or have the guide size automatically based on content by checking the "Auto Resize Height" checkbox. Default width is only available for tooltip and lightbox type guides. Position (Top or Bottom) is available exclusively for banner type guides.