Home / Support for EA Modelling With eaDocX / Insights / Including Sparx EA Model Provenance

Including Sparx EA Model Provenance

Sparx EA model help to explain to others why your models look the way they do.

It’s a strange word to find in a modelling blog. We usually think about the ‘provenance‘ of an antique or a painting as telling us where it came from and something about it’s story.

So maybe it’s not so strange that we’d like to know the provenance of our model information:

  • Where did it come from?
  • Who has reviewed or approved it ?

..and most importantly..

  • why does it look the way it does ?

Think for a moment how you would explain a bit of your model to someone else, if you were both stood at the same whiteboard.

What you would NOT do is tell them to wait whilst you draw up a big diagram, than start to explain it all (see ‘Telling a Story’).

You’d draw a bit, explain a bit, and I expect you’d also be saying things like ‘we decided to do it this way because...’ or ‘..there are lots of ways to do this, and we chose this one because of ...”.

These are all statements about the provenance of the model. Not just explaining the ‘what there is‘ but more ‘why it is the way it is‘.

Now I’ve been modelling for more than 25 years, but as proof that ‘every day’s a school day’, a few months back I saw a brilliantly simple way to do this.

The modeller wanted to remember WHY this component had these interfaces, so they created two ‘design decision’ elements to hold the explanation. And one of them is even linked to the part of the organisation which was involved with the decision.

 

Compare this with the alternative.

Which one would you rather see?

Sure, there is a big overhead in writing down all these decisions, but imagine looking at this diagram in a few years time, when you’re thinking of re-using that component? Now which one would you like to see? It’s like having the original modeller stood next to you, ready to explain it all.

Practicalities

Capturing provenance has a potential impact on your model, so we need to think a little before doing this. Here are some suggested implementations ideas:

  • Decide on what a decision looks like (special kind of class, artifact or other – depends on what your modelling tool allows)
  • Make it look different from other stuff, so nobody thinks these are part of the model content
  • I also suggest linking them to other model elements using an obviously different line style/color, just to emphasize that these are just notes.
  • To encourage use of these ‘decision’ elements, how about giving special awards (buns, coffee) to modelers who add them to their models. More of them would get a higher quality score when the model is reviewed. A bit like comments in code (don’t get me started on that….)

More Insights

Where's the best place to start modelling?

19 October 2020

Advice for the new modeller #1 - Where do you start?

Learn More

Process based model styles

25 August 2020

How to use BPMN and UML to make models which last.

Learn More

Models matter - nearly as much as deliverables

25 August 2020

Models matter - nearly as much as model deliverables

Learn More

Improving model quality using a Sparx EA reference model

25 August 2020

Maintain quality with tools to find and fix mechanical errors in your modelling

Learn More

Fixing your meta-model

25 August 2020

Advice for the new modeller #3 – Fixing your meta-model

Learn More

How much domain modelling is enough?

25 August 2020

Advice for the new modeller #2 – (not) Melting the Pan

Learn More

What needs to be included in your EA model content?

25 August 2020

Advice for the new modeller #4 – (not) Modelling The World

Learn More

Knowing when to give up

25 August 2020

Knowing when to step back makes for better Business Analysts

Learn More

Using UML icons for more useful models

25 August 2020

Diagram Graphics for Adults

Learn More

Using Enterprise Architect to document decision making

25 August 2020

Make your models more useful for future modellers

Learn More

Beck’s Map: an EA model abstraction example

25 August 2020

Possibly the best model abstraction in the world

Learn More

Use case, package or process?

25 August 2020

A time for Packages

Learn More

Simplifying ideas in a BPMN Process Diagram

25 August 2020

How to find the right number of ideas to include in your model.

Learn More

Explaining EA Sparx Systems to non-modellers

25 August 2020

Model driven analysis - the best way to define what we do?

Learn More

How to simplify BPMN Data Models

25 August 2020

Why simplifying your diagrams can actually make them more informative.

Learn More

Create useful models using the Sparx EA Tool

18 August 2020

Advice for the new modeller #3 - Producing useful outputs with your new EA tool.

Learn More

Beginners guide to Enterprise Architect software

18 August 2020

Our advice for new EA modellers

Learn More

UML Business Analyst Solutions

14 August 2020

Using UML to resolve inconsistencies, gaps and overlaps.

Learn More

Cleaning: How to Simplify Enterprise Architecture Models

14 August 2020

Model Curation Techniques # 1 - Cleaning your EA model before you let other people see it

Learn More

What to include in your enterprise architect documentation

29 July 2020

How to create documents which communicate your ideas efficiently and effectively to stakeholders.

Learn More

Organising an Enterprise Architect Model

28 July 2020

Seven ways to organise your EA models so that other people can understand them

Learn More

Choosing Your UML Subset

27 July 2020

Narrowing down the modelling ideas in your Enterprise Architect model to make consistent, understandable models.

Learn More

Webinar: Using Interactive Documents to Collate Sparx EA Model Feedback

17 July 2020

A webinar from the EA Global Summit 2020.

Learn More

Webinar: How to successfully scale up your Enterprise Architect team

30 June 2020

A webinar from the EA Global Summit 2020.

Learn More

Navigating Models: Enterprise Architect Help and Techniques

16 April 2020

EA Model Curation Techniques #2 - Making models easy to navigate.

Learn More

Validation: Improving your Enterprise Architecture Model Structure

16 April 2020

EA Model Curation Techniques #3 - Validating your model

Learn More

Explaining the General with a Specific

16 April 2020

Explaining ideas using Object diagrams

Learn More

Different documents for Different People

16 November 2018

How to tailor information to each user - making it as easy as possible for everyone to engage with your work, project or deliverables.

Learn More

Document or Model View?

21 May 2018

Use your documents as an alternative to Model Views.

Learn More

Color your Knowledge

25 April 2018

A while ago a client asked me to look at some process diagrams which had been created for them by a well-known consultancy.

Learn More

Model Curation

6 March 2018

How cleaning, navigating and validating your EA model makes sharing and collaborating much more effective.

Learn More

Context - Where are we?

20 October 2017

I’m occasionally asked “What’s the most re-usable bit of a model – where should I start?“.

Learn More

Glossary

12 October 2017

In a recent talk, I asked the audience of about 100 BAs which of them maintained a glossary as part of their work.

Learn More

Hard and Soft

11 October 2017

No, not about Brexit… More about styles of Business Analyst.

Learn More

Printing connectors

18 October 2016

Creating documents that start with the connections between the things in your model

Learn More

Using Multi-hop relationships to display Branch/Merge with EA13

11 August 2016

One of the most common requests we see from new EA users is: "Why can’t I do branch/merge with EA?

Learn More

Compare pricing and features

Choose the eaDocX edition that’s right for you and your team

Compare Pricing

Download a free trial

Take a free, no obligation, 30-day trial of eaDocX. Discover for yourself why it’s the world’s best-selling Enterprise Architect extension.

Download