Categories
Posts

The importance of stating the obvious

Writing documentation and other supporting content can be hard, especially for plugins. Why? There are many levels of user; developers, web ‘assemblers‘ and DIY-ers, all of whom will need to understand your content. You may think you’ve covered everything, but things that are obvious to you may be well beyond what some users can grasp.

Take one of my plugins as an example, a WP Job manager addon called WooCommerce Paid listings:

Add paid listing to WP Job Manager functionality powered by WooCommerce

To me it’s pretty obvious that this plugin integrates Job Manager with WooCommmerce, but to date I’ve had at least 10 users boggled by the fact you need to install WooCommerce first to use it. That’s insane given the name of the plugin, and the descriptions I provide.