Are you in search of a approach so as to add documentation in WordPress?
Including documentation to your web site makes it simpler for customers to know methods to use your services or products. This can assist improve consumer engagement, enhance search engine marketing, and cut back assist tickets in your web site.
On this article, we’ll present you methods to simply add documentation in WordPress, step-by-step.
Why Add Documentation in WordPress?
Documentation is content material in your WordPress web site that gives data on methods to use your merchandise/providers, together with their options, new releases, add-ons, and extra.
WordPress documentation can embody how-to tutorials, guides, FAQs, data bases, and API documentation.
For instance, you probably have an internet retailer that sells music, then you’ll be able to create documentation detailing methods to obtain the music, renew licenses, or create a playlist.
By including documentation in WordPress, you’ll be able to enhance the consumer expertise by making it simpler for patrons to find totally different product options or discover the causes of their points and debug them themselves. This will even cut back the variety of assist tickets to your website.
Documentation also can enhance your search engine marketing rankings by offering further content material that Google and different search engines like google can index and show within the search outcomes.
Having stated that, let’s see methods to simply add documentation in WordPress, step-by-step.
The best way to Add Documentation in WordPress
You possibly can simply add documentation in WordPress utilizing the Heroic KB plugin.
It’s the greatest WordPress data base plugin in the marketplace that provides a searchable data base to your present website. It comes with an AJAX search function, drag & drop content material ordering, article attachments, and extra.
Plus, the device additionally has built-in analytics and a consumer suggestions function that allows you to accumulate insights to enhance your present documentation.
Step 1: Configure Heroic KB Normal Settings
First, you might want to set up and activate the Heroic KB plugin. For detailed directions, see our step-by-step information on methods to set up a WordPress plugin.
Upon activation, go to the Heroic KB » Settings web page from the WordPress admin sidebar and change to the ‘License and Updates’ tab.
Right here, enter your plugin’s license key and click on the ‘Save Modifications’ button. You will get this data out of your account on the Heroic KB web site.
After including the license key, change to the ‘Dwelling & Normal’ tab from the left column. It’s essential to choose the documentation residence web page from the dropdown menu subsequent to the ‘KB Dwelling Web page’ possibility.
When you choose the ‘Information Base Archive’ possibility, then Heroic KB will create a brand new web page to your documentation at www.instance.com/knowledge-base.
Nevertheless, if you wish to add your documentation on a web page that you’ve got already created, then you’ll be able to select that possibility from the dropdown menu.
Subsequent, it’s also possible to sort the header textual content that will likely be displayed on the high of your documentation web page.
Upon getting executed that, simply examine the ‘Breadcrumbs’ choice to allow it.
In a data base, breadcrumbs are a kind of navigation help that permits customers to see how they obtained to the present web page and navigate again to earlier pages like this: Dwelling » Merchandise » Set up.
Subsequent, it’s also possible to select the variety of class columns to be displayed in your documentation web page from the dropdown menu.
Then, examine the ‘Show KB Class Counts’ possibility if you wish to present the variety of articles which can be written for every class.
Subsequent, select the variety of articles that needs to be displayed below every class on the documentation residence web page from the ‘KB Class Article’ dropdown menu.
Then, you’ll be able to examine the ‘Conceal Empty Classes’ and the ‘Conceal Uncategorized Articles’ packing containers. This manner, neither the presently empty classes nor the uncategorized articles will likely be displayed in your documentation residence web page.
Subsequent, you’ll be able to limit your WordPress documentation entry to logged-in customers solely from the ‘Limit Entry’ dropdown menu.
As soon as you might be executed, simply click on the ‘Save Modifications’ button to retailer your settings.
Step 2: Configure Classes, Tags, and Article Settings
Now, change to the ‘Classes & Tags’ tab from the left column. Right here, you’ll be able to select methods to type your classes and tags and the variety of articles that will likely be displayed for every taxonomy.
You can even examine the ‘Article Excerpt’ field if you wish to show an article snippet below every taxonomy archive in your documentation.
Subsequent, merely click on the ‘Save Modifications’ button and change to the ‘Article’ tab.
From right here, you’ll be able to examine totally different packing containers to activate a feedback part below your documentation articles, show writer bios, or present different associated articles below every tutorial.
After making your alternative, simply click on the ‘Save Modifications’ button to retailer your settings.
Step 3: Set Up Knowledgebase Search and Slug Settings
Now, change to the ‘Search’ tab and examine the ‘Search Focus’ field if you would like the consumer’s mouse to robotically land on the documentation search field when the web page masses.
Subsequent, it’s also possible to add placeholder textual content for the search field, show article excerpts within the search outcomes, and even allow the plugin to focus on the search time period within the outcomes.
Upon getting executed that, click on ‘Save Modifications’ and change to the ‘Slugs’ tab.
Right here, you’ll be able to add slugs to your documentation’s articles, classes, and tags.
Upon making your alternative, go forward and click on the ‘Save Modifications’ button to retailer your settings.
Step 4: Configure Knowledgebase Sidebar and Type Settings
Subsequent, change to the ‘Sidebars’ tab to pick out a structure for the sidebars in your documentation pages.
You possibly can choose totally different positions for the house sidebar, class sidebar, and articles sidebar. You possibly can even examine the ‘Sticky Article Sidebar?’ choice to activate a sticky sidebar for pages.
Upon getting executed that, click on ‘Save Modifications’ and change to the ‘Types’ tab.
From right here, you’ll be able to choose your documentation width, hyperlink shade, header styling, and textual content shade in response to your liking.
Then, merely click on the ‘Save Modifications’ button.
Step 5: Set Up Article Suggestions and Electronic mail Settings
Subsequent, you must change to the ‘Article Suggestions’ tab and examine the ‘Allow Suggestions’ possibility to permit customers to fee your articles.
You possibly can even add an upvote/downvote system to your WordPress documentation by checking these packing containers. This enables customers to let you know in case your documentation is useful for fixing their issues.
Now, click on the ‘Save Modifications’ button to retailer your settings.
Now, change to the ‘Electronic mail Stories’ tab from the left column and examine the ‘Allow Electronic mail Stories?’ possibility if you would like Heroic KB to ship you weekly reviews in your documentation.
This report will embody the full views and common score of your documentation articles and can even show an inventory of the highest and most extremely rated articles for that week.
Upon getting executed that, add your admin electronic mail deal with to the ‘Report Recipients’ discipline. You possibly can even add a number of electronic mail addresses in the event you like.
After that, click on the ‘Save Modifications’ button to retailer your settings.
Now that you’ve got configured all of the settings for the Heroic KB plugin, it’s time to begin creating documentation to your web site.
Step 6: Create Documentation for Your WordPress Website
You possibly can create how-to articles, data base, guides, and FAQs to your documentation.
To start out creating an article to your documentation, go to the Heroic KB » Add New Article web page from the WordPress dashboard.
This can open the WordPress content material editor, the place you’ll be able to add a heading to your documentation article and begin writing the content material. You can even click on the add block ‘+’ button within the high left nook so as to add totally different blocks to your content material.
Upon getting written the article for the documentation, you might want to develop the ‘Classes’ tab within the block panel and click on the ‘Add New Article Class’ hyperlink.
Subsequent, merely create a class for the article that you’re writing.
After that, develop the ‘Tags’ part within the block panel and add as many tags as you want to your documentation article.
You possibly can even add an excerpt for the article by increasing the ‘Excerpt’ tab.
Subsequent, develop the ‘Dialogue’ tab and uncheck the ‘Enable feedback’ possibility if you wish to disable feedback for this text. If you wish to let customers add feedback, then you’ll be able to go away this setting as it’s.
You can even add attachments to your articles within the documentation. To do that, scroll right down to the ‘Article Choices’ part within the block editor and click on the ‘Add or Add Recordsdata’ button.
This can launch the media library from the place you’ll be able to add any attachment you want.
Subsequent, examine the ‘Attachments in New Window’ field if you would like the attachments within the article to open in a brand new window upon being clicked.
You can even disable the upvote/downvote function for particular articles in the event you like by scrolling right down to the ‘Voting Choices’ part.
Right here, examine the ‘Disable Voting’ choice to deactivate the upvote/downvote system for this particular article.
Lastly, click on the ‘Publish’ button on the high to publish your article as documentation.
Now, repeat the method once more so as to add a number of entries to your documentation below totally different classes.
Upon getting executed that, you’ll be able to simply view the documentation by visiting the www.instance.com/knowledge-base web page, or you’ll be able to go to the customized web page that you just selected to your documentation.
Step 7: Change the Article and Class Order of Your Documentation
With Heroic KB, it’s also possible to change the order of the articles that will likely be displayed in your WordPress data base. To do that, you might want to go to the Heroic KB » Article Ordering web page from the WordPress dashboard.
Right here, select the class for which you need to change the article order. After that, merely drag and drop the articles to rearrange them in response to your liking.
As soon as you might be executed, don’t overlook to click on the ‘Save Order’ button to retailer your settings.
To alter the order of the classes displayed in your documentation web page, go to the Heroic KB » Class Ordering web page from the WordPress admin sidebar.
As soon as you might be there, you’ll be able to rearrange the order of the classes by dragging and dropping them. Upon making the modifications, click on the ‘Save Order’ button to retailer your settings.
You’ve got now efficiently created documentation to your web site and adjusted its class and article order.
Bonus: Add an FAQ Part to Your WordPress Website
Including WordPress documentation is an effective way to assist your customers discover the data they want. You can even add FAQs (steadily requested questions) alongside together with your weblog posts to reply generally requested questions associated to your content material.
This will improve consumer engagement in your WordPress weblog and construct belief and credibility together with your customers by letting them know that you just perceive their questions and worries.
Plus, FAQs also can enhance your search engine marketing rankings by permitting you to make use of lengthy tail key phrases that customers generally seek for utilizing search engines like google.
You possibly can simply add FAQs to your web site utilizing All in One search engine marketing (AIOSEO). It’s the greatest WordPress search engine marketing plugin in the marketplace that permits you to simply optimize your web site to enhance search engine rankings.
AIOSEO even comes with an FAQ block that may be instantly added to the block editor, the place you’ll be able to enter questions and solutions to your FAQ part.
The plugin additionally permits you to customise your FAQ part from the block panel, together with its textual content shade, background shade, typography, and title wrapper, making AIOSEO the very best WordPress FAQ plugin in the marketplace.
Plus, the plugin comes with FAQ schema markup that may increase your web site rankings and natural click-through fee by making your steadily requested questions seem instantly in Google’s search outcomes.
For extra detailed directions, see our tutorial on methods to add a Incessantly Requested Questions part in WordPress.
We hope this text helped you discover ways to add documentation in WordPress. You may additionally need to see our newbie’s information on methods to create a questions and solutions website in WordPress and our high picks for the very best accordion plugins for WordPress.
When you preferred this text, then please subscribe to our YouTube Channel for WordPress video tutorials. You can even discover us on Twitter and Fb.
