Artifact: Software Architecture Document










var backPath = './../../';
var imgPath = './../../images/';
var nodeInfo=[{view: "view:_LVCagP5WEdmAzesbYywanQ", path: ["_LVCagP5WEdmAzesbYywanQ", "_zRigkAILEdq-_NKqZM1EhA", "_qwxC8N7YEdmjRZts2c4ZjQ", "{4AC346F0-E6FC-4D2C-8410-2EDF8DDDC91D}", "{6F49641A-ED10-47B5-9E5D-3F90A6BF3006}"]}, {view: "view:_LVCagP5WEdmAzesbYywanQ", path: ["_LVCagP5WEdmAzesbYywanQ", "_zRigkAILEdq-_NKqZM1EhA", "_QV4x0AISEdqTna4sZVFRow", "_kjFBYN7HEdm8G6yT7-Wdqw", "{6F49641A-ED10-47B5-9E5D-3F90A6BF3006}"]}, {view: "view:_FCx1oN7CEdmsEI4YDGX2ag", path: ["_FCx1oN7CEdmsEI4YDGX2ag", "_f6_YwN7DEdmsEI4YDGX2ag", "_qwxC8N7YEdmjRZts2c4ZjQ", "{4AC346F0-E6FC-4D2C-8410-2EDF8DDDC91D}", "{6F49641A-ED10-47B5-9E5D-3F90A6BF3006}"]}, {view: "view:_FCx1oN7CEdmsEI4YDGX2ag", path: ["_FCx1oN7CEdmsEI4YDGX2ag", "_Jvt1cAIaEdqEutyfYo0quQ", "_EOvXUN7HEdm8G6yT7-Wdqw", "_kjFBYN7HEdm8G6yT7-Wdqw", "{6F49641A-ED10-47B5-9E5D-3F90A6BF3006}"]}, {view: "view:_FCx1oN7CEdmsEI4YDGX2ag", path: ["_FCx1oN7CEdmsEI4YDGX2ag", "_Jvt1cAIaEdqEutyfYo0quQ", "_jijhYAIaEdqEutyfYo0quQ", "_3aJCcN7REdmjRZts2c4ZjQ", "{6F49641A-ED10-47B5-9E5D-3F90A6BF3006}"]}];
contentPage.preload(imgPath, backPath, nodeInfo, '', false, false, false);










Artifact: Software Architecture Document















This work product provides a comprehensive architectural overview of the system, using a number of different architectural views to depict different aspects of the system.


Domains: Analysis and Design
Work Product Kinds: Specification






Purpose



The software architecture document provides a comprehensive overview of the architecture of the software system. It serves as a communication medium between the software architect and other project team members regarding architecturally significant decisions which have been made on the project.



Relationships



RolesResponsible:



Software Architect


Modified By:



Software Architect





TasksInput To:



Construct Architectural Proof-of-Concept


Describe Distribution


Describe the Run-time Architecture


Incorporate Existing Design Elements


Prioritize Use Cases


Review the Architecture





Architectural Analysis


Define Test Approach


Develop Iteration Plan


Identify Design Elements


Identify Design Mechanisms


Identify Test Ideas


Implement Design Elements


Use-Case Analysis


Output From:



Architectural Analysis


Describe Distribution


Describe the Run-time Architecture


Identify Design Mechanisms


Incorporate Existing Design Elements


Prioritize Use Cases


Structure the Implementation Model





Process Usage


Analysis & Design
 > 
Define a Candidate Architecture
 > 
Software Architecture Document


Analysis & Design
 > 
Perform Architectural Synthesis
 > 
Software Architecture Document


Analysis & Design
 > 
Refine the Architecture
 > 
Software Architecture Document


Analysis & Design
 > 
Analyze Behavior
 > 
Software Architecture Document


Implementation
 > 
Implement Components
 > 
Software Architecture Document


Implementation
 > 
Structure the Implementation Model
 > 
Software Architecture Document


Project Management
 > 
Plan for Next Iteration
 > 
Software Architecture Document


Project Management
 > 
Plan Remainder of Initial Iteration
 > 
Software Architecture Document


Requirements
 > 
Manage the Scope of the System
 > 
Software Architecture Document


Test
 > 
Verify Test Approach
 > 
Software Architecture Document


Test
 > 
Improve Test Assets
 > 
Software Architecture Document


Test
 > 
Define Evaluation Mission
 > 
Software Architecture Document


Test
 > 
Test and Evaluate
 > 
Software Architecture Document






Illustrations



Templates


Software Architecture Document (Informal)





Examples


CSPS Software Architecture Document - Elaboration Phase






Tailoring



Representation OptionsUML Representation: A set of relevant architectural views: Use-Case, Logical, Process, Deployment, Implementation, Data. You should adjust the outline of the Software Architecture Document to suit the nature of your software: Some of the architectural views may be irrelevant: The Deployment View is not needed for single-CPU systems. The Process View is not needed if the system uses only a single thread of control. The Data View is not needed unless object persistence is a significant aspect of the system and the persistence mechanism requires a mapping between persistent and non-persistent objects. Some specific aspects of the software may require their own section; for example, aspects related to data management or usability issues. You may need additional appendices to explain certain aspects, such as the rationale of certain critical choices together with the solutions that have been eliminated, or to define acronyms or abbreviations, or present general design principles. The order of the various sections may vary, depending on the system's stakeholders and their focus or interest. The advantages and disadvantages of each architectural view follow: Use-Case View This view is mandatory. Logical View This view is mandatory. Process View This view is optional. Use this view only if the system has more than one thread of control, and the separate threads interact or are dependent upon one another. Deployment View This view is optional. Use this view only if the system is distributed across more than one node. Even in these cases, only use the deployment view where the distribution has architectural implications. For example, in cases where there is a single server and many clients, a deployment view only needed to delineate the responsibilities of the server and the clients as a class of nodes; there is no need to show every client node if they all have the same capabilities. Implementation View This view is optional. Use this view only in cases where the implementation is not strictly driven from the design, i.e. where there is a different distribution of responsibilities between corresponding packages in the Design and Implementation models. If the packaging of the design and implementation models are identical, this view can be omitted. Data View This view is optional. Use this view only if persistence is a significant aspect of the system and the translation from the Design Model to the Data Model is not done automatically by the persistence mechanism.



More Information



Checklists


Software Architecture Document





Concepts


Deployment View


Implementation View


Logical View


Process View


Software Architecture


Use-Case View





Guidelines


Software Architecture Document








©  Copyright IBM Corp. 1987, 2006.  All Rights Reserved.







contentPage.onload();