Skip to Main Content
Documenting Software Architectures: Views and Beyond, Second Edition
book

Documenting Software Architectures: Views and Beyond, Second Edition

by Paul Clements, Felix Bachmann, Len Bass, David Garlan, James Ivers, Reed Little, Paulo Merson, Robert Nord, Judith Stafford
October 2010
Intermediate to advanced content levelIntermediate to advanced
592 pages
16h 15m
English
Addison-Wesley Professional
Content preview from Documenting Software Architectures: Views and Beyond, Second Edition

7. Documenting Software Interfaces

image

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 ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

Software Architecture: The Hard Parts

Software Architecture: The Hard Parts

Neal Ford, Mark Richards, Pramod Sadalage, Zhamak Dehghani
Software Architecture: The Hard Parts

Software Architecture: The Hard Parts

Neal Ford, Mark Richards, Pramod Sadalage, Zhamak Dehghani
Software Architecture in Practice, 4th Edition

Software Architecture in Practice, 4th Edition

Len Bass, Paul Clements, Rick Kazman

Publisher Resources

ISBN: 9780132488617Purchase book