Restrict content online documentation and user manual

Restrict Guide Content using User Access Manager Addon for Documentor

As the world is digitizing, the businesses, educational institutes, and many other sectors made their presence online. Increase in online business forced the organizations to store their data on the web.

This increased the demand for information security. As you are making the information available to the public, it becomes vulnerable.

Confidentiality, Availability, and Integrity are the major pillars of Information Security

There are many security issues filed just because of poor security. To maintain information security of your online documentation or user manual, you cannot give the complete access to every level of the user. You might have some confidential data. And only the higher authority can access it. Therefore, you have to grant some permissions to the other users.

Or say you want to make certain sections of the online documentation available only for your premium users, who are members of your site. In this case also, restricting the content of the guide using an access control plugin is essential.

So here we are! Documentor WordPress plugin comes with an addon “Documentor – User Access Manager Integration“. You can find this feature in Documentor’s Multisite and Developer version.

User Access Manager is a plugin which allows only specific users to access the data. So in this article, you’ll see the step by step guide for user access manager addon integration.

Why User Access Manager Addon is needed?

You might be looking to create online documentation using Documentor. Or you already have created your guides using Documentor WordPress Plugin.  Therefore, there might be some sections in your guide which you want to keep hidden. That means, only the users with the specified privileges can see the content. The User Access Manager Addon for Documentor can help you with this.

Once you have purchased the multisite or the developer package, just install the plugin.

Steps to install Documentor:

  1. Log in to the WordPress dashboard.
  2. Go to plugins => Add New.
  3. Click on upload plugin => Browse the plugin zip file
  4. Click Install.

Now go to “Installed plugins” and check whether the “Documentor – User Access Manager Integration” is activated.

Along with the above plugin, you’ll also need to install the User Access Manager plugin. The UMA is available on wordpress.org plugin repository. Therefore, in order to install that follow the following steps:

  1. Login to your WordPress dashboard.
  2. Go to plugins => Add new.
  3. Search for User Access Manager.
  4. Install the plugin and Activate it.

How to setup User Access Manager with Documentor

You might have different users accessing your guides. Therefore, some of the sections may be confidential. So let’s see how we can set this up.

1. Initially,  open the User Access Manager => Manage user groups.

User Access Manager

2. Give some name to your user group.

3. Give some description to your user group. The description and the IP range fields are optional.

4. Grant Read access to “Only group users”.

5. Similarly, grant Write access to “Only group users”.

6. Now its time to assign the access to specific type of users.

User Access Manager Role Affiliation

You can see the list of different user roles. Therefore, here you have to select only those user types to whom you want to grant access.

That means if you select “Author”, then only the Author can see the content. Likewise, you can select multiple user types at a time.  Click on Add User Group and this will create a new user group.

Once you have created the user group, now its time to change some settings. The settings contain the way the content should appear. You can completely hide any page, post, sections or even the media from your guide.

Setup User Access Manager Settings:

1. Go to User Access Manager => Settings

2. Now you just have to select the object type. The object type can be posts, pages, sections or even media.

Now manually change the setting for each type of object.

User Access Manager Settings

If you want to completely hide the pages, posts or sections then just select the “Yes” radio button as shown below:

completely hide section in UAM

 

Finally, we have to make some changes to our posts, pages, and sections. Just edit the part of your guide which you want to restrict.

UAM options on posts, pages and sections

 

Once you have selected the user group and updated the post, now its time to test the Documentor. If you have followed all the steps correctly then this should work properly. The users with no access will see the following message.

 

Final Output of Documentor guide

Documentor Settings if AJAX is enabled:

Most of the users enable the AJAX settings as its good for search engine optimization. Therefore the only addition setting you have to enable is “Enable Page Loading”.

The setting can be found just under the AJAX setting. To enable this setting just follow the steps given below:

  1. Log in to WordPress Dashboard.
  2. Go to Documentor => All Guides.
  3. Select and edit Edit the Guide.
  4. Go to Settings tab => Advanced Settings.
  5. Enable “Enable Page Loading” option. ( important )

ajax settings

So, this was the complete tutorial on how to setup User Access Manager and Documentor.

Here is a quick video tutorial as well for you to watch which might help you more with the setup.

