If you’re in enterprise, time can appear to be a finite useful resource. Getting issues executed requires lots of your undivided consideration. That mentioned, fielding calls and emails from present and potential prospects who've questions can take up lots of that treasured time.
That’s why having on-line documentation is so essential. A well-organized assortment of articles to assist folks find out about your services and products can enormously lower down on the variety of assist and pre-sales questions you obtain.
At this time, we’ll check out the Online Product Documentation WordPress Plugin, from PressApps. It permits web site anybody to simply create a documentation part.
The plugin has some useful options, together with:
- Assist for Classes to be able to higher manage your documentation.
- Public or Members Solely Voting to permit guests to vote on whether or not your articles are useful.
- Responsive Design to be used on cellular gadgets.
- A Colour Picker to assist match the look of your present web site.
- Add the documentation you’ve created to present pages or posts by way of a shortcode.
Getting Began
First, you’ll have to install the plugin. The simplest technique is to take the .zip file you’ve downloaded and add it by way of Plugins > Add New > Add Plugin within the WordPress Dashboard. As soon as the plugin is put in, remember to Activate it.
Now that you just’ve put in and activated the plugin, you’ll see a brand new menu merchandise created inside WordPress referred to as Paperwork.
Earlier than we begin creating documentation, although, let’s head over to Settings > PA Doc and check out what customizations can be found.
Plugin Settings
Refreshingly, On-line Documentation has a super-simple settings display. There are alternatives for:
- Reorder: Select whether or not to permit the reordering of posts and classes by way of a drag-and-drop interface.
- Voting: Permit documentation posts to be voted on by the general public, members solely or disable it altogether.
- Icon: When you enable voting, you may as well select to show an icon with it.
- Colour: Use the colour picker to pick the colour for hyperlinks and class headlines.
There’s additionally an space the place you may add Customized CSS.
The settings couldn’t have been simpler. Now, let’s create some documentation!
Creating Documentation
Classes
On this instance, we’ll setup documentation for an internet design service (an actual stretch of the creativeness for me). Earlier than we write any documentation, let’s create a few classes by visiting Paperwork > Classes on the WordPress menu.
Including a class is strictly the identical course of as in the event you have been including blog categories underneath the Posts part. Merely give the class a reputation and click on the “Add New Class” button. On this instance, there will likely be classes referred to as “Pre-Gross sales Questions” and “Buyer Assist“.
In your record of on-line documentation classes, a shortcode is offered for every class. So you may merely copy and paste these shortcodes into any web page or publish the place you’d wish to show a class’s article itemizing.
Documentation Articles
Now that we've some primary classes, let’s create a couple of articles for them. Go to Paperwork > Add New and also you’ll be in your approach very quickly.
Merely write your article, give it a title and verify the class you need it to look in. The articles could have the identical capabilities as another web page or publish in your web site. Which means you may simply add media or format textual content in the identical method.
The Outcomes
Able to show your articles? The only solution to go about it's to create a web page in your web site (we’ll name ours “Documentation”) and place the next shortcode contained in the web page:
[document]
This shortcode will robotically show all classes we created and the articles inside. Bear in mind, you even have the choice to indicate only one class on a particular web page utilizing the shortcodes obtainable at Paperwork > Classes, if you want.
Right here we've a two column format that shows an interactive menu on the left and the contents of the chosen article on the appropriate. A pleasant function is that the menu within the left column is “sticky”, which implies it scrolls proper together with the person as they navigate the documentation.
This helps to make sure that it's all the time straightforward to seek out what you’re on the lookout for. All the articles are included on the web page, so you may actually scroll proper via every article with out utilizing the menu on the left, if desired.
Total Impressions
On-line Product Documentation is an easy, but highly effective device you should use to create a strong set of documentation for your corporation, product or merchandise. The setup couldn’t have been simpler however there may be additionally a useful PDF handbook included – simply in case.
The menu system included with the plugin works fairly properly. It means that you can merely deal with the content material and never fear about easy methods to make all of it work. For very giant units of documentation, I can see the flexibility to show every particular person class on a separate web page as a crucial function.
In case you are seeking to create documentation on your web site, Online Product Documentation is a implausible resolution. You’ll be up and operating very quickly and also you simply would possibly save your self a while, too.
When you’re an Editablewp Market Creator, Tuts+ have published a tutorial series that takes you thru a “guidelines” to create WordPress themes (additionally overlaying documentation) that may be revealed and bought on ThemeForest.
Header Picture Supply: Business Man Document Signing Up Contract by prostockstudio.
