Return-Path: Delivered-To: apmail-xml-cocoon-users-archive@xml.apache.org Received: (qmail 25145 invoked by uid 500); 9 Oct 2002 16:07:52 -0000 Mailing-List: contact cocoon-users-help@xml.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: list-post: Reply-To: cocoon-users@xml.apache.org Delivered-To: mailing list cocoon-users@xml.apache.org Received: (qmail 25130 invoked from network); 9 Oct 2002 16:07:52 -0000 Message-ID: <002c01c26fad$c5460180$7c15290a@goaltech.com> From: "Barbara Post" To: References: Subject: Re: how do you document your projects? Date: Wed, 9 Oct 2002 18:05:52 +0200 MIME-Version: 1.0 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: 8bit X-Priority: 3 X-MSMail-Priority: Normal X-Mailer: Microsoft Outlook Express 5.50.4807.1700 X-MimeOLE: Produced By Microsoft MimeOLE V5.50.4807.1700 X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N I plainly : - produce "good" javadoc of the few java classes I create, - comment my sitemap and xsl while developping them, - produce a text (Word) document explaining more in detail pipelines' and xsl' roles... and also some notes about the Cocoon components I used (what they are for), and since I did not use every component available... But I am not creating a new system, just redesigning an old one. So my documents contain some info on Cocoon and much on what I developped. IMHO, you might think project documenting needs 15% of project developping time, and better a lot of comments in the code to be reordered afterwards. Babs ----- Original Message ----- From: To: Sent: Wednesday, October 09, 2002 4:33 PM Subject: how do you document your projects? > Hi, > > i am just wondering: if and how do you document your cocoon projects? I > don�t mean cocoon itself, but the projects you build up on cocoon. > > For the moment i am working on my own, but i think if i should give the > results in someoneelse�s hand, noone could easily understand what i did and > why i did it. Also when developing in a team, a project documentation would > be useful. (Besides that i sometimes loose my own structure ;) > > Are there any thougths about how to structure a cocoon project > documentation? Is there maybe a graphical notation on what happens inside > cocoon? E. g. which context is mapped where to and what kind of generators, > transformators etc. are applied? Any tools you can recommend? > > best regards > J�rn > > > --------------------------------------------------------------------- > Please check that your question has not already been answered in the > FAQ before posting. > > To unsubscribe, e-mail: > For additional commands, e-mail: > > ______________________________________________________________________ > Etudiant: Wanadoo t'offre le Pack eXtense Haut D�bit soit 150,92 euros > d'�conomies ! Clique ici : http://www.ifrance.com/_reloc/mail.etudiant --------------------------------------------------------------------- Please check that your question has not already been answered in the FAQ before posting. To unsubscribe, e-mail: For additional commands, e-mail: