Re: Help document Plone's API

On Wed, May 20, 2009 at 3:20 PM, Martin Aspeli wrote:
> 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!

I'd love to participate on that but I currently don't have the time
and won't have it until late June due to my exams. :-/

I'm not sure if a big tutorial like the "Managing Plone Objects
Programmatically" is the best approach here. Currently we're trying to
refactorize existing docs into manuals, more or less by topics, and
each of these manuals could include one or more pages describing the
API. For example, the WorkflowTool API could be explained inside the
workflow manual. What do you think about that?

In the future I would like the API documentation to be generated
directly from the doctests and sphinx or similar tools would be very
helpful here.

-- israel
p.s. Martin, we got a portlets manual for developers that needs
review... would you like to take a quick look at it?

------------------------------------------------------------------------------
Register Now for Creativity and Technology (CaT), June 3rd, NYC. CaT
is a gathering of tech-side developers & brand creativity professionals. Meet
the minds behind Google Creative Lab, Visual Complexity, Processing, & 
iPhoneDevCamp asthey present alongside digital heavyweights like Barbarian
Group, R/GA, & Big Spaceship. http://www.creativitycat.com