Software Architecture Documentation

Author: Clements
Publisher:
Publish Date: 2003-11-01
Features: Thirteenth Annual Book Efficiency Award from the U.S. "Software Development" Magazine
This book consists of an introduction and two parts. The introduction introduces the necessary concepts and terminology used in the rest of the book, explores the use of software architecture documentation and the reasons for its importance, and defines architecture view types, styles, and views, which are the foundation of the documentation scheme introduced in this book. Additionally, the introduction includes seven basic rules for proper documentation.
Part I "Software Architecture View Types and Styles" introduces the basic tools for documenting software architecture: view types. This part introduces three fundamental view types: module view types, component and connector view types, and allocation view types. Each view type includes multiple architecture styles, which are refinements of the view types. This part specifically describes these styles.
Part II "Software Architecture Documentation Practice" focuses on complete architecture documentation packages, the creation of which is the responsibility of an excellent software architect. Part II complements the content laid out in Part I. This book is primarily intended for software architects and technical writers responsible for documenting software architecture for projects, as well as those who wish to learn and utilize such documentation.
This book consists of an introduction and two parts. The introduction introduces the necessary concepts and terminology used in the rest of the book, defines architecture view types, styles, and views, which are the foundation of the documentation scheme introduced in this book. Part I introduces three fundamental view types: module view types, component and connector view types, and allocation view types. Part II focuses on complete architecture documentation packages, which complements the content laid out in Part I. This book is primarily intended for software architects and technical writers responsible for documenting software architecture for projects, as well as those who wish to learn and utilize such documentation.