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

Documentation - UML ?

 
Alan Morgan
Ranch Hand
Posts: 113
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

I was flicking through a SCJP and SCJD combined book last night (can't remember the name) and I had a quick look at the documentation section.

In here the author(s) recommended that you provide your UML diagrams with your submission.

However given that we are only allowed a plain text file as our design choices how would you go about doing this ?
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Alan,

While there are certain documents that must be in plain text, there are other documents that you are allowed to submit in HTML format. And, since UML diagrams are not discussed in the instructions, any diagrams could be in any format you like (although I would recommend something the assessors are guaranteed to be able to use - namely HTML wrappers for GIF or JPG files).

Regards, Andrew
 
Alan Morgan
Ranch Hand
Posts: 113
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Oh right. Now that was something I did not realise.

So I can submit my class and sequence diagrams for inspection.
I take it that this is something that students regularly avail of ?
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Alan,

To be honest, I havent seen many questions about submitting UML diagrams - sometimes only one every 3 or 4 months. So I don't think many candidates are submitting class or sequence diagrams.

Regards, Andrew
 
Lara McCarver
Ranch Hand
Posts: 118
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I just submitted my exam last night. There were a couple of diagrams I wanted to add, though nothing extensive, but the instructions were
pretty clear that it had to be a plain text file. I was surprised they
did not say that it would be OK to submit either plain text or HTML.
Anyway, I created ASCII art in the plain text file. Again, these were
just a couple of small diagrams so it was feasible but (of course)
painful.

I guess what Andrew is saying is that in your plain text file you could refer the reader to the diagrams you have. And these other documents
are not issue discussions so it's OK if they are not plain text.

Lara
[ December 13, 2005: Message edited by: Lara McCarver ]
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic