Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.64 KB

architecture_view.md

File metadata and controls

65 lines (44 loc) · 2.64 KB
Raw

Architecture View: Template

  • Briefly describe the architecture view here. Rename "Template" above to give it a name.

Table of Contents:

  1. Primary Presentation
  2. Context Diagram
  3. Element Catalog
  4. Variability Guide
  5. Rationale
  6. Related Views

Primary Presentation

  • Add here the diagram (or non-graphical representation) that shows the elements and relations in this view
  • Indicate the language or notation being used
  • If it's not a standard notation such as UML, add a notation key
XX View of the System
Figure 1. X View for Y.

Context Diagram

  • Add here a context diagram that graphically shows the scope of the part of the system represented by this view
  • A context diagram typically shows the part of the system as a single, distinguished box in the middle surrounded by other boxes that are the external entities
  • Lines show the relations between the part of the system and the external entities
Context for the Y
Figure 3. Software System Context Diagram for Z

Element Catalog

  • This section can be organized as a dictionary where each entry is an element of the Primary Presentation
  • For each element, provide additional information and properties that the readers would need that would not fit in the Primary Presentation
  • Optionally, you can add interface specifications and behavior diagrams (e.g., UML sequence diagrams, statecharts)

Variability Guide

  • Describe here any variability mechanisms used in the portion of the system shown in this view, along with how and when (build time, deploy time, run time) those mechanisms may be exercised
  • Examples of variability include:
    • optional components (e.g., plug-ins, add-ons)
    • configurable replication of components and connectors selection among different implementations of an element or different vendors parameterized values set in build flags, .properties files, .ini files, or other config files

Rationale

  • Describe here the rationale for any significant design decisions whose scope is limited to this view
  • Also describe any significant rejected alternatives
  • This section may also indicate assumptions, constraints, results of analysis and experiments, and architecturally significant requirements that affect the view

Related Views

  • Add here links to the parent view and to any children (i.e., refined) views, if they exist.