Documenting Software Architectures

Software architecture has become a widely accepted conceptual basis for the development of nontrivial software in all application areas and by organizations of all sizes. However, the treatment of architecture to date has largely concentrated on its design and, to a lesser extent, its validation. Effectively documenting an architecture is as important as crafting it; if the architecture is not understood (or worse, misunderstood), it cannot be analyzed effectively or meet its goal as the unifying vision for system and software development. Documentation-based architecture strategies stop short of prescribing documentation standards.

  • How do you document architectures using well-known styles such as service-oriented, client-server, multi-tiered, layered, and so forth?
  • What are effective architecture documentation guidelines?
  • How do you represent architectural elements and the relations among them?
  • How do you document interface semantics and architectural rationale?
  • How do you provide relevant architectural information to important stakeholders?
  • Are there templates for architecture documentation?

This two-day course provides in-depth coverage of effective software architecture documentation practices that meet the needs of the entire architecture stakeholder community. This course presents the information in the context of prevailing prescriptive models, including the Rational Unified Process (RUP), the Siemens Four Views software approach, the IEEE 1471-2000 standard, and the Unified Modeling Language (UML). The course is based on the book Documenting Software Architectures: Views and Beyond.

Who should attend?

This course is targeted at

  • software architects and software lead designers whose jobs include producing architectural documentation
  • software technical managers whose jobs include overseeing and/or managing the architecture definition process
  • software engineers who may be expected to use architecture documentation

Topics

  • principles of sound documentation
  • viewtypes, styles, and views
  • advanced concepts such as refinement, context diagrams, variability, software interfaces, and how to document interfaces
  • documenting the behavior of software elements and software systems
  • choosing relevant views
  • building a documentation package using a seven-part template

Objectives

This course shows software architects how to produce a comprehensive documentation package for a software architecture that is useful to stakeholders. After attending this course, participants will have a better understanding of
  • the basic principles of sound technical documentation
  • a stakeholder- and view-based approach to documenting software architectures
  • which views are available for documenting an architecture
  • how to choose the set of views that will be most valuable to the architecture's community of stakeholders
  • the information needed to document a view
  • how to use formal and informal notations (including UML) to represent elements and relations in a view
  • how to document a software interface and software behavior
  • the information needed to document information that applies across views

Prerequisites

Before registering for this course, participants must

  • have experience in designing and developing software-intensive systems
  • understand the basic concepts of software architecture. If desired, they can gain this understanding by completing the Software Architecture: Principles and Practices course, which is available as instructor-led classroom training and as eLearning

Materials

Participants receive a copy of the lecture slides, exercises, and the book Documenting Software Architectures: Views and Beyond.

Schedule

This 2-day course meets at the following times:
Days 1-2, 8:30 a.m. - 5:00 p.m. (U.S. locations)
Days 1-2, 9:00 a.m. - 5:30 p.m. (non-U.S. locations)

Course Details

Course Fees [USD]

U.S. Industry: $1500

U.S. Government/Academic: $1200

International: $2250

Please select a course offering then click REGISTER.
 

Dates

May 12 - 13, 2015 (SEI, Pittsburgh, PA)

 
This course may be offered by special arrangement at customer sites.

For More Information

E-mail: course-info@sei.cmu.edu
Phone: 412-268-7622


Help us improve

Visitor feedback helps us continually improve our site.

Please tell us what you
think with this short
(< 5 minute) survey.