an arch documentation must _________ ?
- be transparent and accessible to employees
- be able to sever as a concrete blue print
- contain enough info to be used in analysis
what do we mean when we say that an arc doc can be prescriptive and descriptive?
- prescriptive : for some audiences as it describes what SHOULD BE TRUE by placing constraints on future decisions
- descriptive : for some audiences as it describes WHAT IS ALREADY TRUE by recounting already made decisions
which stakeholders use arch doc?
MM QQ IT PDE
- managers
- maintainers
- quality assurance team
- quality attr specialist
- implementers
- testers
- product line managers
- designers
- engineers
what are the 3 uses of arch doc?
- education
- communication b/n stakeholders
- system analysis and construction
what are the 3 types of notations?
formal, semi-formal and informal
what are informal notations?
- are arch views created by general purpose tools deemed appropriate by the developer team
- semantics are graphically depicted
- characterized in natural language
- neither semantics nor syntax can be analyzed
what are semi-formal notations?
- are views that have a completely defined syntax and but an incomplete semantics
- Example:
UML diagrams : which have a standardized notation but have ambiguous semantics
what are formal notations?
- are views that have precise semantics and syntax definition
- semantics are usually mathematics
Example : Arc description lang [ c, c++ … ]
___________ notation supports automation through association tools?
formal
what are the tradeoffs when choosing notations?
formal - time consuming and complex but less ambiguity and more opportunity for analysis
informal - easier but ambiguous
____________ allow us to divide software into manageable representations?
views
list the views found in Krutchens 4+1 view
- logical
- process
- physical
- dev’t
- scenario [ + 1 ]
list the views found in Software Cost reduction method?
- module view : shows modules as units of encapsulation
- process view : shows comm and synchronization b/n processes
- uses view : programs and how they depend on each other
an arch must consider a system in 3 ways. These are?
- modules - units of encapsulation
- components and connectors : runtime behavior
- allocation : relation to non sw structures in the env’t
what are the minimum views expected in a given system?
- at least 1 module view
- at least 1 c&c view
- if system is large, at least 1 allocation view
what is the method to choosing views?
step 1 - create R stakeholder / C view table
step 2 - combine views to reduce numbers
step 3 - prioritize and stage
- example : releasing decomposition view early is useful
- views can be developed in parallel
what are components of a design doc package?
- views
- doc beyond views
what are the sections needed when documenting a view?
Perfectly Executed Cause Views Rough
1. primary presentation
2. element catalogue
3. context diagram
4. variability guide
5. rationale
describe primary presentation [ documenting views ]
- describes elements and their relationship with the view
- often graphical, but might be textual, tabular or a list
describe element catalogue [ documenting views ]
- gives a detailed explanation of elements mentioned [ depicted ] in the primary presentation
describe context diagram [ documenting views ]
- shows how a system or a portion of the system depicted in this view relates to its environment
__________ shows how to exercise the variation points shown in the chosen view?
variability guide
___________ describes why the design reflected in the chosen view is, as it is?
rationale
what is the purpose of a behavior documentation?
- gives a description on how architectural elements in a given view interact with each other
