O'Reilly logo

WordPress 3 Plugin Development Essentials by Everett Griffiths, Brian Bondari

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Documentation

One of the problems that plague open source projects (and the WordPress plugin repository) is a lack of effective documentation. There are a lot of books about how to write good code, but there are precious few on how to write good documentation. Since documentation is a critical part of your plugin, we would be remiss if we neglected to give you some guidelines on how to write it effectively. Nothing is worse than pushing a good plugin on the public and not telling them what they need to know in order to use it. Think of it from a business standpoint: good user documentation means fewer client support requests and lower support costs.

Identify the purpose

The very first thing you need to do when writing documentation is identify ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required