Blog Post

Documenting architecture models using ArchiMate

  • by Richard Heward
  • 08 Oct, 2019

How using ArchiMate can help to define and create architecture deliverables

This blog paper (and detailed PDF) describes a method of defining documentation structures in the ArchiMate® notation and goes on to use a ‘driving view’ to generate output from the Archi® enterprise architecture modelling tool. This can be used to repeatedly create consistent looking architecture deliverables on a project. This example uses Archi and its jArchi scripting language although other EA tools could achieve something similar.

It was created by the need to offer a trusted, up to date, document that can easily be accessed by non-tool users. The use of Markdown as the output format was the simplest one to try first.

An architecture deliverable document is often a structured set of views and accompanying descriptions. This is modelled using a simple ArchiMate view that uses a set of concepts to represent each section or subsection, and a means of representing the order. Archi supports creating ‘view of views’ by just dragging a view in from the model tree onto a view (as a ‘View Reference’).

The script uses such a driving view and starts with the group that has no incoming trigger (Section One, in this example). It follows the triggers until it reaches a group with no outgoing trigger (Section Two). If there are sub groups (Transition and Target), it will also create a sub levels (level 2, in this case) for these. 

Any documentation entered in the properties for the groupings will be extracted (representing its section text). The script generates an image for each Reference View it finds inside the groupings.

Please have a look at the free ArchiMate Documentation PDF for full details and the script which is in GitHub.
by Richard Heward 26 Jun, 2019
The ArchiMate notation allows for a large combination of concepts and relationships to be able to express what we need for full Enterprise Architecture modelling. However, a lot of organisations don’t initially need all this and it is sometime useful to semi-restrict what is expected. This paper defines a way of achieving this using the excellent Archi® modelling tool and its jArchi scripting language.
by Richard Heward 26 Apr, 2019
Some thoughts about how to use ArchiMate to define Operating Models with more detail in a free PDF.
by Richard Heward 19 Jan, 2019
For a long time I have wanted to be able to get data out of the excellent Archi tool into a place where I can perform meaningful queries on it. Queries such as how are items connected, which  are the most connected and so on? This blog describes the journey I went through, what I discovered and how I achieved what I wanted, and more.
by Richard Heward 15 Apr, 2018
How using ArchiMate can help understand a Strategy. The is an updated version of the post I made in March 2017. I've simplified some of the concepts.
by Richard Heward 12 May, 2017
I found this excellent youtube by Westpac Banking which clearly explains the Blockchain concept.
by Richard Heward 12 May, 2017
This post describes how it is possible to quickly build a solution to a real business problem, in order to see it is a viable strategic course of action. It was done to bring clarity as to what an enterprise solution might look like and how it might work, in order to stimulate stakeholder engagement and help strategic thinking: “Hacking a Strategy”.
by Richard Heward 13 Mar, 2017
This video from Gerben Wierda is a great introduction as to why you need an EA. It doesn't fully cover the non technical aspects such as strategy and business, but it's 3 minutes 44 seconds well spent.
Share by: