Software Architecture Documentation (SAD)

Page tree

Versions Compared

Old Version 2

changes.mady.by.user Unknown User (tmarshall)

Saved on

compared with

New Version 3

changes.mady.by.user Unknown User (tmarshall)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The name of the view should be included in the page name

Contents

Primary Presentation

Element Catalog

Variability Guide

Other Information

Related Views

Anchor
primary
primary
Primary Presentation

  • Is usually graphical
  • Should include a key that explains the notation
  • Shows elements and relations among them
  • Shows the information you want to convey about the view first
  • Should identify elements that are external to scope of the view
    • If external entities are not clearly marked in the diagram, consider adding a context diagram

Anchor
element
element
Element Catalog

  • Explains elements depicted in primary presentation and their properties
  • Is usually a table with element name and textual description
  • May contain interface documentation
  • May contain behavior documentation

Anchor
variability
variability
Variability Guide

  • Points where system can be parameterized or reconfigured. Examples:
    • Number of instances in a pool
    • Support for plug-ins or add-ons
    • Support for different versions of OS, database server or runtime environment
  • Maybe the view is a reference architecture
    • Provide guidelines to instantiate it

Anchor
other
other
Other Information

  • Description and rationale for important design decisions (including relevant rejected alternatives)
  • Results of analysis, prototypes and experiments
  • Context diagram

Anchor
related
related
Related Views

  • Relation (Parent, Refinement, Common elements, etc). Name of view and a link to it.

It is recommended to have a link back to the main page of the SAD. It is assumed that the parent view is refered referred to in the Related Views section.

...