7. Documenting Software Interfaces
In this chapter, we look at these aspects of interface documentation:
• Standard organization
• Stakeholders
• Conveying syntactic information
• Conveying semantic information
• Examples of interface documentation
7.1 Overview
So far we have emphasized documenting architecture elements and their relations using various kinds of views. More implicitly than explicitly, we have stated that of course all those elements have interfaces through which they can interact with each other. Interfaces are supremely architectural, for without them one cannot perform analyses or system building—both activities we want to ...
Get Documenting Software Architectures: Views and Beyond, Second Edition now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
