Help document Plone's API

Hi guys,

I'm looking for a volunteer to drive an effort to improve Plone's API 
documentation. I posted a message to the product-developers list 
earlier, which had modest response. However, I know several people are 
very keen to see this happen, including myself, obviously. :)

I don't have the time to write this documentation, but I will do my best 
to help, answering questions, finding examples, and reviewing.

This is probably a couple of weeks' worth of volunteer time, and will 
require someone with at least some programming experience. On the other 
hand, it's probably less work than the AT tutorial and we pulled that 
off. ;)

The message I posted earlier is reproduced below. If anyone's 
interested, please respond here!

...

We've recently had some discussions about what Plone's "API" looks like.
The challenge, of course, is that so many things are customisable, so
"the API" is really a very loose term, when you can call just about
anything.

That said, I think there are about 50-100 interfaces/tools/functions
that cover 80% of what most of us do day-to-day. If we can capture
those, we can do some useful things like:

   - identify which APIs suck
   - identify which APIs we're missing (i.e. we end up having to poke at
internals when we should have some clearly defined interface)
   - identify where we have duplication and can consolidate APIs
   - document!

As an end goal, I'd like us to extend and refactor the "Manipulating
Plone Objects Programmatically" tutorial[1] into a more hierarchically
structured reference manual that covers the most common tasks. Some
tasks may require references to other tutorials (e.g. the Archetypes
tutorial), but at least it's a starting point and a place to collate
future APIs as well.

The current groupings and lists of APIs can be found here:

    http://www.mindmeister.com/21419197

That mind map is public, though you may need to sign up for an account
(OpenID support makes that pretty quick if you have that already). I can
also give you access to edit the mind map if you want to collaborate:
just drop me an email with your MindMeister user id.

Cheers,
Martin

[1]http://plone.org/documentation/tutorial/manipulating-plone-objects-programmatically

-- 
Author of `Professional Plone Development`, a book for developers who
want to work with Plone. See http://martinaspeli.net/plone-book


------------------------------------------------------------------------------
Crystal Reports - New Free Runtime and 30 Day Trial
Check out the new simplified licensing option that enables 
unlimited royalty-free distribution of the report engine 
for externally facing server and web deployment. 
http://p.sf.net/sfu/businessobjects