InfoQ

InfoQ

News

My Bookmarks

Login or Register to enable bookmarks for unlimited time.

The content has been bookmarked!

There was an error bookmarking this content! Please retry.

Interview: Markus Voelter about Software Architecture Documentation

Posted by Abel Avram on May 05, 2008

Sections
Architecture & Design,
Enterprise Architecture
Topics
Architecture ,
Modeling
Tags
Modeling Tool ,
UML ,
Patterns ,
Documentation

Markus Voelter was interviewed by InfoQ during OOPSLA 2007, and was asked to share his opinion on today's practices about writing software architecture documentation. Markus certainly supports the importance of writing such documents, but he has a different take on that compared to the general trend. Many people think of UML as the main tool used to write software architecture documents, but Markus says UML is not the right tool. While he agrees that UML has its benefits, he continues pointing out that we should be using tools which allow us to create a formal model which can be automatically processed and its integrity can be verified. Then we should be able to generate the code from it, including the infrastructure dependency code.

Markus Voelter is also a great fan of patterns when it comes to documenting the architecture. He says that we should be using patters whenever possible because the reader will be able to understand the documents faster and clearer when we use commonly shared concepts.

The entire interview can be accessed here.

Excellent Interview and comments about Architecture Documentation by Gustavo Andres Brey Posted
Very good by Gabriel Belingueres Posted
What is Gregory's book? by Khoa Ngo Posted
Re: What is Gregory's book? by Mirko Stocker Posted
fantastic interview by GH Chinoy Posted
  1. Back to top

    Excellent Interview and comments about Architecture Documentation

    by Gustavo Andres Brey

    The voice of Markus sounded pretty familiar to me, so I would assume that he is the interviewer of SE-Radio because he mentioned it during the interview :)
    About this topic, I totally agree with you Markus you say a lot of things that I have mind and generates a lot of discussions in my course when I teach about Software Architecture Documentation (slides in Spanish here). Nowadays we have a lot of ways/tools of communicating the architecture, blogs, wikis, webcast, podcats... and the best way depends on the context of the project, the target audience and the part of the architecture that you want to communicate.
    The only things that you don't mentioned and I consider extremely useful regarding communication architectures is keeping in mind that the architecture can be communicated in terms of perspectives (or view points) and each of them has to be targeted to an specific audience, so with that you can define in a high level the language (or meta-model/diagram/text) that they understand.
    I really enjoyed this interview, thank you very much!

  2. Back to top

    Very good

    by Gabriel Belingueres

    Very good interview. Many practical and down to earth suggestions.

  3. Back to top

    What is Gregory's book?

    by Khoa Ngo

    Can anybody let me know what exactly the title of "Gregory's book" is? Thanks.

  4. Back to top

    fantastic interview

    by GH Chinoy

    Such a great interview packed with useful answers. I really appreciated hearing how pattern reviews were done and the strategies to communicate and document architectures.

    Thank you!

  5. Back to top

    Re: What is Gregory's book?

    by Mirko Stocker

    Well, I'm not sure, but he might mean Gregor Hohpe's Enterprise Integration Patterns.

Educational Content

New-age Transactional Systems - Not Your Grandpa's OLTP

John Hugg discusses high volume transaction processing applications with high and low frequency profiles, and how VoltDB can be used for that purpose.

Cool Code

Kevlin Henney examines code samples to see what can be learned from them starting from the premise that one won’t write great code unless he knows how to read it.

Collaboration: At the Extremities of Extreme

Jason Ayers share the observations he made watching a team of developers collaborating in real time on the same code base, pushing XP, pair programming and continuous integration to their extremes.

Yesod Web Framework

Michael Snoyman presents Yesod, a web framework written in Haskell and containing a web server, templating, ORM, libraries (templating, gravatar, etc.).

Transactions without Transactions

Richard Kreuter and Kyle Banker on how to avoid classical RDBMS transactional systems by using compensation mechanisms, transactional messaging or transactional procedures.

Attila Szegedi on JVM and GC Performance Tuning at Twitter

Attila Szegedi talks about performance tuning Java and Scala programs at Twitter: how to approach GC problems, the importance of asynchronous I/O, when to use MySQL/Cassandra/Redis, and much more.

10 tips on how to prevent business value risk

One category of risk that project teams need to ensure they address is business value failure – delivering a product that fails to provide value for the business investor.

Interview: Software Systems Architecture: Working With Stakeholders Using Viewpoints and Perspectives

InfoQ spoke to the authors of Software Systems Architecture on a couple of new topics, the System Context viewpoint and Agile, which have been added to the second edition.