Home / Learn / Insights / Getting to the Point

Getting to the Point

How to help your stakeholders with documents that communicate efficiently and effectively. .

I came across this poster recently and it made me chuckle.

Are you ever accused of taking too long to get to the point? I have been.

As the providers of information, we need to set a context and to give all the information necessary, as well as asking for action, for a decision or for information.

But putting a lot of contextual stuff up front risks the audience not knowing why they are reading our words of wit and wisdom, so they may lose interest and wander off. Their time is precious, so they need to get exactly what they need, formatted how they need it, with a minimum of surplus data cluttering up the message.

Of course every single reader has a different definition of what is essential and what is clutter.

So how can we keep everyone happy?

Different people like to consume their information in different ways: graphical, tabular, descriptive, summarised, full detail, in situ, referenced.

Some need lots of background while others can cut to the chase. That’s why tailoring how we document stuff matters if we want to get the right result.

Here are some ways we’ve found to make documents that can help our readers.

Make the required outcome clear

  • Set expections at the start of the document, either in the email subject, or possibly even in the Title…
    • Decision Required: ……..
    • Approval required: ………..
    • I need your help……….
    • This is for information only……….
  • Add a call to action at the start of the document.
    • Create a new “Executive Summary” EA package, add your request to the package notes and add the package to your eaDocX document.
    • Or if you have Corporate edition with DM enabled, enter your instructions via the eaDocX “Document Abstract” dialogue (Tools | Document Management | Document Information), and include it as a Section at the start of your document (Insert | Document Properties | Document Abstract)

Organise your content

  • Structure your document into Core and Supporting Information with automatically generated supporting information in an Appendix.
    • Create a “related elements” report (Insert Report | Element report and choose Source = Element Cross Reference) to print any or all items referenced in the main body of your document as a separate section – that means the information is there and accessible simply by clicking through a hyperlink but it doesn’t get in the way of your main ‘ideas flow’.

Cut out the unnecessary stuff

Go green and publish a Compact document to eliminate the empty sections – Set this in Tools | Options and Settings | General Settings.​ This reduces paper consumption for readers who need a hard copy, and it makes the document easier to read too.

Highlight the important stuff with colors

Not only can models be made more readable with colors*, documents can too.

You can color-code values that meet particular criteria. Conditional formatting rules which apply automatically when you generate documents from EA, make it easy to see where stakeholders need to focus.

Bring key issues to the attention of your readers by using colors to highlight missing information, or data that is outside an acceptable range. Revisions and edits to your document can be imported back into EA using the Revision Manager.

Or use colored Word table styles as a quick guide to tables for different classes of elements.

*(See this article for more on the subject of colors).

Would a spreadsheet be better?

Some types of information just work better in a spreadsheet. In particular when there are lots of fields (attributes & tagged values) for lots of elements which all need to be viewed together.  Recipients can sort and filter large volumes of information to find what they need quickly.

You can set spreadsheet conditional formatting rules , and if you need to process the ‘raw’ EA data to produce charts and tables using Excel formulae then nothing else will do.

Using spreadsheets is also a great way to collect missing information to be imported back into EA. And if you need to, you can guide your reviewers by defining sets of permitted values.

What other methods have you used?

More Insights

The Well Dressed Model

28 July 2020

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

Learn More

Choosing Your Subset

27 July 2020

One of my occasional pleasures in helping people to do better modelling is to tell them the things they DON’T need to do. And ...

Learn More

Webinar - Working with Interactive Documents

17 July 2020

This webinar from the EA Global Summit 2020 describes how to generate interactive Word documents, and use them to automate your EA model updates.

Learn More

Webinar - How to successfully scale up your EA modelling team

30 June 2020

The key issues and decisions to consider when scaling up your modelling team, and how to avoid the common pitfalls.

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 techniques for EA

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