.NODE

Summary Checklist

  • A complete architecture documentation package consists of a set of views, along with documentation of the information that applies to more than one view.
  • The package can consist of one document, a few, or many.
  • A view packet includes a primary presentationusually graphical, including a keyand supporting documentation that explains the primary presentation.
  • Supporting documentation in a view packet includes an element catalog, a context diagram, a variability guide, architecture background, other information, and relationship to other view packets.
  • Documentation beyond views consists of a documentation roadmap, a view template, a system overview, mapping between views, a directory, a project glossary and acronym list, and rationale.
  • Document the views, and documentation beyond views, using the templates in this chapter (tailored for your own use if necessary).
  • Document the mapping between views by using a table showing how elements of one view correspond to elements of another.
  • Document the rationale behind a design decision if it seems nonobvious, is the source of questions, is critical, or has widespread effect.
  • Rationale for a design decision should include relevant constraints, rejected alternatives, ramifications of the decision, and evidence that the decision was the correct one.
  • Review documentation for fitness of purpose, using the technique of active design reviews.

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

show all menu





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