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 Deliverables - UML Diagram Descriptions required

 
s patnaik
Ranch Hand
Posts: 45
Chrome Eclipse IDE Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi

Do I need to describe the sequence diagrams? They seem pretty intuitive to me.

I have added description for deployment diagrams. But I did not add descriptions for class diagrams or component diagrams or sequence diagrams... I have an Architecture Overview section where I give a tier-wise description of the design patterns(specified only 3 ) i have used, the technology i have used (like jsf or ejb) and why i have used that technology. Is that enough?

Class diagrams/component diagrams/sequence diagrams seem self explanatory. Does adding no description mean failure?

I am going crazy about what level of detail i should go into... The more I read about other people's experiences, the more confused I become !

- SP
 
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
In theory, you didn't need descriptions anywhere. In practice, that isn't a good recipe because you want to communicate some things. I agree that a sequence diagram is pretty straightfoward and only used explanation for anything "odd" like why it didn't match my class diagram exactly.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic