blob: 4871651ec8a0078849de89681c0a1a6ecd899564 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C/DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<!-- VERSION rmc:7.1.0 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<!-- START NON-TRANSLATABLE -->
<title>openup&amp;#92;workproducts&amp;#92;&amp;#92;design.xmi</title>
</head>
<!-- WARNING: do not modify the generated comments in this file below this line. They are used as markers for the import process. -->
<body>
Element Name: design.xmi<br/><br/>
<!-- END NON-TRANSLATABLE -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: presentationName<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:presentationName,_0WuL8slgEdmt3adZL5Dmdw CRC: 3403898630 -->Design<!-- END:presentationName,_0WuL8slgEdmt3adZL5Dmdw -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: briefDescription<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:briefDescription,_0WuL8slgEdmt3adZL5Dmdw CRC: 2998401465 -->This artifact describes the realization of required system functionality in terms of components and serves as an abstraction of the source code.<!-- END:briefDescription,_0WuL8slgEdmt3adZL5Dmdw -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: mainDescription<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:mainDescription,_zxB-QKYcEdmvhNXG0Oc2uA CRC: 304156181 --><p>
This product can describe multiple static and dynamic views of the system for examination. Although various views may
focus on divergent, seemingly independent issues of how the system will be put together and work, they should fit
together without contradiction.
</p>
<p>
It describes the elements that will make up the implemented system. It communicates abstractions of particular portions
of the implementation and can describe an&nbsp;encapsulated subsystem, a high-level analysis of the system, a view of
the system in only one context, or other perspectives that explain a solution to a specific problem that needs to be
communicated.
</p><!-- END:mainDescription,_zxB-QKYcEdmvhNXG0Oc2uA -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: purpose<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:purpose,_zxB-QKYcEdmvhNXG0Oc2uA CRC: 3846250428 --><p>
Describe the&nbsp;elements of the system&nbsp;so&nbsp;they can be examined and understood in ways not&nbsp;possible by
reading the source code.
</p><!-- END:purpose,_zxB-QKYcEdmvhNXG0Oc2uA -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: impactOfNotHaving<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:impactOfNotHaving,_zxB-QKYcEdmvhNXG0Oc2uA CRC: 4157366389 --><p>
Implementation will proceed with fine-grained, inconsistent tactical decisions that lead to poor-quality software.
</p><!-- END:impactOfNotHaving,_zxB-QKYcEdmvhNXG0Oc2uA -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: reasonsForNotNeeding<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:reasonsForNotNeeding,_zxB-QKYcEdmvhNXG0Oc2uA CRC: 778658421 -->Some representation of the design will always be necessary. In circumstances where a project involves applying
well-understood, existing strategies for architecture and design, it is possible that you will not need a <em>new</em>
design. In those cases, you can simply refer to some existing design.<!-- END:reasonsForNotNeeding,_zxB-QKYcEdmvhNXG0Oc2uA -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: representationOptions<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:representationOptions,_zxB-QKYcEdmvhNXG0Oc2uA CRC: 547625323 --><p>
It is important that the author of this work product be able to analyze key decisions about the structure and behavior
of the system and communicate them to other collaborators. It is also important that these decisions can be
communicated at various levels of abstraction and granularity. Some aspects of the design can be represented by source
code, possibly with some extra annotations. But more abstract representations of the design will be at a higher-level
than source code.
</p>
<p>
The more abstract representation could use various representation options. UML could be used either strictly or
informally; it is a preferred notation based on its rich semantics and broad usage in the industry. Other techniques
could be used to communicate the design. Or the design could use a mix of techniques as applicable.
</p>
<p>
Whether you record these representations on a white board or use a formal tool is not governed by this process. But any
representation, whether characterized as formal or informal, should unambiguously communicate the technical decisions
embodied by the design.
</p><!-- END:representationOptions,_zxB-QKYcEdmvhNXG0Oc2uA -->
</body>
</html>