Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

UML Diagrams and package.html

 
Steve Granton
Ranch Hand
Posts: 200
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
I'm planning to use the Community Edition of Poseidon to create UML diagrams for the project. As I can save the diagrams as images I was thinking of including the diagrams as part of the package description in the package.html file for javadoc.
I know that some people have talked about adding UML diagrams in the text file that we have to provide with the assignment but has anyone used images in the javadoc? Is this a good idea? ... after all a picture paints a thousand words :-)
I would be grateful for comments and suggestions on this approach.
Cheers,
Steve
 
Enrico Mannarino
Ranch Hand
Posts: 133
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Steve,
I think you can add pictures in your DesignChoices document. Make it an html-doc and you’ll be fine!
The way I interpret the requirements is that the README.txt must be plain ascii, but that the other documents can be html. That’s the way I did anyway. We’ll see, I’ll take the exam tomorrow, uploaded the assignment last Thursday.
/Enrico
 
Steve Granton
Ranch Hand
Posts: 200
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
Thanks. I've re-read the Deliverables section of the specification and you are correct - you can provide other documents as well as the README.txt. I'll create html docs and include the images in there.
Good luck for the exam and let us know how you get on.
Cheers,
Steve
 
Kalichar Rangantittu
Ranch Hand
Posts: 240
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Good luck Enrico!
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic