| <?xml version="1.0" encoding="UTF-8"?> |
| <org.eclipse.epf.uma:GuidanceDescription xmi:version="2.0" |
| xmlns:xmi="http://www.omg.org/XMI" xmlns:org.eclipse.epf.uma="http://www.eclipse.org/epf/uma/1.0.4/uma.ecore" |
| xmlns:epf="http://www.eclipse.org/epf" epf:version="1.2.0" xmi:id="-giTBOvJczHXweRzBQEo-7A" |
| name="new_template,_EOPcMAMUEdylNddAObilIA" guid="-giTBOvJczHXweRzBQEo-7A" changeDate="2007-06-22T13:44:44.614-0400"> |
| <mainDescription><p>
 |
| This template describes how the design can be organized to be understood from multiple perspectives. It also provides
 |
| some suggestions for how patterns and descriptions of small reusable interactions can be used to minimize redundancy.
 |
| </p>
 |
| <p>
 |
| It is important that design not be thought of as "a document". Design information that is worth keeping for some
 |
| duration will have to have some long-lived form. But that form might be as a repository in some visual modeling tool,
 |
| or as subdirectories of white-board diagrams captured with a digital camera, or as an actual document that provides
 |
| some structure to images taken from a myriad of sources.
 |
| </p>
 |
| <p>
 |
| This template describes the information that should be conveyed. Typically the information should be conveyed
 |
| graphically (either with UML or some other unambiguous notation) or at least at some abstract level textually. This can
 |
| be enhanced with code examples, but it is suggested that the design not be rendered solely at the code level.
 |
| </p>
 |
| <p>
 |
| The structure of the design is suggested in this template.
 |
| </p>
 |
| <h3>
 |
| Design Structure
 |
| </h3>
 |
| <p style="COLOR: #0000ff">
 |
| [ Describe the design from the highest level -- this is commonly done with a diagram that shows a layered architecture.
 |
| ]
 |
| </p>
 |
| <h3>
 |
| Subsystems
 |
| </h3>
 |
| <h4>
 |
| [Sub-system1]
 |
| </h4>
 |
| <p style="COLOR: #0000ff">
 |
| [ Describe the design of a portion of the system (package, component, etc.). The design should capture both static and
 |
| dynamic perspectives.
 |
| </p>
 |
| <p style="COLOR: #0000ff">
 |
| When capturing dynamic walkthroughs of behavior, look for reusable chunks of behavior that can be referenced to
 |
| simplify the design of the use-case realizations.
 |
| </p>
 |
| <p style="COLOR: #0000ff">
 |
| This section can be hierarchically broken down into lower-level subsections to describe lower-level, encapsulated
 |
| sub-systems. ]
 |
| </p>
 |
| <h3>
 |
| Patterns
 |
| </h3>
 |
| <h4>
 |
| [Pattern1]
 |
| </h4>
 |
| <h5>
 |
| Overview
 |
| </h5>
 |
| <p style="COLOR: #0000ff">
 |
| [ Provide an overview of the pattern textually in some consistent form. The overview of a pattern can include the
 |
| intent, motivation, and applicability. ]
 |
| </p>
 |
| <h5>
 |
| Structure
 |
| </h5>
 |
| <p style="COLOR: #0000ff">
 |
| [ Describe the pattern from a static perspective. Include all the participants, how they relate to one another, and
 |
| call out the&nbsp;relevant data and behavior. ]
 |
| </p>
 |
| <h5>
 |
| Behavior
 |
| </h5>
 |
| <p style="COLOR: #0000ff">
 |
| [ Describe the pattern from a dynamic perspective. Walk through how the participants collaborate to support various
 |
| scenarios. ]
 |
| </p>
 |
| <h5>
 |
| Example
 |
| </h5>
 |
| <p style="COLOR: #0000ff">
 |
| [ Often a pattern is best communicated with an additional concrete example. ]
 |
| </p>
 |
| <h3>
 |
| Use-Case Realizations
 |
| </h3>
 |
| <h4>
 |
| [Realization1]
 |
| </h4>
 |
| <h5>
 |
| View of Participants
 |
| </h5>
 |
| <p style="COLOR: #0000ff">
 |
| [ Describe the participating design elements from a static perspective giving details such as behavior, relations, and
 |
| attributes relevant to this use-case realization. ]
 |
| </p>
 |
| <h5>
 |
| Basic Scenario
 |
| </h5>
 |
| <p style="COLOR: #0000ff">
 |
| [ For the main flow, describe how instances of the design elements collaborate to realize the use case. If using UML,
 |
| this can be done with collaboration diagrams (sequence or communication). ]
 |
| </p>
 |
| <h5>
 |
| Additional Scenarios
 |
| </h5>
 |
| <p style="COLOR: #0000ff">
 |
| [ For other scenarios that must be described to convey an appropriate amount of information on how the use-case
 |
| behavior will be realized, describe how instances of the design elements collaborate to realize the use case. If using
 |
| UML, this can be done with collaboration diagrams (sequence or communication). ]
 |
| </p></mainDescription> |
| </org.eclipse.epf.uma:GuidanceDescription> |
