Learn how to Add Documentation in WordPress (Step by Step)

Are you on the lookout for a means so as to add documentation in WordPress?

Including documentation to your web site makes it simpler for customers to grasp the right way to use your services or products. This may also help enhance person engagement, enhance web optimization, and cut back help tickets in your web site.

On this article, we’ll present you the right way 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 the right way 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, if in case you have an on-line retailer that sells music, then you may create documentation detailing the right way to obtain the music, renew licenses, or create a playlist.

By including documentation in WordPress, you may enhance the person 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 may even cut back the variety of help tickets in your website.

Documentation may enhance your web optimization rankings by offering extra content material that Google and different search engines like google and yahoo can index and show within the search outcomes.

Having stated that, let’s see the right way to simply add documentation in WordPress, step-by-step.

Learn how 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 characteristic, drag & drop content material ordering, article attachments, and extra.

Plus, the instrument additionally has built-in analytics and a person suggestions characteristic that permits you to gather insights to enhance your present documentation.

Step 1: Configure Heroic KB Common Settings

First, it is advisable to set up and activate the Heroic KB plugin. For detailed directions, see our step-by-step information on the right way to set up a WordPress plugin.

Upon activation, go to the Heroic KB » Settings web page from the WordPress admin sidebar and swap 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 info out of your account on the Heroic KB web site.

After including the license key, swap to the ‘Residence & Common’ tab from the left column. You could choose the documentation residence web page from the dropdown menu subsequent to the ‘KB Residence Web page’ possibility.

If you happen to choose the ‘Information Base Archive’ possibility, then Heroic KB will create a brand new web page in your documentation at www.instance.com/knowledge-base.

Nonetheless, if you wish to add your documentation on a web page that you’ve already created, then you may select that possibility from the dropdown menu.

Subsequent, you too can kind the header textual content that will likely be displayed on the prime of your documentation web page.

After getting carried out that, simply examine the ‘Breadcrumbs’ choice to allow it.

In a data base, breadcrumbs are a kind of navigation support that permits customers to see how they acquired to the present web page and navigate again to earlier pages like this: Residence » Merchandise » Set up.

Subsequent, you too can 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 might be written for every class.

Subsequent, select the variety of articles that ought to be displayed underneath every class on the documentation residence web page from the ‘KB Class Article’ dropdown menu.

Then, you may examine the ‘Disguise Empty Classes’ and the ‘Disguise 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 may limit your WordPress documentation entry to logged-in customers solely from the ‘Limit Entry’ dropdown menu.

As soon as you’re carried out, simply click on the ‘Save Modifications’ button to retailer your settings.

Step 2: Configure Classes, Tags, and Article Settings

Now, swap to the ‘Classes & Tags’ tab from the left column. Right here, you may select the right way to kind your classes and tags and the variety of articles that will likely be displayed for every taxonomy.

You may as well examine the ‘Article Excerpt’ field if you wish to show an article snippet underneath every taxonomy archive in your documentation.

Subsequent, merely click on the ‘Save Modifications’ button and swap to the ‘Article’ tab.

From right here, you may examine completely different packing containers to activate a feedback part underneath your documentation articles, show creator bios, or present different associated articles underneath 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, swap to the ‘Search’ tab and examine the ‘Search Focus’ field if you would like the person’s mouse to robotically land on the documentation search field when the web page masses.

Subsequent, you too can add placeholder textual content for the search field, show article excerpts within the search outcomes, and even allow the plugin to spotlight the search time period within the outcomes.

After getting carried out that, click on ‘Save Modifications’ and swap 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, swap to the ‘Sidebars’ tab to pick a format for the sidebars in your documentation pages.

You possibly can choose completely 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.

After getting carried out that, click on ‘Save Modifications’ and swap to the ‘Types’ tab.

From right here, you may choose your documentation width, hyperlink coloration, header styling, and textual content coloration in accordance with your liking.

Then, merely click on the ‘Save Modifications’ button.

Step 5: Set Up Article Suggestions and Electronic mail Settings

Subsequent, it’s important to swap to the ‘Article Suggestions’ tab and examine 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 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, swap 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 stories in your documentation.

This report will embody the overall views and common score of your documentation articles and can even show a listing of the highest and most extremely rated articles for that week.

After getting carried out that, add your admin e-mail handle to the ‘Report Recipients’ area. You possibly can even add a number of e-mail addresses in the event you like.

After that, click on the ‘Save Modifications’ button to retailer your settings.

Now that you’ve 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 Web site

You possibly can create how-to articles, data base, guides, and FAQs in your documentation.

To begin 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 to broaden 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, broaden 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, broaden 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 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, 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 may as well disable the upvote/downvote characteristic 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 prime to publish your article as documentation.

Now, repeat the method once more so as to add a number of entries in your documentation underneath completely different classes.

After getting carried out 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, you too can change the order of the articles that will likely be displayed in your WordPress data base. To do that, it is advisable to 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 in accordance with your liking.

As soon as you’re carried out, don’t neglect to click on the ‘Save Order’ button to retailer your settings.

To vary 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’ve got now efficiently created documentation in your web site and altered its class and article order.

Bonus: Add an FAQ Part to Your WordPress Web site

Including WordPress documentation is an effective way to assist your customers discover the data they want. You may as well add FAQs (incessantly requested questions) alongside along with your weblog posts to reply generally requested questions associated to your content material.

This may enhance person 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 enhance your web optimization rankings by permitting you to make use of lengthy tail key phrases that customers generally seek for utilizing search engines like google and yahoo.

You possibly can simply add FAQs to your web site utilizing All in One web optimization (AIOSEO). It’s the greatest WordPress web optimization 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 straight 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 coloration, background coloration, typography, and title wrapper, making AIOSEO the greatest WordPress FAQ plugin in the marketplace.

Plus, the plugin comes with FAQ schema markup that may enhance your web site rankings and natural click-through price by making your incessantly requested questions seem straight in Google’s search outcomes.

For extra detailed directions, see our tutorial on the right way to add a Ceaselessly Requested Questions part in WordPress.

We hope this text helped you discover ways to add documentation in WordPress. You may additionally wish to see our newbie’s information on the right way to create a questions and solutions website in WordPress and our prime picks for the greatest accordion plugins for WordPress.

If you happen to appreciated this text, then please subscribe to our YouTube Channel for WordPress video tutorials. You may as well discover us on Twitter and Fb.

The put up Learn how to Add Documentation in WordPress (Step by Step) first appeared on WPBeginner.