Guide to Samples

If you're thinking about using eaDocX, you'll want to know what kind of documents you can expect to create.

We have created lots of examples of great-looking eaDocX documents:

  1. A set which shows some of the variety of print options available from a single model: Our Sample Model and documents
  2. A selection ilustrating how specialist EA modelling can be documented: Specific Examples
  3. The comprehensive set of eaDocX print options including Excel reports: Exploring eaDocX

Remember, these are all 100% generated from EA models: we have even made the models available so you can re-generate them yourself if you want.

Our Sample Model - "GetLost"

Because all our documents are generated from EA models, first we need a Model! The 'GetLost' model is a teaching example which we created to show business analysts and designers how to use Enterprise Architect, so it uses most of the important bits of EA - the bits you probably use every day. It's the example we use in our 'eaDocX Workshop' course.

The basic idea of 'GetLost' is that of an eco-friendly travel agent, which will help users to book travel in a variety of ways.

  • So first we have the Project Overview which introduces the project. It descibes the high-level objectives of the project and introduces the stakeholders. It also has some detailed requirements and Use Cases. Read this to see the quality of document which eaDocX can generate.
     
  • Next there is a Project Report, which shows how you can use EA and eaDocX to create a report of the risks & issues for the project, which pulls data from all parts of the model.
  • The Architecture and Process document shows what a detailed EA+eaDocX document can look at, and shows how using eaDocX Conditional formatting can help you to spot errors or missing parts of your model.
     
  • Finally, there is a Personalised Report. This takes the information in the EA model one stage further, to create a document which contains things which are of interest to just one really important stakeholder.

The samples are available download in two formats:

Remember, all of these examples use only data taken from the GetLost Project Example EA model. So, as the model changes, just one click will re-generate the documents, and bring them 100% up-to-date.

 

Specific Examples

We also have some examples which show how particular kinds of EA information can be documented quickly and easily with eaDocX.

  • The BPMN example shows how eaDocX can make a business process document clear and readable.
  • The XML example has an example of what an XML schema definition will look like using eaDocX
  • In the SysML example, we take the example model as supplied by Sparx, and after a bit of tidying-up, create a BIG document
  • The WSDL example again takes content from the EAExample model

These examples are available in two formats:

  • PDF Examples, and
  • (Registered Users) Word Source files so you can see the eaDocX profiles that created them. To get the EA Repositories from which these were taken, download the EAExample or SysML Example repositories from sparxsystems.com

 

Exploring eaDocX

These are a comprehensive set of examples - they are the regression test suite for eaDocX.

They look at eaDocX feature by feature, starting with simple Inline and Table formatting and diagrams, and moving on into Element and Matrix reports and advanced relationships. If the function you want isn't in these examples, it probably doesn't exist!

The Exploring eaDocX Samples are available in two formats: