Plone Developer Manual, take #0.1

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 get support

** How to update Plone Developer Manual

How do you prefer your documentation?

Lately there have been three long email chains related to Plone development documentation here, here and here (total ~100 messages). This little post tries to summarize the current discussion.

I think the dicussion is mostly fueled by third party developers’ frustration with the current development documentation situation. Developing for Plone is difficult, since finding references, how tos and examples for those little things you need is very hard. This is a turn off for many developers who would otherwise use this great system – high developer learning curve and gaps in the documentation makes the system useless.

Points everyone agree are

• Plone development documentation is not good
• Sphinx is good for API documentation – already happening
• Contributors are needed

Points discussed are

• Should developer documentation be more open ended (Wiki-like). This covers
  • Developer manual
  • How tos and other misc. references
  • API documentation
• Mostly, it is not about generic end user, admin or system integrator or getting started documentation (here, here)

Pro wiki-like documentation stances

• It should be more open ended (here, here, here)
• It’s better to have something messy instead of nothing at all – the current approval process discourages contribution (here)

Con wiki stances

• It should not be open ended, since this results to messy documentation (here, here)
• There should be less plone.org documents (here)
• Wikis are bad (here)
• Incomplete wikis are discouraging (here)

Let’s wait and see where this goes.