InfoQ

News

Interview: Markus Voelter about Software Architecture Documentation

Posted by Abel Avram on May 05, 2008 03:12 AM

Community
Architecture
Topics
Modeling
Tags
Patterns,
UML,
Documentation,
Modeling Tool

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.

5 comments

Reply

Excellent Interview and comments about Architecture Documentation by Gustavo Andres Brey Posted May 11, 2008 4:05 PM
Very good by Gabriel Belingueres Posted May 14, 2008 4:28 AM
What is Gregory's book? by Khoa Ngo Posted May 14, 2008 7:09 AM
Re: What is Gregory's book? by Mirko Stocker Posted May 16, 2008 9:45 AM
fantastic interview by GH Chinoy Posted May 15, 2008 9:02 AM
  1. 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

    May 14, 2008 4:28 AM by Gabriel Belingueres

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

  3. Back to top

    What is Gregory's book?

    May 14, 2008 7:09 AM by Khoa Ngo

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

  4. Back to top

    fantastic interview

    May 15, 2008 9:02 AM 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?

    May 16, 2008 9:45 AM by Mirko Stocker

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

Exclusive Content

Rationalizing the Presentation Tier

Thin client paradigm characterized by web applications is a kludge that needs to be repudiated. Old compromises are no longer needed and it's time to move the presentation tier to where it belongs.

Agile Project Management: Lessons Learned at Google

In this presentation filmed during QCon 2007, Jeff Sutherland, the creator of Scrum, talks about his visit at Google to do an analysis of Google's first implementation of Scrum.

AtomServer – The Power of Publishing for Data Distribution

In this article, Bryon Jacob and Chris Berry introduce AtomServer, their implementation of a full-fledged Atom Store based on Apache Abdera, which is now available as open source.

An Introduction to Virtualization

It is easy to think that virtualization applies only to servers. In reality the recent resurgence of the concept is also being applied to networking, storage, and application infrastructure.

REST Anti-Patterns

In this article, Stefan Tilkov explains some of the most common anti-patterns found in applications that claim to follow a "RESTful" design and suggests ways to avoid them.

Choosing between Routing and Orchestration in an ESB

In this article, Adrien Louis and Marc Dutoo discuss the differences and relative merits of using orchestration vs. routing in a typical ESB setup, and discuss various implementation options.

Enterprise Batch Processing with Spring

Wayne Lund discusses batch processing, Spring Batch objectives and features, scenarios for usage, Spring Batch architecture, scaling, example code, failures and retrying, and the future roadmap.

User Story Estimation Techniques

Developer Jay Fields draws on his experiences as a ThoughtWorks consultant to describe effective user story estimation techniques.