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

The decalog of documentation

The following is a checklist of actions for you to go through to help ensure that your plugin's documentation is reasonably sound.

  1. Include full examples. Short little code fragments are only relevant after you've demonstrated a full example. Zoom out a little bit and include a couple of lines of code before and after your example—they are invaluable in helping to put your examples into context. Take the time to demonstrate a few use-cases, and don't be cheap. If people repeatedly ask you how to do something related to your plugin, you should thank them for the interest and demonstrate a viable solution. Remember that they are asking you for a phrase, not a definition—an example demonstrates how to perform a specific ...

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