|
|
 |
A
UML note is a modeling construct for adding textual
information – such as a comment, constraint definition,
or method body – to UML diagrams. Notes are depicted as
a rectangle with the top-right corner folded over. |
|
Figure 1. A summary note for a
diagram.
Figure
2. Indicating uncertainty
on a diagram.
- Describe Diagrams With a Note. In
Figure 1 you see that the name of the system, the purpose
of the diagram, and its owner is indicated.
- Set a Convention for Placement of Diagram
Descriptions.
- Left-Justify Text in Notes.
It is common practice to left-justify text in UML notes, as
you see in Figure 1 and Figure 2.
- Prefer Notes Over OCL to Indicate Constraints.
Figure 2 includes a very simple example of OCL,
{ordered, FIFO},
code that programmers may understand but few project stakeholder are likely to.
- Follow
Common Coding Conventions for OCL and ASL. The book
The Elements of Java Style describes Java coding
guidance which you can modify for OCL and ASL.
|
|
|
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 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: 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. |
|
|
I actively work with clients around the world to
improve their information technology (IT) practices as
both a mentor/coach and trainer. A full description of
what I do, and how to contact me, can be
found here.
|
|
|
