Getting to the point

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

  1. 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..........
  1. 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

  1. 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

  1. 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 colours

  1. See this article for a LOT more information on this subject.

 

What other methods have you used?

 

This is one of a series of articles on the eaDocX blog, covering a range of suggestions for improving communications and driving quality and efficiency with Sparx Systems Enterprise Architect. For more ideas, check out our other blog articles at www.eadocx.com.