Software Engineering Institute | Carnegie Mellon University
Software Engineering Institute | Carnegie Mellon University

Digital Library

Javascript is currently disabled for your browser. For an optimal search experience, please enable javascript.

Advanced Search

Basic Search

Content Type

Topics

Publication Date

Technical Note

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.

  • Download

Cite This Report

SEI

Bachmann, Felix; Bass, Len; Clements, Paul; Garlan, David; Ivers, James; Little, M.; Nord, Robert; & Stafford, Judith. Documenting Software Architecture: Documenting Interfaces (CMU/SEI-2002-TN-015). Software Engineering Institute, Carnegie Mellon University, 2002. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5939

IEEE

Bachmann. Felix, Bass. Len, Clements. Paul, Garlan. David, Ivers. James, Little. M., Nord. Robert, and Stafford. Judith, "Documenting Software Architecture: Documenting Interfaces," Software Engineering Institute, Carnegie Mellon University, Pittsburgh, Pennsylvania, Technical Note CMU/SEI-2002-TN-015, 2002. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5939

APA

Bachmann, Felix., Bass, Len., Clements, Paul., Garlan, David., Ivers, James., Little, M.., Nord, Robert., & Stafford, Judith. (2002). Documenting Software Architecture: Documenting Interfaces (CMU/SEI-2002-TN-015). Retrieved December 22, 2014, from the Software Engineering Institute, Carnegie Mellon University website: http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5939

CHI

Felix Bachmann, Len Bass, Paul Clements, David Garlan, James Ivers, M. Little, Robert Nord, & Judith Stafford. Documenting Software Architecture: Documenting Interfaces (CMU/SEI-2002-TN-015). Pittsburgh, PA: Software Engineering Institute, Carnegie Mellon University, 2002. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5939

MLA

Bachmann, Felix., Bass, Len., Clements, Paul., Garlan, David., Ivers, James., Little, M.., Nord, Robert., & Stafford, Judith. 2002. Documenting Software Architecture: Documenting Interfaces (Technical Report CMU/SEI-2002-TN-015). Pittsburgh: Software Engineering Institute, Carnegie Mellon University. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5939