Two Laptop Bag*
The moose likes Architect Certification (SCEA/OCMJEA) and the fly likes Part 2 - Adding description for diagrams Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of OCA/OCP Java SE 7 Programmer I & II Study Guide this week in the OCPJP forum!
JavaRanch » Java Forums » Certification » Architect Certification (SCEA/OCMJEA)
Bookmark "Part 2 - Adding description for diagrams" Watch "Part 2 - Adding description for diagrams" New topic
Author

Part 2 - Adding description for diagrams

Gurukant Desai
Ranch Hand

Joined: Apr 07, 2008
Posts: 56
Hello Ranchers,

Does it make sense to add extra description for class diagram, component diagram and deployment diagram?

I feel that sequence diagrams are good candidate for adding description for explaining flow, but it will not make much sense to add description beneath class diagram.

Please share your views.

Thanks!
Arnold Reuser
Ranch Hand

Joined: Nov 20, 2003
Posts: 196
It makes sense to clarify all diagrams created. You can use the search functionality of this forum for potential points of interest.
The are quite a few hints on this.
Jeanne Boyarsky
author & internet detective
Marshal

Joined: May 26, 2003
Posts: 30789
    
157

Yes. You want to give the reviewer as much information as possible to work with.


[Blog] [JavaRanch FAQ] [How To Ask Questions The Smart Way] [Book Promos]
Blogging on Certs: SCEA Part 1, Part 2 & 3, Core Spring 3, OCAJP, OCPJP beta, TOGAF part 1 and part 2
Ranganathan Kaliyur Mannar
Bartender

Joined: Oct 16, 2003
Posts: 1085
    
  10

Yes, you can make use of the 'Note' in UML to do this too. And you can have a free note and also a note that is attached to a specific object.


Ranga.
SCJP 1.4, OCMJEA/SCEA 5.0.
Gurukant Desai
Ranch Hand

Joined: Apr 07, 2008
Posts: 56
Thanks a lot!! I will add descriptions for every diagrams now.
Gurukant Desai
Ranch Hand

Joined: Apr 07, 2008
Posts: 56
Hi,

I have added descriptions in all other diagrams except class diagram and I am not able to write more than 5 line description for class diagram as my system overall design has been included in component diagram. Shall I explain cardinality between business objects as description?
Although it is very much displayed in diagram?

Please provide some topics that should be specifically part of class diagram desciption.

Thanks!
Jeanne Boyarsky
author & internet detective
Marshal

Joined: May 26, 2003
Posts: 30789
    
157

Assume the reviewer knows how to read the diagram (such as cardinality.) Repeating just wastes his/her time. Use text/comments for explaining why you did something. Why did you choose a tricky multiplicity? Why did you deviate from the business diagram in the assignment? Anything non-standard you want to call attention to.
chen jiangbo
Greenhorn

Joined: Aug 18, 2011
Posts: 15
I did add description for each class by textual under the class digram
kumar naresh
Ranch Hand

Joined: Mar 12, 2011
Posts: 120
    
    1
Instead of adding description in the diagram it self, Is it not better to put in the html.

While submitting index.html as to be prepared and every other diagram is referenced again with one more html in which diagram as well as text information below it. Will this would be fine.


OCMJEA 5 |
http://sceacertification.blogspot.in/2011_12_01_archive.html
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Part 2 - Adding description for diagrams