Re: Documenting Packages for Future Developers
Israel Saeta Pérez <[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.documentation |
|---|---|
| Message-ID | <[email protected]> |
On Tue, Feb 3, 2009 at 3:01 AM, Mikko Ohtamaa <mikko+plone-75aZqqp77KCaMPzRcYMCawC/[email protected]<mikko%2Bplone-75aZqqp77KCaMPzRcYMCawC/[email protected]> > wrote: > > > >> > I formerly thought we needed to explain how all parts of Plone fit >> > together, but now I realize the complexity of Plone and Zope makes >> > this too hard (and probably unnecessary) and a manual for each main >> > topic is fairly enough. >> >> > I updated the list: > > http://www.openplans.org/projects/plone-documentation/list-of-manuals > > I dumped my culminated knowledge which should cover 90% of use cases I have > struggled as a developer. Now the list contains few bullets and all we need > to do anymore is to write those open :) I tried to take both of the best > sides "task based" and "reference based" approaches when creating the list. > Thanks Mikko, that's really great, and I deeply appreciate your contribution here. > > I also created a list of "stock" items which should be commented in the > Plone code itself and the appropriate developer manual generated based on > the source. > > Zope 3 has done good work with doctest based documentation approach. This > could be applied for Plone as well. They usually reside on PyPI page. > Example: > > http://pypi.python.org/pypi/zope.session/3.8.0 > > I also urge the developers themselves to take this task. Development falls > beyound doc team core knowledge. Developers themselves should come up with a > proper manual which could be edited by docteam. > Yeah, that's the type of reference documentation which should be generated automatically from source, probably using sphinx. -- 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