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 person engagement, enhance search engine optimization, 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 data on methods to use your merchandise/companies, together with their options, new releases, add-ons, and extra.

WordPress documentation can embody how-to tutorials, guides, FAQs, information bases, and API documentation.

For instance, in case you have a web based 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 person expertise by making it simpler for patrons to find completely different product options or discover the causes of their points and debug them themselves. This may even scale back the variety of assist tickets in your web site.

Documentation can even enhance your search engine 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 mentioned that, let’s see methods to simply add documentation in WordPress, step-by-step.

The best way to Add Documentation in WordPress

You’ll be able to simply add documentation in WordPress utilizing the Heroic KB plugin.

It’s the greatest WordPress information base plugin in the marketplace that provides a searchable information base to your current web site. 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 acquire insights to enhance your current documentation.

Step 1: Configure Heroic KB Basic Settings

First, it’s worthwhile 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 swap to the ‘License and Updates’ tab.

Right here, enter your plugin’s license key and click on the ‘Save Adjustments’ button. You may get this data out of your account on the Heroic KB web site.

After including the license key, swap to the ‘House & Basic’ tab from the left column. You will need to choose the documentation dwelling web page from the dropdown menu subsequent to the ‘KB House Web page’ possibility.

For those who choose the ‘Information Base Archive’ possibility, then Heroic KB will create a brand new web page in your documentation at http://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 can even kind the header textual content that might be displayed on the prime of your documentation web page.

Upon getting performed that, simply verify the ‘Breadcrumbs’ choice to allow it.

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

Subsequent, you can even select the variety of class columns to be displayed in your documentation web page from the dropdown menu.

Then, verify 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 must be displayed beneath every class on the documentation dwelling web page from the ‘KB Class Article’ dropdown menu.

Then, you may verify the ‘Disguise Empty Classes’ and the ‘Disguise Uncategorized Articles’ containers. This manner, neither the at the moment empty classes nor the uncategorized articles might be displayed in your documentation dwelling web page.

Subsequent, you may prohibit your WordPress documentation entry to logged-in customers solely from the ‘Limit Entry’ dropdown menu.

As soon as you might be performed, simply click on the ‘Save Adjustments’ 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 methods to type your classes and tags and the variety of articles that might be displayed for every taxonomy.

You can even verify the ‘Article Excerpt’ field if you wish to show an article snippet beneath every taxonomy archive in your documentation.

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

From right here, you may verify completely different containers to activate a feedback part beneath your documentation articles, show writer bios, or present different associated articles beneath every tutorial.

After making your alternative, simply click on the ‘Save Adjustments’ button to retailer your settings.

Step 3: Set Up Knowledgebase Search and Slug Settings

Now, swap to the ‘Search’ tab and verify the ‘Search Focus’ field if you would like the person’s mouse to routinely land on the documentation search field when the web page hundreds.

Subsequent, you can even 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 performed that, click on ‘Save Adjustments’ 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 Adjustments’ button to retailer your settings.

Step 4: Configure Knowledgebase Sidebar and Fashion Settings

Subsequent, swap to the ‘Sidebars’ tab to pick out a format for the sidebars in your documentation pages.

You’ll be able to choose completely different positions for the house sidebar, class sidebar, and articles sidebar. You’ll be able to even verify the ‘Sticky Article Sidebar?’ choice to activate a sticky sidebar for pages.

Upon getting performed that, click on ‘Save Adjustments’ and swap to the ‘Types’ tab.

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

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

Step 5: Set Up Article Suggestions and E mail Settings

Subsequent, it’s important to swap to the ‘Article Suggestions’ tab and verify the ‘Allow Suggestions’ possibility to permit customers to price your articles.

You’ll be able to even add an upvote/downvote system in your WordPress documentation by checking these containers. This enables customers to let you know in case your documentation is useful for fixing their issues.

Now, click on the ‘Save Adjustments’ button to retailer your settings.

Now, swap to the ‘E mail Stories’ tab from the left column and verify the ‘Allow E mail Stories?’ possibility if you would like Heroic KB to ship you weekly reviews in your documentation.

This report will embody the whole 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.

Upon getting performed that, add your admin e-mail tackle to the ‘Report Recipients’ discipline. You’ll be able to even add a number of e-mail addresses if you happen to like.

After that, click on the ‘Save Adjustments’ 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’ll be able to create how-to articles, information 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 can even click on the add block ‘+’ button within the prime left nook so as to add completely different blocks to your content material.

Upon getting written the article for the documentation, it’s worthwhile 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’ll be able to 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 can even add attachments to your articles within the documentation. To do that, scroll all the way 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 may add any attachment you want.

Subsequent, verify 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 characteristic for particular articles if you happen to like by scrolling all the way down to the ‘Voting Choices’ part.

Right here, verify 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 beneath completely different classes.

Upon getting performed that, you may simply view the documentation by visiting the http://www.instance.com/knowledge-base web page, or you may go to the customized web page that you simply selected in your documentation.

Step 7: Change the Article and Class Order of Your Documentation

With Heroic KB, you can even change the order of the articles that might be displayed in your WordPress information base. To do that, it’s worthwhile 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 accordance with your liking.

As soon as you might be performed, 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 might be 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 might have now efficiently created documentation in your web site and adjusted 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 can even add FAQs (ceaselessly 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 simply perceive their questions and worries.

Plus, FAQs can even enhance your search engine 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’ll be able to simply add FAQs to your web site utilizing All in One SEO (AIOSEO). It’s the greatest WordPress search engine optimization plugin in the marketplace that means that you can 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 means that you can customise your FAQ part from the block panel, together with its textual content colour, background colour, typography, and title wrapper, making AIOSEO one of the best 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 ceaselessly requested questions seem immediately in Google’s search outcomes.

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

We hope this text helped you learn to add documentation in WordPress. You might also need to see our newbie’s information on methods to create a questions and solutions web site in WordPress and our prime picks for one of the best accordion plugins for WordPress.

For those who appreciated this text, then please subscribe to our YouTube Channel for WordPress video tutorials. You can even discover us on Twitter and Facebook.