Adding Documentation to you website can be beneficial for UI (User Interaction) & UE (User Experience) of the site, it will make easier for them to understand how to use you goods or services. It will also improve SEO of your site, and reduce support tickets on your website.
If you are looking for a way to add Documentation on your website, but don’t know how to. Do not worry you are at the write place, Here is the comprehensive guide to add Documentation in WordPress.
Why should we add Documentation to our website?
Before knowing how to use it, you must understand why you should add Documentation to your website.
If you add Documentation to Your WordPress website, it will provide you with information about using your products/services, including features, new releases, add-ons, and more.
The Doc WordPress theme includes various content, such as FAQs, Tutorials, how-to guides, knowledge bases, and API documentation.
For example, if you have an online bakery store, you can add Documentation specifying how to order, how to customize your order, how to buy a premium membership to get recipes, and so on.
How to Add WordPress Doc Plugin?
We have various WordPress plugin Documentation available to choose from; one such is Heroic KB.
It is the best WordPress knowledge base plugin on the market. It gets very easy to add Documentation in WordPress via Heroic KB plugins. It adds a searchable knowledge base to your existing site. It has an AJAX search feature, drag-and-drop content ordering, article attachments, and more.
Here is a step-by-step guide to add documentation to your website.
Step1: Construct Heroic KB General Settings
First, you need to install and activate the Heroic KB plugin to add documentation to your site.
Upon activation, visit the Heroic KB » Settings page from the WordPress admin sidebar and switch to the ‘License and Updates‘ tab.
After entering your plugin’s license key, it’s essential to click the ‘Save Changes‘ button. You can get this information from your account on the Heroic KB website.
After adding the license key, switch to the ‘Home & General‘ tab from the left column. Select the documentation home page from the dropdown menu next to the ‘KB Home Page’ option.
When you opt for the ‘Knowledge Base Archive‘ option, Heroic KB will generate a new page to add Documentation at www.example.com/knowledge-base, a significant outcome.
If you want to add Documentation to a page you have already created, you can select it from the dropdown menu.
Next, you can type the header text displayed at the top of your documentation page.
Once you finish that, check the ‘Breadcrumbs’ option to enable it.
Breadcrumbs are a navigation asset that allows users to see how they got to the current page and navigate back to previous pages, such as Home,» Products,» and Installation.
Next, you can choose the number of category columns displayed on your documentation page from the dropdown menu.
Then, check the ‘Display KB Category Counts‘ option to see the number of articles written for each category.
Next, choose the number of articles displayed under each category on the documentation home page from the ‘KB Category Article’ dropdown menu.
Then, you can check the ‘Hide Empty Categories’ and the ‘Hide Uncategorized Articles’ boxes. This way, neither the currently empty categories nor the uncategorized articles will be displayed on your documentation home page.
Afterward, you can restrict your WordPress documentation access to logged-in users only from the ‘Restrict Access‘ dropdown menu.
After completing that, click the ‘Save Changes‘ button to store your settings.
Step 2: Construct Categories, Tags, and Article Settings
Now change to the ‘Categories & Tags’ tab from the column on the. You can select how to label your categories and tags and also the number of articles that will be shown for every taxonomy.
Check the ‘Article Excerpt’ box if you want to display an article snippet under each taxonomy archive in your documentation.
Now click the ‘Save Changes’ button and switch to the ‘Article’ tab.
After this, you can check different boxes to start a comments section under your documentation articles, display author bios, or show other related articles under each tutorial.
After making your choice, just click the ‘Save Changes’ button to store your settings.
Step 3: Set Up Knowledgebase Search and Slug Settings
Now, switch to the ‘Search’ tab and check the ‘Search Focus’ box if you want the user’s mouse to automatically land on the documentation search box when the page loads.
Next, you can add placeholder text for the search box, display article excerpts in the search results, and even enable the plugin to highlight the search term in the results.
Once you have done that, click ‘Save Changes’ and switch to the ‘Slugs’ tab.
Now change to the ‘Categories & Tags’ tab from the column on the. You can select how to label your categories and tags and also the number of articles that will be shown for every taxonomy.
Check the ‘Article Excerpt’ box if you want to display an article snippet under each taxonomy archive in your documentation.
Now click the ‘Save Changes’ button and switch to the ‘Article’ tab.
You can add slugs for your documentation’s articles, categories, and tags. After making your choice, click the ‘Save Changes’ button to store your settings.
Step 4: Configure Knowledgebase Sidebar and Style Settings
Now, switch to the ‘Sidebars’ tab to choose a layout for the sidebars on your documentation pages. You can select different positions for the home, category, and articles sidebar.
You can even check the ‘Sticky Article Sidebar?’ option to enable a sticky page sidebar. Once you have done that, click ‘Save Changes’ and switch to the ‘Styles’ tab.
You can choose your documentation width, link color, header styling, and text color according to your preference. Then, click the ‘Save Changes’ button.
Step 5: Set Up Article Feedback and Email Settings
Checking those boxes will add an upvote/downvote system to your WordPress documentation. This will let users tell you if your documentation helps solve their problems on the front end.
Select the ‘Save Changes’ button to reserve the settings.
Now, switch to the ‘Email Reports’ tab from the left column and check the ‘Enable Email Reports?’ option if you want Heroic KB to send you weekly reports on your documentation.
This report will include the total views and average rating of your documentation articles and display a list of the top and most highly rated articles for that week.
Once you have done that, add your admin email address to the ‘Report Recipients’ field. You can even add multiple email addresses if you like.
To keep your settings, click on the ‘Save Changes’ button.
After you have organized all the settings for the Heroic KB plugin, you can add documentation for your website.
Step 6: Create and Add Documentation to Your WordPress Site
To add documentation, visit the Heroic KB » Add New Article page from the dashboard of WordPress.
This will open the WordPress content editor, where you can add a heading for your documentation article and start writing the content. You can also click the add block ‘+‘ button in the top left corner to add different blocks to your content.
Once you have written the article for the documentation, you need to expand the ‘Categories’ tab in the block panel and click the ‘Add New Article Category’ link.
Next, simply create a category for the article that you are writing.
After that, expand the ‘Tags’ section in the block panel and add as many tags as you like for your documentation article. You can even add an excerpt for the article by expanding the ‘Excerpt’ tab.
Next, go to the ‘Discussion‘ tab and uncheck the ‘Allow comments’ option to disable comments for this article.
If you want to let users add comments, you can leave this setting as it is.
You can also add attachments to your articles in the documentation.
To do this, scroll down to the ‘Article Options’ section in the block editor and click the ‘Add or Upload Files‘ button. This will launch the media library, where you can add any attachment you like.
Next, check the ‘Attachments in New Window’ box if you want the attachments in the article to open in a new window upon being clicked.
You can also disable the upvote/downvote feature for specific articles by scrolling down to the ‘Voting Options‘ section. Here, check the ‘Disable Voting’ option to deactivate the upvote/downvote system for this specific article.
Finally, click the ‘Publish’ button to publish your article as documentation.
Repeat the process to add more than one entry for your documentation under different categories.
Once you are done with that, you can easily view the documentation by visiting the www.example.com/knowledge-base page or the custom page that you chose for your documentation.
Step 7: Change the Article and Category Order of Your Documentation
With Heroic KB, you can change the order of the articles displayed in your WordPress knowledge base. To do this, visit the WordPress dashboard’s Heroic KB Article Ordering page.
Here, choose the category in which you want to change the article order. Then, drag and drop the articles to rearrange them according to your preference.
Once you are done, remember to click the ‘Save Order‘ button to save your settings.
To change the order of the categories displayed on your documentation page, visit the Heroic KB » Category Ordering page from the WordPress admin sidebar.
Once you are there, you can rearrange the categories’ order by dragging and dropping them. After making the changes, click the ‘Save Order‘ button to store your settings.
Now, you are done adding documentation to your website.
Conclusion
If you add documentation to your website, it will enhance UI by providing clear guidance on using your products or services. It boosts SEO, reduces support queries, and empowers users to navigate your offerings effortlessly. With tools like Heroic KB, If you add documentation in WordPress it will become straightforward, offering features like categorization, search capabilities, and user feedback options. Start enhancing your site today and add documentation to serve your audience better.
Leave a Reply