Video Overview

If you are new to eadocX, the best place to start is by creating a Quick Document. Let eaDocX do the work of analyzing the structure of your document, and creating a document based on what it finds.

Choose from:

Quick Documents #1 - for User Stories

This shows how to create an eaDocX Quick Document for some Sparx EA User Stories.

This video shows an example where EA creates some data: 

  • an Epic consisting of some User Stories
  • each User story linked to a Persona
  • each User story has some Internal Requirements

From this eaDocX will create a document

  • Right Click on a package in the EA Project Browser
  • Follow the pop-up menus through Specialize* > eaDocX > Quick Document
  • eaDocX analyzes the contents and structure of the package, and creates a default structure based on what it finds
  • a few seconds and it's done.

What did eaDocX just create?

  • MS Word has opened your document in a window inside EA.
  • The document is based on your Word 'Normal.dot'
  • eaDocX has added some document information ...
  • ... then the main content of the document
  • The base of the document is the package and its 'notes'
  • It has included any diagrams it found (the Word diagram name comes from the EA diagram name) and notes from the diagram notes
  • Then the children of the Package. In this case, first the Epic and notes
  • Then children of the children - the User Story
  • EA connectors have been made into Word hyperlinks - making the document more interactive
  • And the Internal Requirements of the User Story are also listed.

eaDocX reads the EA model and creates the Quick document based on what it finds.

See what else Quick documents can do:

Quick Documents - for Use Cases

Quick Documents - for Requirements

 

(EA14 = Specialize, EA13 = Extensions, <EA13 = Add-Ins))

Quick Documents #2 - for Use Cases

This shows how to create a great-looking Word document for some Sparx EA Use Cases.

It includes the use of the "Compact Document" option, and how to change the Quick Document default formatting.

Note: this video has no audio.

The video starts by getting some test data from EA. This contains a Use Case which uses EA Structured Scenarios.

  • Create a Quick Document from the Package of Structured Use Cases (Right click in PB > Specialize > eaDocX > Quick Document)
  • eaDocX analyzes the structure of this part of the model, and creates a document using some assumptions
  • The document includes some document information,
  • Then a Table of Actors, and the Use Cases they are connected to - with Hyperlinks to the use cases
  • For each Use Case, links to other Use Cases - there are two different kinds of link in this model.

Each Use Case is formatted the same way - even if there is no data

  • Remove the "(none)" output - it makes the document look messy - by using the eaDocX "Compact Document" option to clean up where there are blanks.
  • Regenerate to see the difference - much neater

Next let's look at the Quick Document defaults...

  • Quick Document prints: (connector type):(target element type):(target element)...
  • ...which always works, but doesn't read very well.
  • Change this by editing the Profile. Profiles control how each element type is printed.
  • In the Use Case Profile you can edit the captions to make them better for your readers
  • You can also remove the Stereotype prefix in the Use Case heading
  • Save your changes and regenerate to see the difference - Simpler and clearer.

Quick Documents #3 - for Requirements

Shows how to use an eaDocX Quick Document to document some Requirements, and their related content.

This video shows how Quick Document works with more complex models by discovering the structure of your model, to give you a flying start ... towards creating an excellent Word document from your Sparx EA model.

Start by getting some test data from EA - a more complex model with multiple relationship types and tagged values - e.g. the Requirements Traceabilty Model.

  • Run Quick document with the default settings - see what we get.
  • We can see all the elements, some of the relationships...
  • The Quick document default is to only show relationships in one direction. In this example, FROM the TestCase TO the requirement
  • Maybe we also want to show the link in the other direction, FROM the requirement TO the TestCase
  • There are also some important Tagged Values which are not in the document. Let's get eaDocX Quick Document to find and print them as well.

Change the Quick Document defaults, and generate a new document

  • In the EA Project Browser, Right click for Specialize > eaDocX > Settings > Application Settings
  • This is where you can change the defaults - to make the document simple or to show more detail.
  • Change "Show Reverse Relationships" to True
  • Change "Show all Tagged Values" to True
  • Create a New Quick Document and see the differences...
  • ...lots more connectors!
  • ...and the Tagged Values are being printed.

Use "Compact Document" to remove the (none) entries ( in Tools > Options and Settings menu) and regenerate.

  • Now check the Forward and Backward links
  • And the Tagged Values
  • All done!

 

Masterclass - Using Model Views

EA Model Views are a way to collect together a set of packages, diagrams and elements in your model, into a 'favourites' folder.

You can have any number of these folders - for example, one for each project you're working on.

eaDocX can use these Model View folders to create documents which are quick to create, and really flexible.

EA Model Views are collections of packages, diagrams and elements, from anywhere in your Enterprise Architect model.

In this video you will see how you can use Model Views to create simple, flexible documents with eaDocX

  • Create a Model View in EA
  • Open eaDocX and choose "New document"
  • Within eaDocX, insert a Section - choosing Model View as the content - you will be asked to choose which Model View to insert
  • eaDocX adds a section for the model view content. As it does so it automatically creates eaDocX Profiles for all of the model view contents.
  • Generate the document to see what it looks like
  • The document follows the Model View structure
  • To change the document structure, just change the Model View
  • The underlying model structure remains unchanged

eaDocX - creating fast, flexible documents