Re: Documenting Packages for Future Developers

On Tue, Feb 3, 2009 at 10:18 AM, Dylan Jay wrote:

> Great. If the goal is to make plone easy to understand for developers then
> I for one am willing to help, especially if we build to a structure like
> Mikko has outlined. Thanks for the bug list, that helps a lot.
>
> It takes a lot to make the ideas in my head make sense to other on paper
> (and often I'm not successful... you may have noticed).


I've been thinking about it and noticed we just differ in the point of view
and proposed way to get it done, but really target the same objective. We
all wish a plone.org documentation well organized, not scattered, without
contradictions, and the best place to start learning Plone with the flattest
learning curve possible.

I just personally think that it will be easier to accomplish that starting
to work on the small things, organizing and polishing documentation about
each topic, and later think about improving cohesion between each part where
needed. I don't trust "master plans".



> I might be better off helping with coding which is why I've previously
> volunteered with sphinx. Seems like there's still a need to get code based
> docs into plone.org so they can be mixed with manual content. If so I' can
> raise a task and work on that. Otherwise I'll pick something off the list.
>

You're welcomed to work on any task, but the sphinx thing really deserves
some momentum, so feel free to start working on it. We want to put reference
and low-level code documentation there. Examples are currently available
portal properties, archetypes widgets or package doctests. Mikko's
"References" list is a good example too.


>
> PS. I didn't say you had to pay for plone documentation or that other
> projects don't have books. Just that we need quality developer docs that are
> free, which I'm sure we're not in disagreement about.


At all. :-)  And not only developer docs.

-- israel

------------------------------------------------------------------------------
Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM)
software. With Adobe AIR, Ajax developers can use existing skills and code to
build responsive, highly engaging applications that combine the power of local
resources and data with the reach of the web. Download the Adobe AIR SDK and
Ajax docs to start building applications today-http://p.sf.net/sfu/adobe-com

_______________________________________________
Plone-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-docs