Products

Home / eaDocX Homepage / 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

Documents are dead - or are they?

19 October 2023

If your organization needs documents then you need eaDocX and Revision Manager - for quality documents, easy reviews and fast efficient model updates.

Learn More

Document-based EA model collaboration

27 September 2023

eaDocX and eaRevisionManager provide a cost effective and powerful solution for efficient document-based collaboration in Enterprise Architect.

Learn More

Why has eaDocX become eaTeamWorks?

27 September 2023

Here are the reasons why eaDocX is now part of eaTeamWorks - and why it's good for you.

Learn More

Creating Custom Documents in Enterprise Architect 16

21 September 2023

Enterprise Architect 16 offers refined tools for customizable report-building. But sometimes you need even more. And fast. Here's how.

Learn More

Traceability using Multi-hop Relationships

9 September 2021

Using eaDocX multi-hop relationships you can easily print the end points of 'virtual connectors' showing EA end-to-end traceability.

Learn More

Enterprise Architect Tables: Using word table styles in EA

25 June 2021

This video shows how to apply Word table styles when you generate eaDocX documents from your Enterprise Architect models.

Learn More

Video Masterclass - Adding Detail to EA Matrix Reports with eaDocX

25 June 2021

With eaDocX you can format EA Matrix Reports in Word to include additional details and formatting. Here's how

Learn More

Video Masterclass - Creating documents from Model Views

25 June 2021

Use EA Model Views to create simple, flexible documents with eaDocX.

Learn More

Conditional Formatting Tool for Enterprise Architect

25 June 2021

Help readers find the things that need their attention, decisions and actions, with eaDocX conditional formatting.

Learn More

Video Masterclass - Attribute mapping with EA, eaDocX and Excel

25 June 2021

With eaDocX and Excel, it's easy to view, edit, create and even delete attribute/attribute links in Sparx EA.

Learn More

Enterprise Architect Help: Choosing the right document structure

25 June 2021

eaDocX makes it easy to create exactly the document structure your readers need. Here's how...

Learn More

Enterprise Architect User Guide - quick documents

22 June 2021

Video guides on how to create quick documents with EA's leading add-on, eaDocX.

Learn More

Documents in the Enterprise Architect Cloud

6 April 2021

eaDocX in the Cloud: Enterprise Architect document creating for EA SAAS environments

Learn More

Producing Enterprise Architect RACI reporting

11 March 2021

Producing a RACI report from data held in EA, mapping stakeholders to any project deliverables is straightforward with eaDocX.

Learn More

Models matter - nearly as much as deliverables

25 August 2020

Models matter - nearly as much as model deliverables

Learn More

Fixing your meta-model

25 August 2020

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

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

Use case, package or process?

25 August 2020

A time for Packages

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

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

Modelling techniques for business architecture software to explain general patterns

16 April 2020

Using object diagrams to explain general patterns with specifics.

Learn More

How to create personalised documents using Sparx document generation tools

16 November 2018

A guide to creating documents from Sparx EA models so everyone can engage with your work, project or deliverables.

Learn More

Document or Enterprise Architect Views?

21 May 2018

Create documents to be used by non-EA users instead of model views.

Learn More

Improve your enterprise architecture model using colour

25 April 2018

Careful use of colour and shape makes models easier to digest.

Learn More

Model curation techniques for EA Sparx Systems

6 March 2018

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

Learn More

The most re-used model components in Sparx Enterprise Architect.

20 October 2017

Why is the project summary the most read element in an EA model?

Learn More

Creating a Glossary: Business Analyst Terminology

12 October 2017

Streamline your business understanding with shared definitions.

Learn More

Business Process Analyst Styles

11 October 2017

Find out if you are a 'hard' or 'soft' Business Analyst.

Learn More

How to Print Sparx EA Connectors

18 October 2016

Structure your documents using the connectors in your Sparx 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 licence prices

Choose the licence that’s right for you and your team

Prices

Download a free trial

Take a free, no obligation, 30-day trial of eaDocX and ea Revision Manager. Discover for yourself why eaDocX is the world’s best-selling Enterprise Architect extension. eaDocX and eaRevision Manager are part of eaTeamWorks, so you can also trial eaSheets, Model Expert and PortfolioManager. Plus free for life features.

Download