Sunday, 12 February 2017

Product documentation : with use of wordpress contextual help

  No comments

For any product, documention is very important. When you develop a product then only you know how its work & how to use. But if someone new person tries to use then he can't use it so, in that case, your product useless for the user. So whenever you develop any product there is need to create a proper documentation. The documentation should cover below points.

About product
In this section describe our product completely like "about product", "Why you made it". If you develop something new product then there is no need to a comparison. If some product already exists then there is a need for comparison so that user can compare it. If a user uses an already product and your product have something new and better than user remve/uninstall our product & try your, In that situation, if your product works better than user always use your product if he fails then he use our existing product. So there more important to include about a product, advantage, disadvantage last but not least comparison.

How to use it
It's very important section so it's documented very carefully. There is need to clarify more clearly so that user can easily understand. There is a need for more graphics & text so that user have a clear idea. If your product is digital then nowadays different platforms like youtube, SlideShare, GitHub can help you. This platform provide you an area in which you show graphics, picture & animation so that product user can easily understand & use it.

Reviews
In this section provide the way (review submit form, toll-free number, or any number) through which user can provide the reviews. With the help of reviews, you can improve your product. Because mistakes make perfect so it's more important.

I review many plugins of WordPress the author writes very good & usable plugins but they fail only the documentation. Now WordPress provide a help section on top of the screen so take help of that you can provide help text & animation on each page.

start with creating simple, so I write code for creating a plugin which is below



Now the plugin is created but only its shows in the plugin list now there is a need to links on sidebar menu so that user can move on the pages by clicking on that. Now below code add two menus in admin sidebar menu. The below menu also connected with function my_magic_function & my_magic_function1.


Now Menu appears in the sidebar now on click on menu need to redirect on the page now I write a below code which creates the page on which user can redirect.



Now everything gone fine now the small plugin is ready but there is scanty of documentation now below code add the help text in above screen.



Now when you install this plugin in our wordpress set up then you can see the demo. I also attached the youtube video on which you also see the demo.



You can also browse the complete code by click on next button
code

No comments :

Post a Comment