BetterDocs – A Knowledge Base For Your Site
Introduction to Better Docs Plugin
In this section, David McCannon introduces the Better Docs plugin for WordPress. He explains that it is a knowledge base plugin that allows users to create a help section similar to what is seen on sites using help desk software.
Features of Better Docs Plugin
- The plugin comes with a large number of features and customization options.
- It can be used not only for software documentation but also for creating other types of knowledge bases.
- It helps in saving, organizing, and searching for important information such as server information, code snippets, network diagrams, etc.
Free and Premium Versions
- The free version can be downloaded from the WordPress plugin directory.
- The premium version is an add-on to the free version and adds several features such as drag-and-drop article and category organizer, instant answer bot, and analytics.
Setting Up Better Docs Plugin
In this section, David McCannon walks through the process of setting up the Better Docs plugin on your WordPress website.
Wizard Setup Process
- After installing and activating the free version of the plugin, you are greeted by a wizard that walks you through the setup process.
- The wizard lets you select the slug for your knowledge base and enables instant answer chat bubble bot where visitors can search for help docs on any page.
- If you install the premium version first, you don't go through the wizard. Instead, you go to the settings tab.
Settings Tab
- The settings tab allows you to use the built-in documentation page, change the slug for the knowledge base, categories and tags.
- You can choose who you want to collect analytics from - everyone, guests only or registered users only.
- The layout settings tab has a large number of settings that can be customized.
Shortcodes
- There are shortcodes available if you want to manually create your document pages or integrate part of the knowledge base into some section of your site.
Creating a Knowledgebase Article
In this section, the speaker explains how to create a new knowledgebase article using the Better Doc's plugin. They also discuss the different page builders that can be used and how to organize categories for better navigation.
Creating a New Knowledgebase Article
- To create a new knowledgebase article, go into the regular WordPress editor.
- Use Elementor or Gutenberg to add widgets and blocks for almost any type of content.
- Organize articles into categories for better navigation.
Customizing Better Docs Plugin
In this section, the speaker discusses how to customize the Better Doc's plugin using the high-level customizer item in WordPress. They explain how to change templates, background colors, padding width, spacing between columns, icon sizes, font sizes and more.
Customizing Better Docs Plugin
- The high-level customizer item provides five additional customizer areas.
- Templates are available in several areas including docs page and single docs page.
- Customize content area padding, breadcrumbs, table of contents, title and social sharing buttons.
- Customize sidebar icon size, font color and background color.
- Archive pages can have background color images and category names can be customized.
Overview of BetterDocs
In this section, the speaker provides an overview of BetterDocs and its features.
Customizer Options
- BetterDocs offers customizer options for managing knowledge base articles.
- The plugin also includes an auto-generated document page, archive page with individual articles, and an example of an individual article on the home page.
Instant Answer Bot
- The Instant Answer Bot is a helpful feature that can be seeded with articles or searched for by visitors.
- It can provide help on any page without needing to always be connected to a computer or phone checking if someone has messaged you.
- If your visitor doesn't find what they're looking for there's an option for a forum here that sends an email and there's also the option for animo mood feedback here.
Analytics
- The analytics area shows the number of views on different days.
- There is also an option for feelings but the instant answer bot is the only place where it's possible for someone to give that feedback.
- The analytics area needs to be made more robust to be useful.
Conclusion
- Overall, BetterDocs has everything needed plus some nice extra features.