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:
Technical Note
CMU/SEI-2002-TN-015
June 2002
