Documenting Software Architecture: Documenting Interfaces

Abstract

This is the fourth in a series of SEI reports on documenting software architectures. This report details guidance for documenting the interfaces to software elements. It prescribes a standard organization (template) for recording semantic as well as syntactic information about an interface. Stakeholders of interface documentation are enumerated, available notations for specifying interfaces are described, and three examples are provided.

Open PDF

Document Details

Document Type
Technical Report
Publication Date
Jun 01, 2002
Accession Number
ADA403788

Entities

People

  • David Garlan
  • Felix H. Bachmann
  • James Ivers
  • Len Bass
  • Paul Clements

Organizations

  • Carnegie Mellon University

Tags

Communities of Interest

  • Advanced Electronics
  • Engineered Resilient Systems
  • Human Systems

DTIC Thesaurus Topics

  • Aircrafts
  • Computer Programming
  • Department Of Defense
  • Domain Specific Programming Languages
  • Engineering
  • Guidance
  • Homosexuality
  • Language
  • Notation
  • Programming Languages
  • Simulations
  • Software Design
  • Software Development
  • Standards
  • Template Patterns
  • United States
  • Xml

Fields of Study

  • Computer science
  • Engineering

Readers

  • Software Engineering.