If you know any other way or tools to grant the user access to your guides, do comment below.

12 Best Examples of Product Documentation and Help Guides

Besides a good feature rich product and amazing support; Product Documentation also plays an important role in terms of customer satisfaction and revenue. If there is no documentation available on the product site, customers will be forced to raise a support ticket.

Getting response from the support team may take some time and it may delay customer’s work. Self help guides allow customers to go through frequently asked questions and general queries and help them resolve small issues by their own. A good documentation contains easy navigation and clean layout with better readability. Step by step explanation with screenshots helps too. In this article, I will showcase some user manual examples or product documentation example to help you set a good goal.

Get Inspiration from User Manual Examples

If you are thinking that, creating a product documentation or online user manual is a very technical thing, I would recommend to read this Ultimate Guide to Create Product Documentation. A good documentation will speed up your product’s sale as well as improves SEO too.

Checklist for a Good Product Documentation Example

  • Easy navigation with clean UI
  • SEO Friendly design
  • Visitor’s Feedback with Comment
  • Code Syntax Highlighter
  • PDF Support with Branding for offline reading
  • Easy edit of documentation with in-built text-editor

Great Examples of  perfect Product Documentation and Help Guides:

Before creating a good product documentation guide, it is always better to see some inspirations. I have listed some of the best user manuals and product guide examples in this article to inspire you enough to start making your own. Many of these examples are of popular product sites and you may think that building such documentation will be a costly and time consuming task, but please read till the end as I have listed some simple ways to build similar documentation.

1) Stripe:

Stripe is one of the well known payment gateway used by many merchants. It allows individuals and businesses to accept the payment easily over the internet. I have gone through the documentation that was offered by them and I should say that the way it was represented was in a clean and easy to understand by the visitors. The API documentation that was offered by them was really amazing. There was a Syntax highlighter that was used, that allowed to display the source code in different colors as well as fonts.

Towards the left there were different topics that were listed by it. If you are planning to build a website related to API or where the source code is give much importance than definitely you should visit the documentation that is offered by stripe. The way the documentation for it was represented was commendable. There were different topics or the categories that were listed towards the left which is indeed eye catching for the visitors.

stripe

Stripe Documentation Example
  • API Documentation
  • Ease of Use
5

2) MailChimp

MailChimp is an email service provider that allows you to create, send as well as manage email newsletters. The documentation that is provided by them is very eye catching. It allows to add the links for the documentation along with Syntax Highlighter. Towards the left there are different sections that are displayed for the guide and there is different URL for each of the section. The documentation provided by MailChimp is displayed in very appealing way also all the points and instructions are mentioned very clearly.

mailchimp_doc

 

3) Yoast:

It will help you for the optimization of the site and also provides with the complete solution for SEO. Yoast provides with clean documentation, below each document there is a contact us form that allows to contact the support team in case of any of the queries. It also provides with a proper pagination along with all the categories that is listed towards the left. One can easily locate the category through the Search option present towards the top. It will also provides with the information when the document was updated lastly.

yoast

4) Microsoft:

After going through the documentation that is offered by Microsoft, it is very appealing for the visitors. It includes videos and images along with the documents that allows the visitors to have a better understanding. There are different sections for each of the category and there is an in-depth documentation that is provided by it. The thing that makes the documentation of Microsoft to be very appealing is the images and screenshots used by it. As images are always worth a thousand words.

microsoft

5) Apple

The way in which the documentation of Apple is present is really amazing. There are different points as well as instructions that are covered in the guide that is offered by them. Towards the bottom it provides with the feedback option where the visitors can share their views regarding a particular document. Also the users can add the suggestion in order to improve the particular document. There are also screenshots that are included to have a better understanding of the document that is provided. apple

6) Ionic:

The guide for ionic is represented in a very elegant way with the linking to the next documentation towards the bottom. Each of the topic is distinguished by different chapters and there are different icons that are represented for it. There is a sticky sidebar towards the left that is provided by it. There is a search option that is present at the top that will help to search a particular document very easily. The document is represented in such a way in order to make it appealing for the visitors and also it is very easy to understand from the perspective of the visitors.

ionic

7) Twilio:

