Knowledge Base

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

31 articles in this collection

Written by Mark Manos, Derek Myers and UserDeck Team

Installing Knowledge Base

How to Set Up Your Knowledge Base

How to Set Up Your Knowledge BaseTo create and configure your Knowledge Base, follow these steps:Go to the Settings PageOpen your dashboard and navigate to the Settings page.Select the Knowledge Base TabIn the…

Written by UserDeck Team

Last updated 1 month ago

Basic installation overview

Installing Guides on Your WebsiteAdding Guides to your website is quick and straightforward. You have two main options:Use a CMS PluginChoose from available plugins (e.g., for WordPress) to install Guides with…

Written by Derek Myers

Last updated 1 month ago

Installing using embed code

How to Install Knowledge Base on Your WebsiteSetting up Knowledge Base is fast—usually under 30 seconds. If you're not familiar with editing code, we recommend asking a developer to help with the integration.St…

Written by Derek Myers

Last updated 1 month ago

Installing using WordPress plugin

Add Knowledge Base to any WordPress siteYou can find the UserDeck plugin on the WordPress plugin directory.Step 1 - Create a UserDeck accountBefore you can start using the Knowledge Base, you will need to creat…

Written by Derek Myers

Last updated 1 month ago

System requirements

Web Browser SupportThe Knowledge Base has been built and tested to work with the following web browsers. It may still function in other browsers, but unexpected bugs may occur.Supported Browsers:Chrome (Latest…

Written by Derek Myers

Last updated 1 month ago

Setting up Custom Domain

Search Engine Optimization (SEO)Search engine optimization (SEO) ensures your content is easily discoverable by search engines, which helps attract more traffic to your site. By default, your Knowledge Base con…

Written by Derek Myers

Last updated 1 month ago

Advanced widget integration

Advanced Knowledge Base Widget InstallationThe UserDeck Knowledge Base widget can be customized through an advanced installation. This approach gives you full control over the look and behavior of the widget—pe…

Written by Mark Manos

Last updated 1 month ago

Reacting to widget events

You can attach event handlers to certain events triggered by the UserDeck Knowledge Base widget.Advanced widget integrationTo access the app instance object, you must first complete an advanced widget integrati…

Written by Mark Manos

Last updated 1 month ago

Working with Knowledge Base

Collaborating with users on teams

By using teams, you can add anyone you want to collaborate with.View Users in Your TeamGo to the Account tab on the left side of the control panel.Then go to the Users tab on the account page to see a list of u…

Written by Derek Myers

Last updated 1 month ago

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 or when you want to add context to explain answers.1. Click on the image button in the ed…

Written by Derek Myers

Last updated 1 month ago

Attaching files to an article

Attachments are great for providing content that users can download to get better support.1. Click on the Attachments tab on an article2. Select files to uploadWhen the files finish uploading, click done. They…

Written by Derek Myers

Last updated 1 month ago

Managing article visibility

Managing your article's visibility in Guides is simple and easy while writing your articles. By default, when you begin a new article, it will be unpublished. Saving an article will keep its existing state, whe…

Written by Derek Myers

Last updated 1 month ago

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 within the control panel…

Written by Derek Myers

Last updated 1 month ago

Working with article revisions

Revisions in Guides allow you to easily and quickly switch to a previous version of an article that you were happy with. It acts as a built-in backup for every change made to an article.Viewing the Revision His…

Written by Derek Myers

Last updated 1 month ago

Changing article categories

Categories play an important role in organizing your content hierarchy. Articles can belong to multiple categories.Managing Categories for an ArticleFind the article you want to manage in the control panel.Loca…

Written by Derek Myers

Last updated 1 month ago

View the ratings for an article

Ratings help you determine if an article is helpful and whether it needs to be rewritten, improved, or removed. Each user can rate an article only once.How to view ratings:Find the article in the control panel.…

Written by Derek Myers

Last updated 1 month ago

Deleting an article

When an article is no longer needed because the information is outdated or no longer useful to your customers, you should delete it.To delete an article:Navigate to the article within the control panel.Click th…

Written by Derek Myers

Last updated 1 month ago

Moving a collection to a new Knowledge Base

Each Knowledge Base is essentially a separate knowledge base designed for different sites to embed. When managing large amounts of content, being able to move content between Guides helps with organization. You…

Written by Derek Myers

Last updated 1 month ago

Code formatting with syntax highlighting

Code Formatting with Syntax HighlightingYou can easily showcase code snippets inside your articles using syntax highlighting. If you're using the Markdown Editor, just use triple backticks (```) to wrap your co…

Written by Derek Myers

Last updated 1 month ago

Creating a new Knowledge Base

What is a Knowledge Base?A Knowledge Base is a centralized system for managing and publishing help content such as articles, tutorials, FAQs, and product documentation. It enables your team to support customers…

Written by Derek Myers

Last updated 1 month ago

Organizing your content

Knowledge BaseA Knowledge Base is a centralized hub where you organize help content for your customers. It allows users to find answers quickly without needing direct support. Whether you're managing one brand…

Written by Derek Myers

Last updated 1 month ago

Creating a collection

Creating a CollectionCollections are the top-level structure in your Knowledge Base. Think of them like books that group related content together. Categories act as chapters within those books, and articles are…

Written by Derek Myers

Last updated 1 month ago

Adding an article

Creating an ArticleArticles are the core of your knowledge base. They allow customers to find answers on their own, saving your team from answering repeat questions. Keep explanations clear and straightforward.…

Written by Derek Myers

Last updated 1 month ago

Preview changes live

Live Editing Through the Embedded WidgetOne of the biggest advantages of using our embedded widget is that your content lives directly on your site — and you can edit it live, without needing to navigate away.H…

Written by Derek Myers

Last updated 1 month ago

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…

Written by Derek Myers

Last updated 11 years ago

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…

Written by Derek Myers

Last updated 11 years ago

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…

Written by Derek Myers

Last updated 11 years ago

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…

Written by Derek Myers

Last updated 10 years ago

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…

Written by Derek Myers

Last updated 11 years ago

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…

Written by Derek Myers

Last updated 11 years ago

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…

Written by Mark Manos

Last updated 10 years ago