Documenting software architecture
Upcoming SlideShare
Loading in...5
×
 

Documenting software architecture

on

  • 949 views

 

Statistics

Views

Total Views
949
Views on SlideShare
949
Embed Views
0

Actions

Likes
2
Downloads
44
Comments
1

0 Embeds 0

No embeds

Accessibility

Upload Details

Uploaded via as Microsoft PowerPoint

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel

11 of 1

  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
  • i need a designing architecture ppts
    most urgent
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Documenting software architecture Documenting software architecture Presentation Transcript

    • DR. HIMANSHU HORA SRMS COLLEGE OF ENGG. & TECH.,BAREILLY INDIA Documenting Software Architecture
    • Theme of topic Documenting the architecture is the crowning step to crafting it. Good architecture documentation is the fruit which stakeholder get from herculean effort of one person SYSTEM ARCHITECT and if the stakeholders not been able to understand the whole effort will have been wasted. So documentation should have to be easy in reading as well as in understanding.
    • Uses of architectural documentation “Documentation is to write from the point of view of the reader”  The architecture of the system depends on the requirement levied on it.  Should be sufficiently abstract.  Should be detailed also to serve as blueprint.  Understand who the stakeholder are, this will help in documentation.
    • Views A software architecture for a system as “the structure or the structures of the system , which comprise elements , the externally visible properties of those elements , and relationship among them” View – representation of a coherent set of architectural elements as written and read by stakeholders.
    •  Documenting an architecture is a matter of documenting the relevant view and then adding documentation that applies to more than one view.  Backbone of the architecture documentation:-  Choosing the relevant view.  Documenting the view.  Documenting information that applies to more than one view.
    • Choosing the relevant view  Simple three steps of choosing:-  Produce candidate view list  Combine views  Prioritize
    • Documenting a view  Primary presentation  Element catalog  Context diagram  Variability guide  Architecture background  Glossary of terms  Other information
    • Documenting behavior  Views represent structural information about the system  Structural information alone is not sufficient  Behavior add information that reveals the ordering of interaction among the elements etc.  In UML , sequence and state chart diagram are example of behavior.
    • Documenting interface template  Interface identity  Data type definitions  Exception definitions  Resources provided  Resource syntax  Resource semantics  Resource usage restriction
    •  Variability provided by the interface  Quality attribute characteristics of the interface  Element requirements  Rationale and design issue  Usage guide
    • DR. HIMANSHU HORA SRMS COLLEGE OF ENGG. & TECH.,BAREILLY INDIA Thank You