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

Part 2 - Adding description for diagrams

 
Gurukant Desai
Ranch Hand
Posts: 56
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 196
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 35279
384
Eclipse IDE Java VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yes. You want to give the reviewer as much information as possible to work with.
 
Ranganathan Kaliyur Mannar
Bartender
Posts: 1103
10
Java Netbeans IDE Ubuntu
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
Gurukant Desai
Ranch Hand
Posts: 56
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks a lot!! I will add descriptions for every diagrams now.
 
Gurukant Desai
Ranch Hand
Posts: 56
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 35279
384
Eclipse IDE Java VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 15
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I did add description for each class by textual under the class digram
 
kumar naresh
Ranch Hand
Posts: 120
1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic