You now have everything you need to begin building the complete documentation package. You have a repertoire of views and insights about how to document structure, behavior, and interfaces. This chapter shows you how to put it all together.
First, we return once again to our fundamental principle of documenting architectures: Documenting an architecture is a matter of documenting the relevant views and then adding documentation that applies to more than one view. Rule 4 for sound documentation, given in the Prologue, counsels us to use a standard organization for documents. Combining these two foundations, this chapter provides standard document organizations for documenting architectural views, along with the information that transcends views.
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
Documenting Software Interfaces
Choosing the Views
Building the Documentation Package
Other Views and Beyond
Rationale, Background, and Design Constraints