Discussion Questions


Discuss how you might use hypertext or a Web-based documentation suite to provide a custom package for each kind of architectural stakeholder.


Discuss the advantages and disadvantages of various packaging schemes: a single large document, a small number of separate documents, and a separate document for each kind of information. For a project you have in mind, which would you choose, and why? Make sure to consider configuration management concerns and stakeholder needs in your discussion. What other criteria would help you decide?


This chapter has prescribedor at least allowedcertain kinds of information that might also exist in the overall project documentation: glossary of terms, list of acronyms, and system overview. Make a case for the architecture documentation package including its own version of these things, separate from the overall project set.


Imagine the sample documentation given in Appendix A was online. Mark all the places where hypertext links would make using the documentation easier.

Software Architectures and Documentation

Part I. Software Architecture Viewtypes and Styles

The Module Viewtype

Styles of the Module Viewtype

The Component-and-Connector Viewtype

Styles of the Component-and-Connector Viewtype

The Allocation Viewtype and Styles

Part II. Software Architecture Documentation in Practice

Advanced Concepts

Documenting Software Interfaces

Documenting Behavior

Choosing the Views

Building the Documentation Package

Other Views and Beyond

Rationale, Background, and Design Constraints


Documenting Software Architectures(c) Views and Beyond
Documenting Software Architectures: Views and Beyond
ISBN: 0201703726
EAN: 2147483647
Year: 2005
Pages: 152

Flylib.com © 2008-2020.
If you may any questions please contact us: flylib@qtcs.net