blob: 567f11175d90dd5c4a42dd64b4100e291251cda2 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<org.eclipse.epf.uma:ContentDescription xmi:version="2.0" xmlns:xmi="" xmlns:org.eclipse.epf.uma="" epf:version="1.0.0" xmi:id="-OcMsciNn-UtD9fTHj26LGA" name="new_guideline,_34jWsLcIEduRNaXpzCOLXQ" guid="-OcMsciNn-UtD9fTHj26LGA" changeDate="2007-02-07T16:14:24.390-0800">
Model key perspectives
Modeling helps raise the level of abstraction because you simplify complex ideas and represent them visually, as
illustrations. Good models can convey information that helps the team visualize, specify, construct, and document
software. The Unified Modeling Language (UML) provides an industry-standard approach to software modeling.
When applying this strategy, you can use various techniques:
&lt;strong&gt;Identify the key perspectives:&lt;/strong&gt; Focus on modeling the things that count. Few (if any) projects
benefit from modeling the entire design to a great level of detail. Make sure that you understand why you are
modeling something and who will benefit.
&lt;strong&gt;Communicate key architectural perspectives:&lt;/strong&gt; Even if you choose to model very little&amp;nbsp;of your
design, it is often advantageous to produce diagrams that communicate the key architectural aspects of the system.
Conveying the &quot;big picture&quot; to the rest of the team helps them understand the overall approach and develop cohesive
&lt;strong&gt;Sketch the design:&lt;/strong&gt; Not all models need to be detailed completely and presented in a software
modeling tool. It is often perfectly acceptable (if not desirable) to produce hand-drawn sketches on paper or on a
whiteboard when you are exploring and communicating the architecture and design with your team. You can use a
digital camera or an electronic whiteboard to capture these diagrams and share them. For many small projects, this
is often all you need. See &lt;a href=&quot;;&gt;;/a&gt; for more
&lt;strong&gt;Use a modeling tool as needed&lt;/strong&gt;:&amp;nbsp;If the team members are changing models throughout the
project, sharing patterns/structure, debugging design, describing behavior, etc., then static photos or paper will
become difficult to work with. The team may want to capture design in a software modeling tool. Other than
communicating the design to the team, another benefit of a such a tool is the&amp;nbsp;generation of structural code
from the models. Many software development tools allow you to view the code as models, making it easier to
comprehend static and dynamic aspects of a complex code base.
&lt;strong&gt;Agree on a standard notation:&lt;/strong&gt; In a team environment, it is important that others can understand
your diagrams without much explanation. Choosing a standard notation enables others to quickly comprehend your
diagrams without ambiguity. The Unified Modeling Language is an example of a widely understood notation.