How to create a beautiful product documentation with WordPress

It’s a wonderful feeling to have a product on your own, when people love it, and when you are making money from your product. It would be equally frustrating when you have put in all your effort to create an excellent product and are not able to convert customers or make money.

Building an excellent product is just one factor in determining the success of your business. One of the primary reason your product could not scale well might be a lack of clear documentation of your product. When a customer finds it hard to understand your product and how to use it, you have already missed that customer.

It’s highly essential that you provide simple and beautiful documentation so that the customer will have a clear understanding of your product and also a pleasant experience inside your store.

Giving that customer experience is highly essential in converting leads to customers. Many products have grown highly profitable by just having a detailed and precise documentation which assisted the users in every step of their process.

One other crucial factor in determining the success of your business is the satisfaction of your existing customers. Your current customers are the real asset in bringing in new customers. Customer support is one important thing which makes them either happy or frustrated over your product.

If they are satisfied with your support, they will never leave you without bringing in new customers to your product. But If they are not, they will not think to take it to even social media with their complaints which will eventually affect your brand’s reputation.

I understand answering every of your customer’s call, and email will eventually take a lot of your precious time. I know you may want time to build your product also. That’s where creating a product documentation becomes highly needed. Building a product documentation will mainly reduce your support tickets so that you will have enough time to focus on your other tasks too.

What does a proper product documentation should have?

Below are the five essential things that any proper product documentation should have:

  1. Neatly organized information about the products and assigning according to its particular category.
  2. An attractive design of your documentation so that your users will have a pleasant experience.
  3. Simple navigation like Table of contents to go to any product from any page to find it’s information
  4. A powerful search for users to search for the right articles about a product
  5. Voting and feedback feature so that users can share their opinion

How to create a beautiful product documentation?

As I said earlier, well-organized articles about your product or services will help your customers a great deal and will profoundly reduce the support and pre-sale questions they have.

So now, let’s go ahead and see how to create it in your WordPress website. Note, this article is specifically focused on WordPress users and how they can create a proper product documentation on their WordPress websites.

If you are new to WordPress, read our article on  creating a WordPress website . If you follow the steps in this article you can create your documentation website in just few minuted with WordPress.

To get started, we are going to download and install two important plugins in WordPress, one which will cost you a very few bucks and other for free. The first one is Helpie Knowledge Base Plugin which makes the documentation very simple. This plugin has all the necessary features to build a beautiful product documentation. The other is the Elementor page builder which is the most potent page builder with more than 1,000,000 active installs. It lets you design your entire website using a simple drag and drop interface and is completely free.

The best thing is the Helpie plugin has integrated with the Elementor page builder which makes your product documentation amazingly powerful and incredibly beautiful, and that’s the reason we have selected these two plugins to create your product documentation.

How to Install Helpie and Elementor?

First, to install Helpie, go to their website helpiewp.com. You can buy the plugin in the pricing page of their website. Once downloaded, upload it via Dashboard -> Plugins -> Add New. Make sure to activate the plugin after uploading. Once you have activated it, you will find a new menu item called Helpie Kb Wiki in your dashboard.

To install Elementor, you can download it from your dashboard itself. Go to Dashboard -> Plugins -> Add new. Type “Elementor” in the search box and you will find it. Just install and activate it. Once activated, a new menu item called “Elementor” will appear in the dashboard.

So now, let’s go on to see how to create that six essential steps I mentioned above, that a proper product documentation should have using Helpie and Elementor.

Step 1: Neatly organize all the information about your products and assign it according to its Categories:

Let’s say you have different products in different categories and you want to organize it all. Remember, you cannot have the information about your various products in different places as that will make your customer’s frustrated to find the right information. So its highly essential that you document all the information of all the products in a single page. That’s where Helpie Plugin does a beautiful job. It lets you create articles to provide all the information about the product and assign it to its particular category.

Let’s see how it works. First, create an article via Helpie KB Wiki -> Add new article. Select it to enter your first article. Add the title in the Title space and fill the information about the product in the content space.

Now, to assign this article to a particular product category, you need to add that product category first. To do that, select the Add New Wiki Category which you can see in the right corner. You can add a new product/category there, and once that product is selected, this article which you created above will be assigned to that product.

Now, what if you have different products for a single category and you want to write articles on all those products. Helpie has a done a perfect job for this by allowing you add sub-category. You can add subtopics by creating a category and assigning it a parent category. By assigning, this will be now a subcategory of that parent category/topic.

For example, let’s say that you have different products under the category “Health and Fitness” like beauty, dental health, fitness and you want to create articles for all these. First, create a category called Health and Fitness as assigned above.

