Home / Support for EA Modelling With eaDocX / Downloads / eaDocX sample and example documents

eaDocX sample and example documents

Here are some examples of project documents created using eaDocX

Sample Word documents

Architecture and Process Document

This editable document describes the Architecture of the "GetLost" travel agent example, and describes example Business Processes.
It shows how an architecture can be documented using eaDocX,

as well as a business process flow. The example also contains a Sequence Diagram which shows how one of the use cases (described in the Project Overview document) is implemented. The document is annotated, to show how each part of the document was created. The source EA model is also available for download, so you can re-generate the document yourself.

A Personalized Report

This editable document is a Personalized Report taken from the "GetLost" travel agent example.
It shows how EA and eaDocX can

be used to produce small, targeted documents, which contain the relevant project information for a single stakeholder. In this case, the Risks owned by the stakeholder and the Requirements they own. This shows how a project can produce documents which are focussed on key individuals, rather than just producing a single 'one size fits all' document for everyone.

The document is annotated, so you can see how the document was produced, and the source EA model is also available for download, so you can re-generate the document yourself.

Project Report document

This editable document has a Project Report for the "GetLost" travel agent example. It shows a list of current issues, linked

to the same stakeholder information as the 'Overview' document, and shows how EA and eaDocX can be used to create project reports direct from an EA model. It also has a readable 'RACI' matrix, showing which stakeholders are Responsible, Accountable, Consulted and Informed about each of the high-level requirements. Again, this is 100% generated from the EA Model.

The source EA model is also available for download, so you can re-generate the document yourself.

Project Overview document

This editable document introduces the "GetLost" travel agency project example, and shows how eaDocX can be used to create great documents from an EA model.

It lists the stakeholders for the project, the high-level requirements, and the main use cases. All are linked together, to show which stakeholders own which requirements, and these can be seen in the hyperlinks within the document. The document is annotated, to show how each part of the document was created. The source EA Model is also available for download, so you can re-generate this document yourself.

Exploring eaDocX Word & Excel

Basic "Inline" Formatting

This document shows the basic principle of formatting by paragraphs, how to exclude specific data from

a document, using Inline Tables where there are lots of short attributes to print, excluding of whole stereotypes of elements, and sorting of elements.
Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Documenting in Tables

This example looks at techniques for documenting your EA model as tables, with each element becoming a row in a table. It shows how

tables can contain simple attributes, data from related elements, and hyperlinks. It also shos how using Word Table Styles can be used to make your document really clear and readable, and even how to print extra-large tables in their own Landscape format pages.
Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Documenting diagrams

Most of the knowledge in an EA model is in diagrams, so eaDocX gives you lots of ways to make the most of your EA diagrams. The example starts with simple diagrams, adds automatic figure numbering and

diagram descriptions, then shows how a diagram can be used to determine the content of a model. There is a special section on printing Sequence Diagrams, and how you can set the visibility of diagram elements in EA, and have that determine your document content. It also shows how large-sized diagrams can automatically print in landscape pages.
Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Quick Documents

Sometime you just want a document - quickly. Make this simple, using eaDocX Quick Documents. Just click on the Package you want to document, and eaDocX will

analyse its contents, and create a document based on its structure: which elements, stereotypes and links you have used. This example document guides you though creating a Quick Document from the 'Exploring eaDocX' model.
Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Element Reports

The eaDocX element report collects EA elements from anywhere in your model, and prints them all together. The example shows how

eaDocX element reports can be inserted in a document, printed using their own formatting, different from the rest of the document, either inline or as tables, and filter which elements appear using a variety of criteria. This provides another way to structure your documents, instead of using the EA Package structure or diagram contents.
Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Matrix Reports

The EA Relationship Matrix is a great way to visualize two sets of related data. In eaDocX, the EA "Relationship Matrix" becomes a "Matrix Report", which extends what you can see in EA.

In this document you'll see:

- Creating an eaDocX Matrix Report from an EA Relationship Matrix, using just the default settings.
- Adding additional criteria
- Using Word paragraph styles
- Showing other attributes
- Using other cell contents
- Conditional Formatting
- Printing large reports
- Missing-out empty rows and columns
- An alternative layout for HUGE tables

Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Documenting Use Cases

