Where to Document Behavior

Architects document behavior to show how an element behaves when stimulated in a particular way or to show how an ensemble of elementsup to and including the whole systemreact with one another. In an architecture documentation package, where behavior is shown depends on what exactly is being shown. For example, in a view's supporting documentation, behavior

  • Has its own section in the element catalog. Here, the behavior of the element is documented.
  • Can be part of an element's interface documentation. The semantics of a resource on an element's interface can include the element's externally visible behavior that occurs as a result of using the resource. Or, in the usage guide section of an interface document, behavior can be used to explain the effects of a particular usage pattern, that is, a particular sequence of resources used.
  • Can be used to fill in the design background section, which includes results of analysis. Behavior is often a basis for analysis, and the behaviors that were used to analyze the system for correctness or other quality attributes can be recorded here.

In the documentation that applies beyond views, the rationale for why the architecture satisfies its requirements can include behavioral documentation as part of the architect's justification.

Software Architectures and Documentation

Part I. Software Architecture Viewtypes and Styles

The Module Viewtype

Styles of the Module Viewtype

The Component-and-Connector Viewtype

Styles of the Component-and-Connector Viewtype

The Allocation Viewtype and Styles

Part II. Software Architecture Documentation in Practice

Advanced Concepts

Documenting Software Interfaces

Documenting Behavior

Choosing the Views

Building the Documentation Package

Other Views and Beyond

Rationale, Background, and Design Constraints

References



Documenting Software Architectures(c) Views and Beyond
Documenting Software Architectures: Views and Beyond
ISBN: 0201703726
EAN: 2147483647
Year: 2005
Pages: 152

Similar book on Amazon

Flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net