Home / Support for EA Modelling With eaDocX / Insights / Navigating Models: Enterprise Architect Help and Techniques

Navigating Models: Enterprise Architect Help and Techniques

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

Navigating the model

In the first article I discussed hints for cleaning the content that already exists in your model so it makes sense to a new user. The next step is to help them find their way through it – do they just start with the first package and work down the project browser item by item, or is there a better way?

"Readme" diagrams

“Read me” diagrams are a great way to tell new users a story: where to look first, then what next, and develop your ideas step by step.

Most models contain just the diagrams needed to deliver the project.

But new users need more clues. So think about what new stuff you’ll need to create to help them.

Why not create a family of diagrams which are just intended for new users? I call them ‘read me’ diagrams. Users should quickly recognize that this is the diagram to look for when exploring a new bit of the model.
I recommend giving these diagrams their own stereotype (yes, EA diagrams can have stereotypes) so that all these diagrams can be excluded from existing documentation and don’t get in the way. (For eaDocX users, see diagram filters)

EA also lets us add ‘Navigation Cells’ to diagrams. These are little boxes with icons in them, which, when the user clicks them, take them to another diagram. This is how Sparx layout their ‘EAExample’ model, and it gives the diagrams a hierarchy which is independent of the package structure.

I tend to put all this new stuff into new packages, all called ‘Viewpoints’, and also give them their own package stereotype, so they can be excluded from documents as well.

New diagrams

The Readme diagram (above) contains hyperlinks to some new additional diagrams, which can be created just for new users.

These diagrams are more specific than the general ‘readme’ diagram. They show just one aspect of the model, and are designed to help users on their journey towards understanding the model.

For example, I created some diagrams which help users to understand two key parts of our overall domain model: Journeys and Payments.

Note that we’re using all the modeler’s tricks here: we have used coloring to show what content is part of each model idea, and laid-out the diagrams to show the hierarchy of those ideas. It would be hard to put these onto the overall project diagram (above) – it would make reading the diagram just too complicated.

Note that these diagrams also only have a small number of ideas in them: in this example, just domain model classes. They might also, for example, show how Components relate to Use cases, or Requirements to their stakeholders. In all cases, keep these diagrams simple, and easy to understand. Even if they don’t tell the whole story.

EA Model Views

The idea of ‘model views’ has been in EA for a long time, but seems not to be used much, which is a shame, because it’s great for helping people understand models.

EA Model Views can have a ‘favourites’ kind of folder, into which you can put diagrams, elements and packages, and control their sequence. This nicely fits into the idea of a curated set of EA content, which can help to explain a model.

So you can create a set of these ‘Favourite’ Model Views, for the different kinds of new users.

Using diagrams and Model Views in this way delivers a friendly introduction as new users start to explore your model. Combined with the simple cleaning tasks described in the first article in this series, the job is almost done.

Other articles in this series:

#1 – Cleaning

#3 – Validating

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

Including Sparx EA Model Provenance

14 August 2020

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

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

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