In this example, you'll see how an EA use case created with the structured scenario editor can become an accurate, readable document. Links within and between use cases become hyperlinks, and

allow readers to 'browse' their way around your document. Exploit all the rich detail of your use cases captured in EA about use cases. and use the links to all kinds of other parts of your EA Model to deliver real value in your documents.
Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Documenting Classes

This document shows how eaDocX can create great-looking, readable documents which show all aspects of the class diagram and its classes, even attribute-level traceability using Element Features.

The EA Class Model is one of the most frequently used parts of the tool, used by analysts, architects and designers, so it gets a sample document of its own.
Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Documenting all kinds of Relationships

This document shows how you can add single attributes of related elements, tables of related data, or even structure a document using only relationships - no Packages at all! It also shows

how to use some special kids of EA relationship, like adding InformationItems to InformationFlow connectors, detailing State Models, and using tagged values instead of connectors.
Showing how different bits of EA information relate to each other is a real strength of eaDocX, which can help you to create better-quality, richer models, and more readable documents.
Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Document Management

eaDocX lets you manage all your generated documents and track their versions. This example shows you how eaDocX can also add

lots of details about the document version and other document meta-data to the document, so that everything gets updated each time the document is regenerated.
A real time-saver!
Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Adding References and Cross-references

This document illustrates:
- Auto-generating a document-specific Glossary
- Creating hyperlink references from Element cross-references in EA element 'notes' fields or TVs, and

- Creating an Appendix of related elements which are referenced from all the elements in the 'main' document.
These ways to use Relationships in your documents are in addition to those shown in the example document "Documenting all kinds of Relationships" , where you can see how to Relationships, you can see how to make conections between EA elements into hyperlinks.
Adding all these references can make your 'main' document simpler and easier to read, but also allow readers who are interesed to click and find out more information.
Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.

Exploring Excel

This document shows what you can do when embedding Excel charts and worksheet ranges into eaDocX Word documents. Each time the document is re-generated, eaDocX updates the spreadsheet with

new data, which makes the Excel chart & tables update, and then pulls the updated chart & table back into the Word document.
The Excel spreadsheet which this uses is called 'report with charts', and has some EA data in it, made into a simple chart and a table.
Open this with the Exploring EA model to see how eaDocX uses the EA content and integrates it with Word and Excel to define the document contents and formatting.

Compact Use Cases

This document shows how all the scenarios for a single use case can be printed in a single table.
Open this with the Exploring EA model to see how eaDocX uses the EA content to

define the document contents and formatting.

Macro-Enabled Dashboard Spreadsheet

This dashboard spreadsheet has the macro already inside it, but might not download nicely. In which case, use the macro-free one, and add the code yourself.

Macro-free Dashboard Spreadsheet

This spreadsheet illustrates the 'Dashboard' example, only without any macro code. To add it, follow the instructions in the Insight Article "Using Excel to create an EA dashboard"

Advanced Reporting

This example looks at some more advanced uses of the combination of eaDocX Word documents, and Excel spreadsheets, to create more complex reports.

Open this with the Exploring EA model to see how eaDocX uses the EA content to define the document contents and formatting.
This document uses an Excel spreadsheet which contains Macros, and so may not be usable in all environments, as Macros are a known security threat.
In this case, the source code for the macros is available at the end of the document, which you can copy/paste into your own Macro-enabled spreadsheets.

EA example Word documents

BPMN Example Word document

This editable document shows how eaDocX can create great-looking, readable documents from an EA BPMN model. It uses the BPMN 2.0 example from the EAExample model

which can be downloaded from sparxsystems.com

SysML Example

This editable document shows how eaDocX can create great-looking, readable documents from an EA SysML model. It uses the EA SysML example model, which can be downloaded from sparxsystems.com.

The model has been re-organised to make it more 'user friendly', but the main content of the model is unchanged.

WSDL Example

This editable document shows how eaDocX can create great-looking, readable documents from an EA WSDL model. It uses the WSDL example from the EAExample model, which can be downloaded

from sparxsystems.com.

XML Schema Example

This editable document shows how eaDocX can create great-looking, readable documents from an EA XML Schema model. It uses the XML Schema example from the EAExample which

can be downloaded from sparxsystems.com.

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