Documenting Software Architecture: Documenting Interfaces
journal contributionposted on 01.08.2009 by Felix Bachmann, Len Bass, Paul C Clements, David Garlan, James Ivers, Reed Little, Robert Nord, Judith Stafford
Any type of content formally published in an academic journal, usually following a peer-review process.
This is the fourth in a series of Software Engineering Institute 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.