Documenting Software Architecture: Documenting Interfaces
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.
This report is related to the following area(s) of work:
Software ArchitectureTechnical Note
CMU/SEI-2002-TN-015
June 2002
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://www.sei.cmu.edu/library/abstracts/reports/02tn015.cfm
IEEE:
F. Bachmann, L. Bass, P. Clements, D. Garlan, J. Ivers, M. Little, R. Nord, and J. Stafford, "Documenting Software Architecture: Documenting Interfaces," Software Engineering Institute, Carnegie Mellon University, Pittsburgh, Pennsylvania, Technical Note CMU/SEI-2002-TN-015, 2002. http://www.sei.cmu.edu/library/abstracts/reports/02tn015.cfm
APA:
Bachmann, F., Bass, L., Clements, P., Garlan, D., Ivers, J., Little, M., Nord, R., & Stafford, J. (2002). Documenting Software Architecture: Documenting Interfaces (CMU/SEI-2002-TN-015). Retrieved June 19, 2013, from the Software Engineering Institute, Carnegie Mellon University website: http://www.sei.cmu.edu/library/abstracts/reports/02tn015.cfm
CHI:
Bachmann, Felix, Len Bass, Paul Clements, David Garlan, James Ivers, M. Little, Robert Nord, and Judith Stafford. Documenting Software Architecture: Documenting Interfaces (CMU/SEI-2002-TN-015). Pittsburgh, PA: Software Engineering Institute, Carnegie Mellon University, 2002. http://www.sei.cmu.edu/library/abstracts/reports/02tn015.cfm
MLA:
Bachmann, F., Bass, L., Clements, P., Garlan, D., Ivers, J., Little, M., Nord, R., & Stafford, J. 2002. Documenting Software Architecture: Documenting Interfaces (Technical Report CMU/SEI-2002-TN-015). Pittsburgh: Software Engineering Institute, Carnegie Mellon University. http://www.sei.cmu.edu/library/abstracts/reports/02tn015.cfm
Find Us Here
Share This Page
For more information
