Re: A project we can learn from

Dylan Jay wrote:
> With regard to the developer manual, whats the procedure for ripping  
> out topical overviews like those of Martins and putting them into an  
> aggregated manual that will be maintained by everyone? Is it just a  
> matter of asking the authors permission?

You mean copy-pasting from plone.org/documentation to 
collective.developermanual?

Like JoAnna says, everything looks all-rights-reserved for now. I'd push 
for applying CC licenses to all our documentation material on plone.org. 
Anyway and repeating what JoAnna said again, I honestly doubt that any 
author is going to be opposed to copying what he/she contributed and 
spreading it...

The "topical guides" will be our manuals in the official section of 
plone.org/documentation. I personally like integrating tutorials with 
"topical guides", like we did for the portlets developer manual, but 
everybody's free to choose the form he/she feels more comfortable with.

While I see collective.developermanual as a good effort to provide 
not-so-complete or reviewed documentation for Plone, I guess that we 
will just copy-paste its contents into the KB when it's ready, since I 
personally find faster to contribute clicking Edit and editing than 
having to checkout a package with SVN and asking for write rights for 
the collective. What do you think?

Regarding the API reference, I agree on that we need one. Martin 
proposed to start one time ago and, from my perspective, this is one of 
the objectives of collective.developermanual, right?

One more thing. Everytime I write about how to organize documentation I 
realize that I'm more and more unsure about how should it be organized. 
I don't want to stop anybody from testing new ideas. We can always ditch 
something if it doesn't work at all, but what we can't do is learning 
from what's not written. Perhaps we should theorize less and accept that 
actions speak louder than words. ;)

Best,
-- israel


------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
trial. Simplify your report design, integration and deployment - and focus on 
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july