Home > Articles > Software Development & Management > Architecture and Design

  • Print
  • + Share This
This chapter is from the book

P.3 Architecture Views

Perhaps the most important concept associated with software architecture documentation is that of the view. A software architecture is a complex entity that cannot be described in a simple one-dimensional fashion. Our analogy with the bird wing proves illuminating. If you are interested in any but the most superficial understanding, then no single rendition of a bird wing will do. Instead, you need many: feathers, skeleton, circulation, muscular views, and many others. Which of these views is the “architecture” of the wing? None of them. Which views convey the architecture? All of them.

In this book, we use the concept of views to give us the most fundamental principle of architecture documentation, illustrated in Figure P.1:

  • Documenting an architecture is a matter of documenting the relevant views and then adding documentation that applies to more than one view.
Figure P.1

Figure P.1 A documentation package for a software architecture can be composed of one or more view documents and documentation that explains how the views relate to one another, introduces the package to its readers, and guides them through it.

What are the relevant views? It depends on your goals. As we saw previously, architecture documentation can serve many purposes: a mission statement for implementers, a basis for analysis, the specification for automatic code generation, the starting point for system understanding and asset recovery, or the blueprint for project planning.

Different views also expose different quality attributes to different degrees. Therefore, the quality attributes that are of most concern to you and the other stakeholders in the system’s development will affect the choice of what views to document. For instance, a layered view will tell you about your system’s portability, a deployment view will let you reason about your system’s performance and reliability, and so forth.

Different views support different goals and uses. This is fundamentally why we do not advocate a particular view or collection of views. The views you should document depend on the uses you expect to make of the documentation. Different views will highlight different system elements and/or relations.

It may be disconcerting that no single view can fully represent an architecture. Additionally, it feels somehow inadequate to see the system only through discrete, multiple views that may or may not relate to one another in any straightforward way. The essence of architecture is the suppression of information not necessary to the task at hand, and so it is somehow fitting that the very nature of architecture is such that it never presents its whole self to us but only a facet or two at a time. This is its strength: Each view emphasizes certain aspects of the system while deemphasizing or ignoring other aspects, all in the interest of making the problem at hand tractable. Nevertheless, no one of these individual views adequately documents the software architecture for the system. That is accomplished by the complete set of views along with information that transcends them.

The documentation for a view contains

  • A primary presentation, usually graphical, that depicts the primary elements and relations of the view
  • An element catalog that explains and defines the elements shown in the view and lists their properties
  • A specification of the elements’ interfaces and behavior
  • A variability guide explaining any built-in mechanisms available for tailoring the architecture
  • Rationale and design information

The documentation that applies to all of the views contains

  • An introduction to the entire package, including a reader’s guide that helps a stakeholder find a desired piece of information quickly
  • Information describing how the views relate to one another, and to the system as a whole
  • Constraints and rationale for the overall architecture
  • Such management information as may be required to effectively maintain the whole package
  • + Share This
  • 🔖 Save To Your Account