UML 2 Stereotype Style Guidelines

Scott W. Ambler + Associates
 
   Home  |  AMDD  |  Best Practices  |  Architecture  |  Requirements  |  Analysis  |  Design  |  Documentation  |  Models  |  Modeling Style  |  Contact Us  |  Announcements  |  FAQ
Elements of UML 2.0 Style A stereotype denotes a variation on an existing modeling element with the same form but with a modified intent. Stereotypes are effectively used to extend the UML in a consistent manner.  

 

 

Figure 1. Indicating stereotypes.

Figure 2. A frame encompassing a sequence diagram.

 

 

  1. Name Stereotypes in <<user interface>> and <<UI>> format.
  2. List Stereotypes Last. In Figure 1 the second version of the Customer class lists the stereotypes for its operations after the operation signature, not before it.
  3. Don’t Indicate Assumed Stereotypes. In Figure 1 I dropped the <<business domain>> stereotype because it is common practice to assume that unless marked otherwise that a class is a business domain one.
  4. Prefer Naming Conventions over Stereotypes.  For example, instead of applying the stereotype <<getter>> on an operation, you could simply start all getters with the text get.  This simplifies your diagrams and increases the consistency of your source code. Normally would have ditched <<getter>> in Figure 1 but I left it there for the discussion of Tagged Values Follow Stereotypes.
  5. Tagged Values Follow Stereotypes.
  6. Center Classifier Stereotypes.  The stereotype for a classifier, such as the Customer class in Figure 1 should be centered (as should the name itself).
  7. Introduce New Stereotypes Sparingly.
  8. Apply Stereotypes Consistently.
  9. Apply Visual Stereotypes SparinglyFigure 2 depicts a sequence diagram which includes the standard robustness diagram symbols which are commonly applied to UML communication diagrams

 

Recommended Resources

Elements of UML 2.0 Style   The Elements of UML 2.0 Style describes a collection of standards, conventions, and guidelines for creating effective UML diagrams. They are based on sound, proven software engineering principles that lead to diagrams that are easier to understand and work with.  These conventions exist as a collection of simple, concise guidelines that if applied consistently, represent an important first step in increasing your productivity as a modeler.  This book is oriented towards intermediate to advanced UML modelers, although there are numerous examples throughout the book it would not be a good way to learn the UML (instead, consider The Object Primer).  The book is a brief 188 pages long and is conveniently pocket-sized so it's easy to carry around.
The Object Primer 3rd Edition: Agile Model Driven Development (AMDD) with UML 2   The Object Primer 3rd Edition: Agile Model Driven Development with UML 2 is an important reference book for agile modelers, describing how to develop 35 types of agile models including all 13 UML 2 diagrams.  Furthermore, this book describes the techniques of the Full Lifecycle Object Oriented Testing (FLOOT) methodology to give you the fundamental testing skills which you require to succeed at agile software development.  The book also shows how to move from your agile models to source code (Java examples are provided) as well as how to succeed at implementation techniques such as refactoring and test-driven development (TDD).  The Object Primer also includes a chapter overviewing the critical database development techniques (database refactoring, object/relational mapping, legacy analysis, and database access coding) from my award-winning Agile Database Techniques book.
Agile Modeling   Agile Modeling: Effective Practices for Extreme Programming and the Unified Process is the seminal book describing how agile software developers approach modeling and documentation.  It describes principles and practices which you can tailor into your existing software process, such as XP, the Rational Unified Process (RUP), or the Agile Unified Process (AUP), to streamline your modeling and documentation efforts.  Modeling and documentation are important aspects of any software project, including agile projects, and this book describes in detail how to elicit requirements, architect, and then design your system in an agile manner.

 

 

Let Us Help

We actively work with clients around the world to improve their information technology (IT) practices, typically in the role of mentor/coach, team lead, or trainer.  A full description of what we do, and how to contact us, can be found at Scott W. Ambler + Associates.

 

Agile Data (AD)  |  Agile Unified Process (AUP)  |  Enterprise Unified Process (EUP)  |  Disciplined Agile Delivery (DAD)  |  My Writings   |  IT Surveys  

Follow Scott W. Ambler on Twitter


Copyright © 2004-2012 Scott W. Ambler

This site owned by Ambysoft Inc.