Mohsen Vakilian's Blog

June 25, 2007

Active Documentation

Filed under: architecture — mohsenvakilian @ 7:48 pm

Documentation can become a risk in a software project!
If you don’t know the real benefit of the document, or if its contents aren’t useful for anybody, then what is the value of that document?
Software Architecture in Practice
I have read more than one third of SAIP. Now, if somebody asks me about the most interesting concept I have got from it, I would say Software Architecture Evaluation!

Assume an active discussion between the architect and stakeholders in ATAM or CBAM methods. Everybody announces his expectations from the software. Then, a list of quality attributes comes out by stakeholders’ votes based on the cost and priorities of quality attributes. Finally, a report of the whole session comes out. This is the result of an active discussion. This is the kind of documentation that will talk lively to its future readers.

Advertisements

4 Comments »

  1. Something interesting about the evaluation methods is that there are documents “per scenario” (e.g. ATAM forms capturing architectural analysis approaches for a scenario). This is a great benefit, since you can trace your non-functional requirements into the architecture. You may pick a quality attribute and see what decisions have been made in the architecture design to address that specific requirement. This is somehow similar to the “use case driven” property of UP, where you organize the design model around functional requirements (use cases).

    Comment by Ramtin — July 11, 2007 @ 12:15 pm | Reply

  2. So, another important benefit of evaluation methods is the traceability they provide for the various architectural decisions. This has always been an important issue for developers to find out the reason of their decisions after some time has passed.

    It really makes me confident to see my instructor’s comment on my post!
    Thank you!

    Comment by mohsenvakilian — July 11, 2007 @ 2:34 pm | Reply

  3. […] had read the SAIP two years before, I was familiar with CBAM. However, this tutorial refreshed me on the subject of architecture […]

    Pingback by OOPSLA 2008–Economics-Driven Architecting « Mohsen Vakilian’s Blog — January 12, 2009 @ 3:32 pm | Reply

  4. Hi! I was surfing and found your blog post… nice! I love your blog. 🙂 Cheers! Sandra. R.

    Comment by sandrar — September 10, 2009 @ 7:44 am | Reply


RSS feed for comments on this post. TrackBack URI

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Create a free website or blog at WordPress.com.

%d bloggers like this: