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

How far to go on sequence diagrams

 
Steven De Groote
Greenhorn
Posts: 16
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

I was wondering, how far do you guys go in the level of classes you show.
For example if you are using JMS, do you also include the standard JMS API classes and calls in your diagram, or only your own classes?

I was doing the first approach, but my diagram is starting to get really bloated...


Thanks,
Steven
 
Teja Saab
Rancher
Posts: 152
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Steven De Groote wrote:
I was wondering, how far do you guys go in the level of classes you show.
For example if you are using JMS, do you also include the standard JMS API classes and calls in your diagram, or only your own classes?

I was doing the first approach, but my diagram is starting to get really bloated...


I think a simple rule of thumb is to create a sequence diagram that a developer can look at and know how to build to. I certainly would not include JMS API classes and such in the sequence diagram. Besides, you can obtain JMS connections/queue/topic names and such in multiple ways (JNDI lookups, direct application configuration etc). The architect IMHO should provide a certain level of flexibility to the application developer and not try to provide information at a micro level.

Just my $0.02 though....
 
Kuppusamy Venkatasubramanian
Ranch Hand
Posts: 91
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

For all the diagrams, chapter 9 of Humphrey Sheil is the best place to refer. I too drew the diagrams based on Chapter 9 and the Power point presentation (the download link of those can be got by searching the forum). It is better to present the information as expected by the examiner which is outlined in Chapter 9 of the study guide. I didn't go into showing API level classes in my sequence diagrams but still showed dependency injection and showed relevant information using notes.

Cheers,
Kuppusamy.V.,
 
Deepak Bala
Bartender
Posts: 6663
5
Firefox Browser Linux MyEclipse IDE
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
If you are representing things at a conceptual level (which is usually better) you can skim a lot of details. So method names are now replaced by descriptive message calls. Like A ---authenticateUser()--> B where B can contact say an LDAP and you dont really care about which LDAP API it uses to achieve this.
 
Mihai Lihatchi
Ranch Hand
Posts: 138
Java Linux
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
My point of view is that you should make clear the way you need to implement the use cases.
This means also mentioning some API calls(like entityManager.persist ).
As long as the design is flexible switching API's (like JPA for JDBC )will not be a problem and you need to mention it.
The reason for this is that you need to show that you have an actual concrete solution to the user problem. Pretending that say JDBC or JPA can be left to the developer
is not a solution IMHO.
Sequence diagrams are the ones that (from what I read and from my experience) are not worth loosing a lot of time on in practice (and may be even in SCEA exams).
I drew several sequence diagrams before starting coding (at my current job) and almost none survived implementation untouched . The class diagram remained untouched.
For 16 points you need to make them clear but they are expected to change rapidly in development .
The backbone remains the class and component diagram . These need to be perfect as they supply the skeleton to build behaviour on.
Just my 0.00002 cents .
 
Steven De Groote
Greenhorn
Posts: 16
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks a lot guys, that cleared things a bit for me!
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic