[wp-docs] Structure of documentation

Andrew Rivett andrew at doun.org
Thu Feb 22 14:29:26 GMT 2007

In giving this more thought, I was thinking there should be three different
documents.  1. Writting a simple plugin.  I was going to use a random quote
plugin as an example, where the quotes are stored in the plugin file.  The
second document would then modify that plugin to store the information in
the database, and add administration pages.  The third document would add
ajax support to the administration pages to make the editing process
easier/more advanced.

I've just signed up to Codex, so I'll read the documentation on how to write
documentation and then hopefully get started in the next couple of weeks.
I'll let you know when I have something put together.


On 2/22/07, Martin Sturm <msturm10 at gmail.com> wrote:
> 2007/2/21, Jennifer Hodgdon <yahgrp at poplarware.com>:
> > Regarding a complete plugin example, I think there are plenty of
> > plugin examples out there, and I do not think that the article really
> > needs to have the complete plugin code in it, since there are so many
> > places to download plugins. Style is good; there is an article in the
> > Codex about WordPress programming style, so probably it's not
> > necessary to expound on that a lot in "Writing a Plugin".
> I think it can be of value to write an article based on the complete
> creation of a plugin. You simply shouldn't use a very complex plugin I
> think. The current "Writing a Plugin" article could easily transformed
> into this, by adding some sample code. Let me now when one of you has
> finished this article, maybe I can read it and provide some feedback.
> I think the writing of plugins is the most common 'development' task,
> so good documentation on this part is important.
> --
> Martin
> _______________________________________________
> wp-docs mailing list
> wp-docs at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-docs

Be the change you want to see in the world -- Mahatma Gandhi
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://comox.textdrive.com/pipermail/wp-docs/attachments/20070222/02163ddf/attachment.htm

More information about the wp-docs mailing list