Re: Developer manual stub now available
Martin Aspeli <[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.documentation |
|---|---|
| Message-ID | <[email protected]> |
Israel Saeta Pérez wrote: > Mikko Ohtamaa wrote: >> Hi, >> >> I have created the long awaited dev man stub at w00t :) > 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 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. If this was a book, think of the other tutorials/manuals as chapters, and this as the "quick reference" appendix. We can and should link to more in depth manuals when available from the relevant sections, too. Martin -- Author of `Professional Plone Development`, a book for developers who want to work with Plone. See http://martinaspeli.net/plone-book ------------------------------------------------------------------------------