Next, create a category called “Dental health” and set the parent category as “Health and fitness.” In that way, dental and health will now be a subcategory under the Health and fitness category. You can create any number of subcategories and assign articles to it using Helpie.

Now, it is not just enough that you have created the articles and assigned it to its category. As said earlier, it’s highly essential that you give your customers a pleasant experience. The design of your documentation plays a vital role in providing that pleasant experience to your customers. That’s our next step.

Step 2: An attractive design of your documentation so that your users will have a pleasant experience.

This is where Helpie’s integration with the best page builder Elementor comes into play. You can neatly organize in a way that you want and customize the styles as you wish using Elementor.

Let’s see how it works. First, create a page from the dashboard and select Edit using Elementor option. Once selected, the elementor builder will now appear on your page, and you can see a small + symbol appearing on your page. Click that, and a new section will be added.

Now type Helpie in the search box which is on the left end as shown in the screenshot below and you will see different elements of Helpie. First, drag and drop the “Helpie hero section” to the right in that newly added section. In that, you can assign a title and sub-title for your documentation page. You can also customize the style of the background, add images and much more in the “style section.” Why don’t you take a few minutes time to play around it.

Next is the Helpie categories listing where you can organize different categories in a way that you wish. They have three types of list styles. One is the Boxed template, the other is Boxed1, and the other is Modern which all has its own styles and way of organizing the categories. You can choose which best suite you.

It also can sort the categories alphabetically, article count and custom type where you can decide which one should be placed where. It also allows for more styling and customization where you can almost customize everything as you wish.

You can set the number of columns, show or hide the image, show/hide description, choose the number of articles that should be displayed under a category and much more. This is just a trailer of what could be done with Helpie and Elementor. There is still a hell lot of other things that could be done. Just take your time to play around every single feature available.

There is also Article Listing where you can arrange some of the popular articles, recently added and recently modified articles and also articles arranged alphabetically. Article listing also still allows more styling and customization option which definitely should be tried on your own to know it’s plethora of features.

Step 3: A simple navigation like Table of Contents to go to any product from any page to find it’s information.

The next important step that any product documentation should have is to have clear navigation where you navigate to any article of any category from anywhere in your docs.

In simple words, a simple Table of Contents is a must-have feature in any proper product documentation. Helpie has a splendid table of contents in its settings which you can set in your sidebar, footer or anywhere.

Using Elementor page builder, you can assign it to any page you wish. Just create a page and select “Edit with elementor” as explained before. Type “Helpie table of contents” in the left search bar and the TOC widget will appear. Just drag and drop it to anywhere of your page.

You can set the title for your TOC as you wish, you can also choose the type of your TOC.

They have two types:

  1. One is the full navigation where every article of every category will be displayed in the TOC.
  2. The other is the In-page navigation which lets you navigate within a single article to different sections.

You can also control the number of articles to be displayed.

If you have a long list of articles under each topic/category, you can choose the toggle topic feature to show only the articles on the current topic and hide the rest.

Helpie settings itself have much more features for Table of contents which makes it all more powerful than any other documentation plugin.

Step 4: A robust search for users to search for the right articles about a product:

Customers will really get frustrated when they cannot find the information they are looking for.  A proper product documentation should compulsorily have a powerful search engine. Here’s why it is awesome:

  • Helpie gives you a super smooth search experience. Its search engine is a powerful live search which searches up to thousands of articles within seconds and prioritizes results based on contextual weight.
  • It’s even better than other paid WordPress search plugins
  • Its search engine works in such a way that the priority and weight are given to content appearing in different places like title, post content ( exact position in post content ), tags, etc…
  • It has a partial keyword search which matches every word typed into the search box and checking each of them against the content

Step 5: Voting and feedback feature so that users can share their opinion.

The last important step is allowing the users to share their feedback on the articles so that we will have a better understanding of which article works and which needs improvement.

Helpie has two options for users to share their opinion:

  1. One is the voting system where users can vote their opinions. It has two voting systems. One is the emoticon voting system where users can use different smileys to share their feelings on an article. The other is the classic voting which gives you a simple like and a dislike button. You can use any voting system.
  2. The other option is the comment section where users can share their comments, questions, and feedback on the article.

To enable these both settings, just go to Dashboard -> Helpie KB Wiki -> Helpie settings -> Single page. Under these, you can allow both the voting system and comments for your document.

Just follow the above steps given, and you will be straight on the spot with the most beautiful and clear product documentation. Hope this article makes everything clear in creating a documentation. If you still have any doubts, feel free to ask away in the comments section below.

 

Spread the love
  • 4
    Shares

Leave a Comment

Your email address will not be published. Required fields are marked *