Hi, I prefer both, a wiki and the site. A site is more formal and covers all aspects inclusive the details like module structure or reports of the project. Because of that a site is often complex and someone who is not familiar to the project looses often scope in its details.
The wiki could be a perfect entry point to the project for someone who is new or just want to use the project results. Redundancy could be avoided by linking the wiki and the site together. An additional point is JavaDoc. Apart of the more or useless one liner comments ;-) it is also possible to put in detailed descriptions to explain and how to use the API. Not as an overview, but on the very detailed level. Regards, Stephan -----Original Message----- From: Gabriele Columbro [mailto:[email protected]] Sent: Freitag, 12. Februar 2010 09:48 To: [email protected] Subject: Re: Chemistry documentation page Hi Jens, I see the wiki actually as more developers/design documentation while I see the comprehensive and structured documentation as perfect fit for the Maven site capabilities. That would automatically generate a default documentation site (with selected reports) per every module + every custom documentation page you write in the src/site folder of that module. What do also the others think? Ciao! Gab On Feb 12, 2010, at 8:50 AM, Jens Hübel wrote: > Hi, > > > > we have started putting some documentation about OpenCMIS in the > Confluence wiki (http://cwiki.apache.org/CMIS/opencmis.html). With > the increasing community and the recent contributions the Chemistry > structure gets more complex. I think we need an overview page and > sub-sections for the sub projects. We also should provide a > description how the sub projects depend on each other or where they > are independent. > > > > Are there any proposals out there how to design the project > navigation? > > > > Jens > > > -- Eng. Gabriele Columbro Alfresco Software, Ltd. M: +31 (0)627 565 103 P: +39 320 161 28 46 D: +44 (0)1628 876 654 Skype: gabrielecolumbro Blog: http://www.mindthegab.com
