Re: [OT] Documenting projects
[EMAIL PROTECTED] ([EMAIL PROTECTED]) wrote: > As far as requirements, you should pick up a Rational Unified Process book and look > at designing use-cases with Word. ...or KWord or swriter (OpenOffice/StarOffice) > Design, you can use visio ArgoUML or Dia Sorry, just had to plug for the open source world, GO OPEN SOURCE! viva la code! Dan -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Daniel Allen, <[EMAIL PROTECTED]> http://www.mojavelinux.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "If you are going to play the game of trial and error, don't be surprised when the results are revealing. -- me" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [OT] Documenting projects
On 04/04/2003 13:19 Jose Gonzalez Gomez wrote: Sorry, I wasn't explicit... I was thinking about other kind of documentation, like requirements capture with use cases, analysis and design with UML, etc There's an open source diagramming program called dia which does UML and might be worth looking at - just don't expect to find a free RR clone! It's file format is actually a gzipped XML file so you could store the un-compressed version in cvs. -- Paul Thomas +--+-+ | Thomas Micro Systems Limited | Software Solutions for the Smaller Business | | Computer Consultants | http://www.tmsl.demon.co.uk | +--+-+ - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [OT] Documenting projects
Jose Gonzalez Gomez wrote: Jason, Thanks for your response. I'am already using Poseidon for the UML part, and after searching and reading a while I think I'll adopt DocBook. What software do you use to author DocBook documents? A plain XML editor with DTD validation or do you use anything else? Ahh yes, I forgot that bit XMLmind XML Editor (XXE) (http://www.xmlmind.com/xmleditor/) The Standard Edition is free and managed to do everything I needed (there is a Pro version with added features). XXE features DTD and XML Schema aware editing commands and a word processor-like view configured using W3C's cascading style sheets. That gives it a WYSIWYG feel which is really quite cool. We also created our own extensions to DocBook to support Use Cases eg actors, preconditions etc. Adding a CSS file means we could see what they would almost look like when rendered into PDF or HTML. Then used an XSLT to convert Use Case->DocBook, then we could use the DocBook->HTML/FOP/etc standard XSLTs. It supports DocBook straight off so it is very easy to use without the extra stuff we did. -- Jason Lea - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [OT] Documenting projects
Mick, Thanks for your response, but I cannot take that approach because of control version. I think there are some products that lets you control versioning of Word documents but they are not free/open source. About free tools for UML, there are a few, in case you are interested. I'm using Poseidon from Gentleware. Regards Jose [EMAIL PROTECTED] wrote: As far as requirements, you should pick up a Rational Unified Process book and look at designing use-cases with Word. Design, you can use visio, or look to invest in something like Together-J. Together-j will generate use-cases, as well as class models and generate java code. But free Not really sure. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [OT] Documenting projects
Jason, Thanks for your response. I'am already using Poseidon for the UML part, and after searching and reading a while I think I'll adopt DocBook. What software do you use to author DocBook documents? A plain XML editor with DTD validation or do you use anything else? Regards Jose Jason Lea wrote: Jose Gonzalez Gomez wrote: Sorry, I wasn't explicit... I was thinking about other kind of documentation, like requirements capture with use cases, analysis and design with UML, etc We used DocBook with some extensions for creating Use Cases. So that we could create PDFs, HTML etc and some XSTL to pull out reports such as showing which Uses Cases an Actor appears in. Other documents were created in Open Office. UML Design we used Poseidon for UML (http://www.gentleware.com/products/poseidonCE.php3) The Community edition is free! It is based on ArgoUML (http://argouml.tigris.org/). We tried Argo at first but there were a few bugs which caused objects to disappear when saving/loading. Poseidon had fixed those problems and added some improvements. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [OT] Documenting projects
Jose Gonzalez Gomez wrote: Sorry, I wasn't explicit... I was thinking about other kind of documentation, like requirements capture with use cases, analysis and design with UML, etc We used DocBook with some extensions for creating Use Cases. So that we could create PDFs, HTML etc and some XSTL to pull out reports such as showing which Uses Cases an Actor appears in. Other documents were created in Open Office. UML Design we used Poseidon for UML (http://www.gentleware.com/products/poseidonCE.php3) The Community edition is free! It is based on ArgoUML (http://argouml.tigris.org/). We tried Argo at first but there were a few bugs which caused objects to disappear when saving/loading. Poseidon had fixed those problems and added some improvements. -- Jason Lea - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: [OT] Documenting projects
As far as requirements, you should pick up a Rational Unified Process book and look at designing use-cases with Word. Design, you can use visio, or look to invest in something like Together-J. Together-j will generate use-cases, as well as class models and generate java code. But free Not really sure. -Original Message- From: Jose Gonzalez Gomez [mailto:[EMAIL PROTECTED] Sent: Friday, April 04, 2003 2:19 PM To: Struts Users Mailing List Subject: Re: [OT] Documenting projects Sorry, I wasn't explicit... I was thinking about other kind of documentation, like requirements capture with use cases, analysis and design with UML, etc [EMAIL PROTECTED] wrote: >You always have javadocs and those can be generated automatically with ANT build >scripts. > >-Original Message- >From: Jose Gonzalez Gomez [mailto:[EMAIL PROTECTED] >Sent: Friday, April 04, 2003 1:46 PM >To: Struts Users Mailing List >Subject: [OT] Documenting projects > > > >Hi there, > >I want to document a project using something free, with text format >so I can include it in cvs (I know I can include binaries, but you lose >all the information about changes), and I would like to be able to >integrate it with maven. The options so far are html (or xhtml), docbook >(full or simple) or xdoc (the format used in jakarta projects). > >Any ideas, advices? > >Regards >Jose > >ps: of course, I'm using Struts for the web layer > > >- >To unsubscribe, e-mail: [EMAIL PROTECTED] >For additional commands, e-mail: [EMAIL PROTECTED] > > >Visit our website at http://www.ubswarburg.com > >This message contains confidential information and is intended only >for the individual named. If you are not the named addressee you >should not disseminate, distribute or copy this e-mail. Please >notify the sender immediately by e-mail if you have received this >e-mail by mistake and delete this e-mail from your system. > >E-mail transmission cannot be guaranteed to be secure or error-free >as information could be intercepted, corrupted, lost, destroyed, >arrive late or incomplete, or contain viruses. The sender therefore >does not accept liability for any errors or omissions in the contents >of this message which arise as a result of e-mail transmission. If >verification is required please request a hard-copy version. This >message is provided for informational purposes and should not be >construed as a solicitation or offer to buy or sell any securities or >related financial instruments. > > >- >To unsubscribe, e-mail: [EMAIL PROTECTED] >For additional commands, e-mail: [EMAIL PROTECTED] > > > > > -- Jose González Gómez Software Architect +34 635 575 994 [EMAIL PROTECTED] <mailto:[EMAIL PROTECTED]> http://www.opentechnet.com - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] Visit our website at http://www.ubswarburg.com This message contains confidential information and is intended only for the individual named. If you are not the named addressee you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately by e-mail if you have received this e-mail by mistake and delete this e-mail from your system. E-mail transmission cannot be guaranteed to be secure or error-free as information could be intercepted, corrupted, lost, destroyed, arrive late or incomplete, or contain viruses. The sender therefore does not accept liability for any errors or omissions in the contents of this message which arise as a result of e-mail transmission. If verification is required please request a hard-copy version. This message is provided for informational purposes and should not be construed as a solicitation or offer to buy or sell any securities or related financial instruments. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: [OT] Documenting projects
Sorry, I wasn't explicit... I was thinking about other kind of documentation, like requirements capture with use cases, analysis and design with UML, etc [EMAIL PROTECTED] wrote: You always have javadocs and those can be generated automatically with ANT build scripts. -Original Message- From: Jose Gonzalez Gomez [mailto:[EMAIL PROTECTED] Sent: Friday, April 04, 2003 1:46 PM To: Struts Users Mailing List Subject: [OT] Documenting projects Hi there, I want to document a project using something free, with text format so I can include it in cvs (I know I can include binaries, but you lose all the information about changes), and I would like to be able to integrate it with maven. The options so far are html (or xhtml), docbook (full or simple) or xdoc (the format used in jakarta projects). Any ideas, advices? Regards Jose ps: of course, I'm using Struts for the web layer - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] Visit our website at http://www.ubswarburg.com This message contains confidential information and is intended only for the individual named. If you are not the named addressee you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately by e-mail if you have received this e-mail by mistake and delete this e-mail from your system. E-mail transmission cannot be guaranteed to be secure or error-free as information could be intercepted, corrupted, lost, destroyed, arrive late or incomplete, or contain viruses. The sender therefore does not accept liability for any errors or omissions in the contents of this message which arise as a result of e-mail transmission. If verification is required please request a hard-copy version. This message is provided for informational purposes and should not be construed as a solicitation or offer to buy or sell any securities or related financial instruments. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] -- Jose González Gómez Software Architect +34 635 575 994 [EMAIL PROTECTED] <mailto:[EMAIL PROTECTED]> http://www.opentechnet.com - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: [OT] Documenting projects
You always have javadocs and those can be generated automatically with ANT build scripts. -Original Message- From: Jose Gonzalez Gomez [mailto:[EMAIL PROTECTED] Sent: Friday, April 04, 2003 1:46 PM To: Struts Users Mailing List Subject: [OT] Documenting projects Hi there, I want to document a project using something free, with text format so I can include it in cvs (I know I can include binaries, but you lose all the information about changes), and I would like to be able to integrate it with maven. The options so far are html (or xhtml), docbook (full or simple) or xdoc (the format used in jakarta projects). Any ideas, advices? Regards Jose ps: of course, I'm using Struts for the web layer - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] Visit our website at http://www.ubswarburg.com This message contains confidential information and is intended only for the individual named. If you are not the named addressee you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately by e-mail if you have received this e-mail by mistake and delete this e-mail from your system. E-mail transmission cannot be guaranteed to be secure or error-free as information could be intercepted, corrupted, lost, destroyed, arrive late or incomplete, or contain viruses. The sender therefore does not accept liability for any errors or omissions in the contents of this message which arise as a result of e-mail transmission. If verification is required please request a hard-copy version. This message is provided for informational purposes and should not be construed as a solicitation or offer to buy or sell any securities or related financial instruments. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
[OT] Documenting projects
Hi there, I want to document a project using something free, with text format so I can include it in cvs (I know I can include binaries, but you lose all the information about changes), and I would like to be able to integrate it with maven. The options so far are html (or xhtml), docbook (full or simple) or xdoc (the format used in jakarta projects). Any ideas, advices? Regards Jose ps: of course, I'm using Struts for the web layer - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
