Are you searching for 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 may help enhance consumer engagement, enhance search engine marketing, and scale 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 info on methods to use your merchandise/companies, together with their options, new releases, add-ons, and extra.
WordPress documentation can embrace how-to tutorials, guides, FAQs, data bases, and API documentation.
For instance, when you’ve got an internet retailer that sells music, then you may create documentation detailing methods to obtain the music, renew licenses, or create a playlist.
By including documentation in WordPress, you may enhance the consumer expertise by making it simpler for purchasers to find completely different product options or discover the causes of their points and debug them themselves. This could even scale back the variety of assist tickets in your website.
Documentation may also enhance your search engine marketing rankings by offering further content material that Google and different serps can index and show within the search outcomes.
Having mentioned that, let’s see methods to simply add documentation in WordPress, step-by-step.
Methods 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 available on the market 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 software additionally has built-in analytics and a consumer suggestions function that permits you to accumulate insights to enhance your present documentation.
Step 1: Configure Heroic KB Common Settings
First, it is advisable 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 may get this info out of your account on the Heroic KB web site.
After including the license key, change to the ‘House & Common’ tab from the left column. It’s essential to choose the documentation residence web page from the dropdown menu subsequent to the ‘KB House Web page’ choice.
In case you decide the ‘Data Base Archive’ choice, then Heroic KB will create a brand new web page in 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 may select that choice from the dropdown menu.
Subsequent, it’s also possible to kind the header textual content that will likely be displayed on the prime of your documentation web page.
After getting achieved that, simply test the ‘Breadcrumbs’ choice to allow it.
In a data base, breadcrumbs are a sort of navigation help that permits customers to see how they obtained to the present web page and navigate again to earlier pages like this: House » 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, test the ‘Show KB Class Counts’ choice if you wish to present the variety of articles which might be written for every class.
Subsequent, select the variety of articles that ought to be displayed below every class on the documentation residence web page from the ‘KB Class Article’ dropdown menu.
Then, you may test the ‘Conceal Empty Classes’ and the ‘Conceal Uncategorized Articles’ packing containers. This fashion, neither the at the moment empty classes nor the uncategorized articles will likely be displayed in your documentation residence web page.
Subsequent, you may limit your WordPress documentation entry to logged-in customers solely from the ‘Limit Entry’ dropdown menu.
As soon as you’re achieved, 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 may select methods to type your classes and tags and the variety of articles that will likely be displayed for every taxonomy.
You may as well test 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 may test completely different packing containers to activate a feedback part below your documentation articles, show creator 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 test the ‘Search Focus’ field in order for you the consumer’s mouse to mechanically land on the documentation search field when the web page hundreds.
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.
After getting achieved that, click on ‘Save Modifications’ and change to the ‘Slugs’ tab.
Right here, you may add slugs in 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 Fashion Settings
Subsequent, change to the ‘Sidebars’ tab to pick a format for the sidebars in your documentation pages.
You possibly can decide completely different positions for the house sidebar, class sidebar, and articles sidebar. You possibly can even test the ‘Sticky Article Sidebar?’ choice to activate a sticky sidebar for pages.
After getting achieved that, click on ‘Save Modifications’ and change to the ‘Types’ tab.
From right here, you may choose your documentation width, hyperlink colour, header styling, and textual content colour based on your liking.
Then, merely click on the ‘Save Modifications’ button.
Step 5: Set Up Article Suggestions and E-mail Settings
Subsequent, it’s important to change to the ‘Article Suggestions’ tab and test the ‘Allow Suggestions’ choice to permit customers to price your articles.
You possibly can even add an upvote/downvote system in your WordPress documentation by checking these packing containers. This permits 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 ‘E-mail Reviews’ tab from the left column and test the ‘Allow E-mail Reviews?’ choice in order for you Heroic KB to ship you weekly reviews in your documentation.
This report will embrace the entire views and common ranking of your documentation articles and can even show a listing of the highest and most extremely rated articles for that week.
After getting achieved that, add your admin e mail handle to the ‘Report Recipients’ discipline. You possibly can even add a number of e mail addresses when 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 start out creating documentation in your web site.
Step 6: Create Documentation for Your WordPress Website
You possibly can create how-to articles, data base, guides, and FAQs in your documentation.
To start out creating an article in 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 may add a heading in your documentation article and begin writing the content material. You may as well click on the add block ‘+’ button within the prime left nook so as to add completely different blocks to your content material.
After getting written the article for the documentation, it is advisable 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 in 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’ choice if you wish to disable feedback for this text. If you wish to let customers add feedback, then you may go away this setting as it’s.
You may as well 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 Information’ button.
This can launch the media library from the place you may add any attachment you want.
Subsequent, test the ‘Attachments in New Window’ field in order for you the attachments within the article to open in a brand new window upon being clicked.
You may as well disable the upvote/downvote function for particular articles when you like by scrolling right down to the ‘Voting Choices’ part.
Right here, test the ‘Disable Voting’ choice to deactivate the upvote/downvote system for this particular article.
Lastly, click on the ‘Publish’ button on the prime to publish your article as documentation.
Now, repeat the method once more so as to add a number of entries in your documentation below completely different classes.
After getting achieved that, you may simply view the documentation by visiting the www.instance.com/knowledge-base web page, or you may go to the customized web page that you just selected in 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, it is advisable go to the Heroic KB » Article Ordering web page from the WordPress dashboard.
Right here, select the class for which you wish to change the article order. After that, merely drag and drop the articles to rearrange them based on your liking.
As soon as you’re achieved, don’t neglect 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’re there, you may rearrange the order of the classes by dragging and dropping them. Upon making the adjustments, click on the ‘Save Order’ button to retailer your settings.
You could have now efficiently created documentation in your web site and altered its class and article order.
Bonus: Add an FAQ Part to Your WordPress Website
Including WordPress documentation is a good way to assist your customers discover the knowledge they want. You may as well add FAQs (steadily requested questions) alongside along with your weblog posts to reply generally requested questions associated to your content material.
This could enhance consumer engagement in your WordPress weblog and construct belief and credibility along with your customers by letting them know that you just perceive their questions and worries.
Plus, FAQs may also enhance your search engine marketing rankings by permitting you to make use of lengthy tail key phrases that customers generally seek for utilizing serps.
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 available on the market that permits you to simply optimize your web site to enhance search engine rankings.
AIOSEO even comes with an FAQ block that may be immediately added to the block editor, the place you may enter questions and solutions in your FAQ part.
The plugin additionally permits you to customise your FAQ part from the block panel, together with its textual content colour, background colour, typography, and title wrapper, making AIOSEO the very best WordPress FAQ plugin available on the market.
Plus, the plugin comes with FAQ schema markup that may increase your web site rankings and natural click-through price by making your steadily requested questions seem immediately in Google’s search outcomes.
For extra detailed directions, see our tutorial on methods to add a Regularly Requested Questions part in WordPress.
We hope this text helped you learn to add documentation in WordPress. You might also wish to see our newbie’s information on methods to create a questions and solutions website in WordPress and our prime picks for the very best accordion plugins for WordPress.
In case you appreciated this text, then please subscribe to our YouTube Channel for WordPress video tutorials. You may as well discover us on Twitter and Fb.