Guides

Everything about our knowledge base product which allows you to provide answers to your customers.

Derek Myers avatar Mark Manos avatar
30 articles in this collection
Written by Derek Myers and Mark Manos
Installing Guides

Basic installation overview

Installing Guides to your website is fast and easy. We have several fast ways to install Guides. Pick a CMS plugin or you can simply copy the embed code. Any of these options should take just 30 seconds to begi…

Installing using embed code

Installing Guides is super easy. It can take just 30 seconds. If you're not familiar with how code works you should get in contact with a developer to do the integration for you. Step 1 - Create a UserDeck acco…

Installing using WordPress plugin

Add Guides to any WordPress site. You can find the UserDeck plugin on the WordPress plugin directory. Step 1 - Create a UserDeck account Before you can start using Guides you will need to create a UserDeck ac…

System requirements

Guides has been built and tested to work with the following web browsers. It may work in other browsers that are not supported, but may have strange bugs as a result. Web browser support: Chrome (Latest versio…

Setting up SEO support

Search engine optimization (SEO) is enabling content to be accessible by search engines so they can index the content to provide them as results for users which in turn drives traffic to your site. By default,…

Advanced widget integration

The UserDeck Guides widget can customized through an advanced installation allowing you to customize the look and behavior of your knowledge base. Performing an advanced installation To get started, copy this m…

Reacting to widget events

You can attach event handlers to certain events triggered by the UserDeck Guides widget. Advanced widget integration You must first perform an advanced widget integration to gain access to the app instance obje…

Working with Guides

Creating a new guide

A Guide is a knowledge base system. You can create multiple Guides per account depending on the plan. Multiple Guides are great for those who have multiple websites or a multiple business and want to be able to…

Organizing your content

Guides Guides is the knowledge base and you can consider this a library of knowledge you can provide your customers for your business. Collections Collections are the top most layer of a knowledge base. They ar…

Creating a collection

Collections are a layer of separation for your articles above categories. You can think of collections like a book and categories as chapters. Navigate to the control panel and click on the new collection butt…

Adding an article

Articles are at the core the central part of your knowledge base. They should empower customers to answer questions themselves in order to save you time from answering the same question repeatedly in the future…

Preview changes live

One of the great features to our embedded widget approach where content lives on your site is that you can edit the content live on your site. First go to your page where Guides is installed. Click on the Admin…

Collaborating with users on teams

By using teams, you can add anyone you want to collaborate together with you. View users in your team Simply go to the Account tab on the left side of the control panel. Proceed to the users tab on the acco…

Uploading images to an article

You can easily add an image to any article by uploading it from your computer. This is especially useful for screenshots and other times when you want to add context to explain answers. 1. Click on the image bu…

Attaching files to an article

Attachments are great for providing content that a user should download in order to provide better support. 1. Click on the attachments tab on an article 2. Select images to upload When the images are finished…

Managing article visibility

Managing your article's visibility in Guides is simple and easy when you are writing your articles. By default when you begin writing a new article it will be in an unpublished state. When you save an article i…

Managing related articles for an article

Related articles are a great way to help customers find the next step when reading or troubleshooting problems themselves. First, find the article you want to manage related articles for from within the control…

Working with article revisions

Revisions in Guides allows you to easily and quickly switch to a point in history where you were happy with the article you had. It's a built in backup for every change to an article you've made. Viewing the re…

Changing article categories

Categories are an important part in the heirarchy of organizing your content. Articles may even belong to multiple categories. First find an article in the control panel you want to manage. Next locate the Cate…

View the ratings for an article

Ratings allow you to see if an article is helpful or not and should be rewritten, improved, or discarded entirely. Each article is able to be rated once per user. Find the article in the control panel. Next loo…

Deleting an article

When an article is no longer needed, as the knowledge is no longer relevant or useful to your customers, you should delete it. Navigate to an article from within the control panel. Click on the trash can icon a…

Moving a collection to a new guide

Each Guide is essentially a different knowledge base meant or different sites to embed. When managing larges amounts of content and getting organized being able to move the content between Guides becomes helpfu…

Code formatting with syntax highlighting

The hosted version of Guides allows you to share code snippets with the syntax highlighted inside your article. The following examples were created using our markdown editor. If you prefer to use the WYSIWYG ed…

Customizing Guides

Default style guide

This is a heading 1 This is a heading 2 This is a heading 3 This is a heading 4 This is a heading 5 This is the normal paragraph text. This is the normal paragraph text. This is the normal paragraph text. This…

Overriding default styling

When the Guides widget loads on your page, it's styles and content are placed inside your existing page's DOM. This means that it inherits your existing CSS styles and applies them to the DOM when it loads auto…

Embed any content type

The power and flexability of Guides really shows when you want to embed any type of content onto your site. The default out of the box functionality is to embed an entire guide, but with a simple tweak to the e…

Frequently Asked Questions

How does the widget work?

The widget uses JavaScript to provide a very fast experience for users and hooking into the browser history and pulls in the content using AJAX from our servers using APIs and serve it to your users very fast u…

Why is a widget better than using subdomain hosting?

With existing solutions that require using a subdomain, you have to duplicate your website's layout design and styling to match completely. If you redesign your website you have to go and duplicate all that wor…

Why price based on number of page views?

Due to the nature of how we provide a hosted service and content is stored on our servers and served through the embedded widget on customer's websites. We've found that when customer's websites scale for traff…

Does the widget integrate with Google Analytics?

The UserDeck Guides widget does support working with Google Analytics. The widget code will automatically detect a Google Analytics installation on the page and will trigger page view events every time a new pa…