Exploring - PDF

Basic "Inline" Formatting

This is the first document in the 'Exploring eaDocX' series, which explore all aspects of the eaDocX document generator.

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. The source model and Word document are also available for this example, for Registered customers only.

Documenting in Tables

This example looks a 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.

 The source model and Word document are also available for this example, for Registered customers only.

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, them 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 sutomatically print in landscape pages.

The source model and Word document are also available for this example, for Registered customers only.

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.

 The source model and Word document are also available for this example, for Registered customers only.

Element Reports

In the examples so far, we have used the EA Package strcuture or diagram contents to create the document content.

The eaDocX element report can give you a whole new way of creating document, by collecting EA elements from anywhere in your model, anf printing them alltogether. The example shows how eaDocX element reports can be printed using their own formatting, different from the rest of the document, either inline or as tables, an can choose whcich elements should appear using a variety of criteria. 

The source model and Word document are also available for this example, for Registered customers only.

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 has lots of capabilities which extend 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

 The source model and Word document are also available for this example, for Registered customers only.

Documenting Use Cases

EA allows you to create rich use cases using the Structured Scenario editor. This captures lots of detail about use cases. and allows them to be linked to all kinds of other parts of your EA Model.

In this example, you'll see how an EA use cases can become an accurate, readable document. Links within and between use cases become hyperlinks, and allow readers 'browse' their way around your document. 

The source model and Word document are also available for this example, for Registered customers only.

Documenting Classes

The EA Class Model is one of the most freuently used parts of the tool, used y analysts, architects and designers, so it gets a sample document of its own.

This sample document shows how eaDocX can create great-looking, readable document whihc show alla spects of the class diagram and its classes, even attribute-level traceability using Element Features.

 The source model and Word document are also available for this example, for Registered customers only.

All kinds of Relationships

 

Showing how different bits of EA information relate to each other is a real strength of eaDocX, and which can help you to create better-quality, richer models, and more readable documents.

This example shows how you can use Relationships to add single attributes of related elements, tables of related data, or even structure a whole 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.

The source model and Word document are also available for this example, for Registered customers only.

Document Management

eaDocX Corporate Edition allows you to 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!

 The source model and Word document are also available for this example, for Registered customers only.

Adding References

In the document about Relationships, yo can see how to make conections between EA elements into hyperlinks.

But those are not the only references which can be created in your documents, using only information from your EA model. Adding 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.

This document shows how to:

  • Auto-generating a Glossary in your documents, containing only remevant terms
  • Creating hyperlink refences from the Element cross-references in the 'notes' fields of EA elements, or from tagged value
  • Creating an appendix from all the elements in the 'main' document which reference other elements

Exploring Excel

This document shows what you can do when embedding Excel charts into eaDocX Word documents.

The excel spreadsheet which this uses is  called 'report with charts', and has a simple chart which has some EA data in it, made into a simple chart and a table.

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 source repository, word document and spreadsheet are all available to Registered users.

Compact Use Cases

Shows how all the scenarios for a single use case can be printed in a single table.

 
 
Powered by Phoca Download