Table of content
A complete architecture documentation package consists of a set of views, along with documentation of the information that applies to more than one view.
The package can consist of one document, a few, or many.
A view packet includes a primary presentationusually graphical, including a keyand supporting documentation that explains the primary presentation.
Supporting documentation in a view packet includes an element catalog, a context diagram, a variability guide, architecture background, other information, and relationship to other view packets.
Documentation beyond views consists of a documentation roadmap, a view template, a system overview, mapping between views, a directory, a project glossary and acronym list, and rationale.
Document the views, and documentation beyond views, using the templates in this chapter (tailored for your own use if necessary).
Document the mapping between views by using a table showing how elements of one view correspond to elements of another.
Document the rationale behind a design decision if it seems nonobvious, is the source of questions, is critical, or has widespread effect.
Rationale for a design decision should include relevant constraints, rejected alternatives, ramifications of the decision, and evidence that the decision was the correct one.
Review documentation for fitness of purpose, using the technique of active design reviews.
Table of content
Documenting Software Architectures: Views and Beyond
BUY ON AMAZON
Simiral book on Amazon
Cisco IP Telephony (CIPT) (Authorized Self-Study) (2nd Edition)
Software Systems Architecture: Working With Stakeholders Using Viewpoints and Perspectives (2nd Edition)
Software Architecture in Practice (2nd Edition)
The Process of Software Architecting
Just Enough Software Architecture: A Risk-Driven Approach
Database Modeling with MicrosoftВ® Visio for Enterprise Architects (The Morgan Kaufmann Series in Data Management Systems)
Introducing Microsoft Office InfoPath 2003 (Bpg-Other)
Adding Basic Controls and Lists
Adding Views to a Template
Publishing Form Templates
Connecting Forms to Databases
Oracle Developer Forms Techniques
Advanced Forms Programming
Does Subclassing Exhibit Intelligence?
Techniques for Querying and Updating New Data Sources in Forms Based on Objects
C++ GUI Programming with Qt 3
The Central Widget
QString and QVariant
PostgreSQL(c) The comprehensive guide to building, programming, and administering PostgreSQL databases
Client 3Processing Queries
Client 4Working with transactors
Client 1Connecting to the Server
Client 4An Interactive Query Processor
Client 3Updating the Database with a DataSet
The Java Tutorial: A Short Course on the Basics, 4th Edition
General Programming Problems
Special Edition Using FileMaker 8
Getting Started with Scripting
Troubleshooting in Specific Areas: Performance, Context, Connectivity, and Globals
Enabling and Configuring IWP
FileMaker and Web Services
Working with Web Services
Flylib.com © 2008-2017.
If you may any questions please contact us: firstname.lastname@example.org