Documenting Software Architectures: Recommendations for Industrial Practice

Abstract

An important issue for software system development is the documentation of architecture designs. In this report, we describe techniques for the architectural documentation of software-based systems in the context of development processes that use UML for software design. The architectural documentation is organized in four kinds of views: problem domain view, code view, run-time view and deployment view. We examine JavaPhone(TM) as a case study to illustrate the approach: what kinds of information are provided in each kind of view, what forms of notation should be used, what are their limitations, and what uses can be made of this documentation.

Open PDF

Document Details

Document Type
Technical Report
Publication Date
Oct 01, 2000
Accession Number
ADA385125

Entities

People

  • David Garlan
  • Joao P. Sousa

Organizations

  • Carnegie Mellon University

Tags

Communities of Interest

  • C4I
  • Energy and Power Technologies
  • Engineered Resilient Systems

DTIC Thesaurus Topics

  • Boundaries
  • Case Studies
  • Communication Systems
  • Computer Programming
  • Computer Science
  • Computers
  • Connectors
  • Data Transmission
  • Digital Communications
  • Language
  • Notation
  • Physical Properties
  • Reliability
  • Software Design
  • Software Development
  • Terminals
  • Time Intervals

Fields of Study

  • Computer science
  • Engineering

Readers

  • Software Engineering.