blob: 334ad01c86789a417fe3a9d42b5bee8bbede609a [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_basic\workproducts\architecture_notebook.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: architecture_notebook.xmi<br/><br/>
<!-- END NON-TRANSLATABLE -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: presentationName<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:presentationName,_0XAf0MlgEdmt3adZL5Dmdw CRC: 814628873 -->Architecture Notebook<!-- END:presentationName,_0XAf0MlgEdmt3adZL5Dmdw -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: briefDescription<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:briefDescription,_0XAf0MlgEdmt3adZL5Dmdw CRC: 4041001655 -->The Architecture Notebook describes the blueprint for software development. It contains the rationale, assumptions, explanations and implications of the decisions that were made in forming the architecture.<!-- END:briefDescription,_0XAf0MlgEdmt3adZL5Dmdw -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: mainDescription<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:mainDescription,_H4gOYKYTEdmvhNXG0Oc2uA CRC: 2057583533 --><p>
This artifact&nbsp;is a communication vehicle that tells Developers what pieces to build, as well as how those pieces
behave and interact with each other. It determines the project structure so that managers can plan the project. It also
gives whoever must maintain and change the architecture later their first glimpse of the system; and an understanding
of the motivation behind the important technical decisions.
</p>
<p>
This artifact focuses on specific aspects of the design, concentrating on structure, essential elements, key scenarios
and those aspects that have a lasting impact on system qualities such as performance, reliability, adaptability and
cost. It defines the set of mechanisms, patterns and styles that will guide the rest of the design, assuring its
integrity.
</p>
<p>
Architectural elements make excellent units of implementation, unit testing, integration, configuration management
and&nbsp;documentation. The organisation of the architecture can also help the <a class="elementLink"
href="./../../openup_basic/roles/project_manager,_0a0o0MlgEdmt3adZL5Dmdw.html" guid="_0a0o0MlgEdmt3adZL5Dmdw">Project
Manager</a> decide on the organisation of the team.
</p><!-- END:mainDescription,_H4gOYKYTEdmvhNXG0Oc2uA -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: purpose<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:purpose,_H4gOYKYTEdmvhNXG0Oc2uA CRC: 2013104446 --><p>
To describe the essential part of the design of the system so the integrity and understandability of the system is
assured.
</p><!-- END:purpose,_H4gOYKYTEdmvhNXG0Oc2uA -->
<br/><br/><br/>
<!-- START NON-TRANSLATABLE -->
Attribute: representationOptions<br/><br/>
<!-- END NON-TRANSLATABLE -->
<!-- START:representationOptions,_H4gOYKYTEdmvhNXG0Oc2uA CRC: 3956999878 --><p>
The he architecture can be represented in many forms and from many viewpoints, depending on the needs of the project
and the preferences of the project team. The architecture can be expressed as a simple metaphor or as a comparison to a
predefined architectural style or set of styles. It may be a precise set of models or documents that describe the
various aspects of the system's key elements. Expressing it as skeletal build is another option - although this build
may need to be baselined and preserved to ensure that the essence of the system can be understood as the system grows.
</p>
<p>
It is frequently a design artifact that must be represented in a readable and accessible way. It can reference models
that describe <a class="elementLink"
href="./../../openup_basic/guidances/guidelines/architectural_view,_T9nygClEEduLGM8dfVsrKg.html"
guid="_T9nygClEEduLGM8dfVsrKg">Architectural View</a>s for communicating the architecture. A view is a representation
of a system from the perspective of a related set of concerns.&nbsp;To choose the appropriate set of
views,&nbsp;identify the Stakeholders who depend on software architecture documentation and the information that they
need.
</p>
<p>
It need not be a formal document. The essence of the architecture can often be communicated through a series of simple
diagrams on a whiteboard; or as a list of decisions. Choose the medium that best meets the needs of the project.
</p><!-- END:representationOptions,_H4gOYKYTEdmvhNXG0Oc2uA -->
</body>
</html>