Re: Developer manual stub now available

Martin Aspeli wrote:
> 
>> Regarding the idea of a Developer Manual, I'm ok with creating it as a 
>> single manual if you feel it makes collaboration easier. But I'd prefer 
>> to spread later the different topics into several manuals. Maybe that's 
>> because I prefer to think about each topic in a more "modular" way, 
>> rather than an ordered list of things to read and learn.
> 
>> Additionally, some of the contents you outlined, like portlets or forms, 
>> are already present in other manuals. Why not extending these manuals 
>> instead of creating a new one?
> 

I hope that I can simply link in to authoritative documentation if
available. But you still need to define the body of knowledge for Plone
somewhere so you know what all kind of techniques exist :) For some content
I have created myself I plan to simply delete the old pages and fuse it
directly to the new documentation.



> I think maybe the context got lost here. From what I can tell, this is 
> the "API reference" idea we were talking about a while back. Maybe we 
> should rename it?
> 
> The idea is to have short code snippets and examples for people looking 
> for Plone's "API". More in-depth background and step-by-step guides 
> should still go in separate manuals.
> 

Yes. I am open to all suggestions. I used name "developer manual" because
Django et al where using this term. Maybe "programming guide?" "API
reference" is often reserved for the documentation generated from the source
code.

I think there still needs to be little, just little, general "fluffy talk"
in some sections (e.g. transaction model).

Cheers,
Mikko
-- 
View this message in context: http://n2.nabble.com/Developer-manual-stub-now-available-tp3168160p3169486.html
Sent from the Documentation Team mailing list archive at Nabble.com.


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