AW: how do you document your projects?
Hi all! Producing 'good' javadoc for the classes seems to be also my way. Nevertheless I would be interested how to comment the whole XML stuff (sitemap, XSPs, XSLs ... being the main part of source for cocoon projects). Is it just usual comments '!-- ... --' or is there a more sophisticated and clever way to do this (maybe also some tools available)? Antonio Gallardo also mentioned the xsldoc tag. Is this filtered or does there exist some tags which allow documentation in the XML formatted sources? Thanks Kurt -Ursprüngliche Nachricht- Von: Barbara Post [mailto:babs33;ifrance.com] Gesendet: Mittwoch, 09. Oktober 2002 18:06 An: [EMAIL PROTECTED] Betreff: Re: how do you document your projects? 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: [EMAIL PROTECTED] To: [EMAIL PROTECTED] 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. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] __ 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. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - Please check that your question has not already been answered in the FAQ before posting. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
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. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: 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. I use UML interaction diagrams (where the pipelines are instances of a Pipeline class). /O - Please check that your question has not already been answered in the FAQ before posting. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: how do you document your projects?
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: [EMAIL PROTECTED] To: [EMAIL PROTECTED] 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. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] __ 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. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: how do you document your projects?
For xsl I saw there are a xsldoc tag. I use OpenOffice.org Writer to make a formal developer manual. Javadocs and comments in the sources files. Antonio Gallardo. El Miércoles, 09 de Octubre de 2002 08:33, [EMAIL PROTECTED] escribió: 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. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - Please check that your question has not already been answered in the FAQ before posting. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: how do you document your projects?
Hi, thanks, thought about UML as well, but I am not too deeply into it. Could you send me an example of a cocoon interaction diagram? My Email-Adress is: [EMAIL PROTECTED] Bye Joern - Please check that your question has not already been answered in the FAQ before posting. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Re: how do you document your projects?
Joern, I am in the process of developing documentation that describes an admittedly simple usage of Cocoon within an application. The diagram is only for the Cocoon portion of the system. There is a Visio diagram that I think does a good job of describing what takes place. There is also a Word doc that goes along with it. I'll be happy to send it to you and anyone else who is interested (Don't wanna spam the whole list). Plz email me at: mailto:[EMAIL PROTECTED] if you would like the docs. They will be completed sometime this afternoon. Bob Hitchins -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]] Sent: Wednesday, October 09, 2002 1:11 PM To: [EMAIL PROTECTED] Subject: Re: how do you document your projects? Hi, thanks, thought about UML as well, but I am not too deeply into it. Could you send me an example of a cocoon interaction diagram? My Email-Adress is: [EMAIL PROTECTED] Bye Joern - Please check that your question has not already been answered in the FAQ before posting. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - Please check that your question has not already been answered in the FAQ before posting. http://xml.apache.org/cocoon/faq/index.html To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
