Documenting architecture models using ArchiMate

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.