How Much Detail Do You Need to Capture in UML for Code Development?

-

I had a mini-experiment to document my design in UML for a developer to write the corresponding code. The background and assumptions are:

  1. The application is an insurance quotation system
  2. Design is based on MVC, in particular, ASP.NET MVC
  3. Web caching is used
  4. The basic MVC application framework is in place (with sample codes)
  5. The developer is an intern from a local university
  6. What is designed to be developed is one of the modules in the entire application – this particular module is a dashboard

Without going into the details of the use case document, I created the basic tenets: certain basic sequence of events as well as the View-Of-Participating-Classes (VOPC).

The mini-experiment proved to be a success to my surprise.

The following UML Sequence Diagrams capture the basic flow for the initial web request:

image

image

The following UML Sequence Diagram depicts the sequence of events for subsequent access:

image

Finally the VOPC UML Class Diagram follows:

image

Comments

Post a Comment

Popular posts from this blog

Understanding ITIL Service Management the UML way…

-
Image
I originally had a great deal of difficult reconciling the differences amongst ITIL Change Management, Incident Management, and Problem Management. Having researched on the subjects and understanding them better now, I’ve tried to put the concepts together using a UML class diagram to capture my understanding and to keep it imprinted. Similarly, I wanted to differentiate the various categories of changes (Standard, Emergency, Normal) using an easy to understand & self-explanatory manner – a UML Activity Diagram!
Read more

How to depict (Professional-Looking) Logical Network Diagrams in Astah

-
Image
I have always had to create (professional-looking) UML diagrams using Visio-like icons. You’ve got to admit that showing a bunch of boring UML boxes hardly interests anyone less technical (like anyone whose designation has the words “manager” or “director”). This is actually possible in Astah! I’ve created a template for future projects that allows me to produce logical network diagrams that look like the following: To create this diagram, you need to do the following: Assign various icons to stereotypes. I created the following for my use: Create a new UML Deployment Diagram Every element in the diagram is created as a Node The nodes are subsequently assigned the appropriate <<stereotype>>. E.g. Internet is <<internet>>, WebZone FW is <<firewall>>, Web LB is <<loadBalancer>> Ensure the “Icon Notation” is set to “Customized Icon” for each node Instead of the boring boxes, the corresponding icons automatically gets displayed!
Read more