Documenting Software Architecture: Documenting Interfaces

← Back to document page

Documenting Software Architecture: Documenting InterfacesFelix BachmannLen BassPaul ClementsDavid GarlanJames IversReed LittleRobert NordJudith StaffordJune 2002TECHNICAL NOTECMU/SEI-2002-TN-015Pittsburgh, PA 15213-3890Documenting Software Architecture: Documenting InterfacesCMU/SEI-2002-TN-015Felix BachmannLen BassPaul ClementsDavid GarlanJames IversReed LittleRobert NordJudith StaffordUnlimited distribution subject to the 2002Architecture Tradeoff Analysis InitiativeThe Software Engineering Institute is a federally funded research and development center sponsored by the Department of 2002 by Carnegie Mellon WARRANTYTHIS CARNEGIE MELLON UNIVERSITY AND Software ENGINEERING INSTITUTE MATERIAL IS FURNISHED ON AN AS-IS BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL.

interface information to document. (Whether an architect chooses to document an ele-ment’s interface separately in different views or in a single treatment is a packaging issue. An interface that transcends views can be documented in the package of documentation that applies to more than one view.) • Interfaces are two way.

  Document, Interface