Re: Documenting Packages for Future Developers

Hi all,


Markus Bleicher-4 wrote:
> 
> The idea of a "what techniques where used in this product" documentation
> is great. And like Dylan I think that the sections list of a developers
> manual is the list to choose from (and George's is not too distinct, as
> far I can see).
> 

Ah, I am more clearly seeing now how a developers manual and its
sections/table of contents would work with this. I think originally I didn't
see how it would work because (1) most documentation is scattered so that
there are bits and pieces of what you need in different places, and (2) for
reasons that make sense, a lot of documentation are like tutorials that walk
you through step by step and sometimes roundabout rather than more
matter-of-fact references.

Are there plans for creating a developers manual? I see
http://plone.org/documentation/manual/plone-2.5-user-manual and
http://plone.org/documentation/manual/plone-developer-reference but when I
search don't see anything ASAP on a developers manual.


Markus Bleicher-4 wrote:
> 
> The topping: an inverse search to find products which employ a certain
> method. 
> 

That could be a great learning tool for people wishing to see more real-life
examples of different methods.

Peace, community, justice,
- George
-- 
View this message in context: http://n2.nabble.com/Documenting-Packages-for-Future-Developers-tp2107425p2111863.html
Sent from the Documentation Team mailing list archive at Nabble.com.


------------------------------------------------------------------------------