The guide that is provided by Twilio is easily categorized into different categories. There is a Quickstart, Tutorials, API Reference and Helper Libraries that is provided by it. Towards the left it consists of all the sections that gets displayed based on the category that is selected. There are also different links that are provided by the particular doc and also consists of the linking to the next document. There are large number of sections that are added for each of the document that helps to have a better understanding. In case of any of the source code there is a Syntax Highlighter that is used for it.

twilio

8) Skype:

The user manual or documentation that is provided by Skype can be considered as a step wise manual with a complete understanding of the query that you are struck. Towards the top, it displays the count for the total number of articles. And there are different articles that are belonging to the particular category. There are different images and screenshots that are displayed for the particular doc. Towards the bottom there is an option that tells that whether a particular article is helpful or not. The way in which each of the step is displayed, makes it easy for the visitors to have a better understanding.

skype

9) WHMCS:

The documentation or the manual of WHMCS gives you the clear vision of the document that you are searching for. On the Home page of WHMCS there are different topics that are listed and one will easily find the document that one is looking at through exploring the following topics. Towards the top it will list out the topics with different sub sections. Under the documentation there is a separate topic that is present for the Community forums. There is a step wise explanation given for each of the topic for the How To Guide. There is also a proper linking that is given for each of the topic.

whmcs

10) Blesta:

The user manual that is provided by Blesta provides with a very good documentation that is indeed very simple and easy to understand. There is a separate guide that is prepared for the Users as well as Developers. As there are lots of sections that are present under a single topic, so towards the bottom it gives you the option to Show More. For each of the topic, it gives the details of the writer along with lastly the particular document was modified. There is a Navigate space that is present towards the right where one can search the topic that one is looking for. There are also breadcrumbs that are provided for each of the page that helps the user for the easy navigation. There is a tree like structure that is provided by this document.

blesta

11) BigCommerce:

The manual that is provided by BigCommerce is designed and presented in such a way to attract the visitors to the site. There are also links that are given for Chat and Community Forum in order to contact the support team in case of any of the queries. It also allows the user to give the feedback whether the following topic was useful for the visitors or not. The documentation also provides with different links in order to help the user to have a better understanding when they are referring to a particular topic.

big-commerce

12) Freshservice:

The manual lists out all the topics along with the count and sub topics for each of the topics. On clicking on the particular topic the user will be redirected to the page that one needs to refer. Towards the right, it will list out all the related articles along with the option to print the particular article. There are also different links that are added for each of the topic, it also allows to get the feedback from the visitors whether the topic is useful or not. It is written in very appealing way to attract the visitors and that will keep them glued to the guide. There is a different section that is present where the visitor can directly download the guide and go through it whenever required (for the offline reading).

freshservice

Creating Product Documentation through WordPress:

If you are planning to build one such documentation for your website than this can be achieved easily through WordPress. I would recommend to read this Ultimate Guide to Create Documentation to easily build and publish a beautiful guide just like the mentioned user manual examples. I have listed few free plugins to create documentation and along with that, check some WordPress Themes to implement a nice design.

Documentor:

Documentor is one of the best WordPress plugin in order to create the online product documents. There are different content types that are supported by this plugin such as videos, images, code snippets, Tables, Google Maps etc. The WordPress plugin is bundled with many features and to list a few of them includes:

  • For the offline reading it supports Save as PDF option.
  • It allows the users to submit feedback for any of the documentation section.
  • There are multiple skins that are supported for it to make it appealing for the visitors.
  • There is also a print option provided in order to print the particular manual or guide.
  • As Social Media plays a very important role for building of any of the site, so it supports Social sharing option.
  • There can be number of sections and subsections that can be added for the particular document.
  • It also allows you to embed the videos, Google maps and tables very easily with it.
  • Full control over the settings panel in order to change the color as well as fonts.

These are just of few of the features offered by Documentor plugin. This plugin is bundled with so many great features in order to create a perfect document for your site. A good documentation will definitely help you to increase the sale of the product. Moreover the content, images, screen shots and videos that are included while creating a document also plays a very crucial role. All the features that are provided will surely help you to build a document of your choice. Hope this post will help the users to build a better documentation and help guide for their site.