Plone Developer Manual, take #0.1
Posted on September 26, 2009 by Mikko Ohtamaa
Filed Under plone, technology
The first public version of Plone developer manual is available here.
It is still very much draft, but I assure you will find it useful. You will find it even more useful after you put in the answers for your own problems.
In my previous Plone developer documentation rant my flow of though was little abstract and I couldn’t clearly explain how I want the community to maintain this crucial piece of documentation. This time I made a comic.
** How to update Plone Developer Manual
Other posts by Mikko Ohtamaa
heya … with one word: wooooooooowwww
if there is a vote what was best thing that happened for plone from last conference this is it. not that other things were not good enough it just that this kind of documentation was really needed.
i’ll already see some places where i can contribute, i have my “working copy” here
http://docs.garbas.si/plonemanual
again wow and tnx for this
[...] This post was mentioned on Twitter by Rok Garbas. Rok Garbas said: Woow RT @plone: Mikko Ohtamaa: Plone Developer Manual, take #0.1: The first public version of Plone developer manual… http://bit.ly/Cq5jV [...]
correct link … http://docs.garbas.si/collective.developermanual
This is really good – well done!
I still hope we can find a way to incorporate this into plone.org’s main documentation. Your chances of reaching the intended audience will greatly improve if it’s on there (and searchable form there). But this looks like a really good start, and something we’ve sorely missed for a long time. Bravo for picking up the mantle and sticking with it.
By the way, I don’t now if you’ve seen it already, but bits of http://plone.org/products/dexterity/documentation/manual/developer-manual/reference/manipulating-content-objects may be useful to borrow.
Martin
Hi,
I’ll personally add more pieces to the document when I need them in coding myself (itching my own scratch). Otherwise I’ll just keep adding links, as I really don’t have neither skill nor time to edit the text.
Also, plone.org integration will happen on some time scale, so do not worry
Now when we have some SOAP support add-on products we could even do this remotely, without touching PloneHelpCenter code base.
I like very much. I’m always trying to figure out the most useful reference tools to recommend to Plone developers, this sounds like a better version of the Plone Cheatsheet http://www.coactivate.org/projects/plonecheatsheet/project-home started a couple years back.