Documenting Software
Architectures
|
|
|
John D. McGregor |
|
Clemson University |
View
|
|
|
A description of an architecture from a
specific perspective. |
|
|
|
All the wiring in a building is a view
of the building from the perspective of the electrician. |
|
|
|
Need multiple views |
|
|
|
Need coordination among views |
Documented View
|
|
|
Primary Presentation |
|
Element Catalog |
|
Context Diagram |
|
Variability Guide |
|
Architecture Background |
|
Glossary of Terms |
|
Other information |
Element Interface
Specification
|
|
|
Element Identity |
|
Resources provided |
|
Locally defined data types |
|
Exception definitions |
|
Variability provided |
|
Quality attribute characteristics |
|
Element requirements |
|
Rationale and design issues |
|
Usage guide |
Documentation across
views
|
|
|
How the document is organized |
|
view catalog |
|
view template |
|
|
|
What the architecture is |
|
system overview |
|
mapping between views |
|
list of elements and where they
appear |
|
project glossary |
|
|
|
Why the architecture is the way it is |
|
rationale |