• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Documentation Requirements

 
Ray Little
Greenhorn
Posts: 22
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Did many of you bother to do ER Diagrams?
What about UML Diagrams?
Thanks,
Ray
 
Chris Harris
Ranch Hand
Posts: 231
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
I have no plan to add diagrams to my choices document as it has to be a plain text file.
Have a look at this topic:
Number of classes/interfaces
Chris
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12007
215
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ray,
Entity-Relational diagrams? There is only one table in the SCJD assignment (and not a very well designed one at that), so ER diagrams don't really apply. Are you thinking about the SCEA assignment?
I did submit class diagrams. You can see more about that in the link that Chris supplied. I did not submit any of the other UML diagrams I had drawn.
I think that I am one of the few people who have submitted any diagrams. I have seen some others who have submitted diagrams, but they are few and far between. I have also seen a few people thinking about submitting diagrams but then deciding against it at the last minute.
My thought was that since I had already drawn the class diagrams, I might as well submit them. The examiner could ignore them if they desired, but if they wanted to look at them then it might help them understand my submission better, which might help me. (Of course that could have backfired - they could have seen something they didn't like in the diagram that they would have missed just looking at the code - fortunately that didn't happen ).
Regards, Andrew
 
Ray Little
Greenhorn
Posts: 22
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Simplicity rules. No URL diagrams. Of course no ER Diagrams (must have been on a coffee high).
Thanks,
Ray
 
Ray Little
Greenhorn
Posts: 22
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
BTW - One thing I did do, strictly for my own benefit, was to prepare a simple project file (MrProject) and it has really helped me to keep everything organized.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic