Creating documents with eaDocX

As EA users ourselves, we know how important it is that the documents we produce are clear and readable, and show all the richness of information that our EA models contain. So here are the main highlights of eaDocX:document excellence..

 

Choose WHAT to Print:

  1. Include any EA data:  Regular EA Elements, all the EA diagrams, all the EA project data, all types of relationship, plus Package information and as many Tagged Values and Stereotypes as you define

  2. Mix hand-written content in Word with eaDocX generated content from EA
    • Have mostly EA content, or mostly non-EA content - you decide
    • Only the EA content is re-generated - hand-written content is un-touched

  1. Include information from EA linked documents in their proper context within an element
  1. Include all kinds of EA diagrams:
  • Choose where to include them in the body of the document
  • Update them when the document is re-generated
  • Special processing for UML Sequence Diagrams - print message details
  • Automatically add figure numbers and diagram descriptions
  1. Embed Excel Charts and Tables into eaDocX Documents

Each time you re-generate a document, eaDocX exports EA data to Excel, lets Excel update your custom charts or tables, then automatically re-imports those charts/tables back into your eaDocX documents. 

Add a whole new dimension of clarity and insight into your project communications with graphics and reports.

  1. Compact Document feature to remove empty sections & headings from your document.
  1. Include EA Project information: tasks, resources, issues etc
  1. Auto-generate a Glossary of terms, using your EA glossary, and only including the terms which are actually in your document

                             

  1. Add document information about when the document was generated, from which repository and by whom, and update it each time the document is generated, including Change Marking to show the EA model changes between different versions of your document. 

  1. Manage your documents

Add version control to your eaDocX Documents.

Choose HOW to Print:

  1. Structure documents based on :

      

As well as EA Model Views, EA Searches, Matrices, ....

  1. Format EA Elements(*) either as simple tables, or as paragraphs
    • Customise which attributes are printed, and in what sequence
    • Choose different formatting for each Element, and each stereotype of each element, to give fine-grained control of their appearance
  1. Include information about relationships between EA elements:
    • Show what relates to what: Use Cases & Actors, Classes & Components, Issues & Stakeholders
    • Add relationship information into tables or inline formatting
    • Relationships print as internal hyperlinks within the document - let your readers browse your document in their own way
    • Supports EA's internal cross references
  1. Add Manual cross references from one part of the document to another, which automatically update each time the document is generated
  1. Sorting: lots of options, including printing your package contents using the order they appear in your EA browser
  1. Tight Integration with Word (2003-2016):
    • Use Microsoft Word styles which are already in your document - makes generated documents look the same as hand-written ones
    • Re-use definitions of Word header styles and numbering

  1. Select Word Styles and Table Styles to suit your formatting requirements - separate definitions, including Bullets and Numbered lists, for Headings, Tables, Inline text, Matrix reports, Diagram titles and notes.
  1. Copy formatting options between documents, to give them all the same appearance
  1. Use Conditional Formatting to highlight missing, important or just interesting data. Rules work for any table, inline or report data.

  1. Add Reports to your documents: Element reports gather information from anywhere in the model, and print it using their own custom-formatting
  1. eaDocX Matrix Reports take the definition of your EA profile, and use it directly as the basis for an eaDocX Matrix Report. You can also add additional heading rows and source columns, change the contents of cells (adding symbols or text), and even apply conditional formatting colouring... and sort elements on ANY attribute of the source & target elements.

Print:

  1. Quick Documents feature creates a first-draft document with just 2 clicks.
  1. Time saving document generation options allowing either draft (quick) or full population of the document contents, letting you easily preview and tailor the formatting of your document before it is published.
  1. Batch regeneration of a set of documents: ensures they are all consistent with each other
  1.  Compare Documents

eaDocX Document Management manages all your document versions data in EA to let you use Word 'Compare' to get a view of the detailed differences between any two documents.

Update Your EA model:

  1.  Fast Import / Export to MS Excel

No more creating CSV Files! Excel gets embedded directly into EA, so you can manipulate EA data in spreadsheets. 

 

  • View and bulk-edit Enterprise Architect Element data direct in Excel.
  • Makes importing data into EA much simpler, including legacy project information, data from other applications and derived data from other analyses
  • Export data from EA. Send Excel extracts of EA data out to be reviewed by non-EA users, and re-import their feedback directly into EA, even automatically creating new tagged values.

Connections to Hyperlinks

The power of EA lies in its ability to connect things.

As users, we get to decide what we'd like to connect to what. It might be a UML-defined link like 'Actors to Use Cases', or 'Requirements to Components'. 

What ever kind of links we create, they all mean something. And that meaning can be put into your documents, in a way that will help your readers to understand what they are seeing.

So having a list of Components in EA is interesting. So is a list of Requirements. But connecting the Requirements to the Components in a way which says which Components implement which Requirements start to make a rich web of knowledge.

So when you print the details of a Requirement, eaDocX will let you print, next to each one, the Component which satisfies the requirement:

Ref Requirement Details Implemented by Components
REQ235  All Widgets configurable The solution shall make all widgets configurable.... (CMP03) Widget Configurator
REQ481 Gadgets have Wibbles All Gadgets in the solution shall have their own Wibble  
REQ034 Admin access The Administrator shall be able to change the configuration... (CMP01) Admin Interface

So a reader of this document can start to see how their Requirements are being implemented. Apart from REQ481 - maybe there is a problem here ? We have used Conditional Formatting to highlight this.

If the reader wants to know more, they can click on the (CMP03) Widget Configurator link to find out more.

This has some useful consequences. You don't need to put all the details which the user might need into the main document. This list of Components could be in an appendix, where the inerested reader can still quickly find them. So the main document can be much smaller: just the essential information for this reader.

For more about hyperlinking, see the eaDocX Help - hyperlinking

 

Excel Charts in Word

Adding Excel Data into eaDocX Word documents

You can even combine Excel, Word and EA content all together in one document. eaDocX Corporate Edition will let you Embed Excel Charts and Tables into eaDocX Documents, so that when the document is re-generated, all the EA content will be refreshed, whether it comes from EA directly into Word, or from EA to Excel, and back into Word. 

So each time you re-generate a document, eaDocX exports EA data to Excel, lets Excel update your custom charts or tables, then automatically re-imports those charts/tables back into your eaDocX documents. 

This adds a whole new dimension of clarity and insight into your project communications with graphics and reports.

Publish Excel Reports

Publishing EA data in Excel

Once you have got your EA information in Excel, you can then send it off to be reviewed. You can allow your reviewers to add new rows, update information, even add new columns, all of which which you can then quickly import back into EA. No more messing around with CSV templates in EA : you just press a button to import back into EA!

When your EA information is in Excel, you can use all your favorite Excel techniques to process the information; creating summaries, looking for trends and really understanding what's happening in your EA project.More...

All those new Tables and Charts can be put right back into your eaDocX document

..and eaDocX will update your document, including the Excel tables and Excel charts, every time the document is re-generated.

Quick Document

Quick Document allows you to generate a document with just a single click. But it's not just Quick

It's also Smart!

Simply select the EA Package, element or diagram you want to print, then in the EA Project Browser, select  Extensions | eaDocX | Quick Document.

This will generate a new document containing the package, element or diagram you selected.

..but there's a lot happening!

Quick Document will :

  1. Open a new Word document, using your default Using Word Templates
  2. Add two sections to it - one with some Document Information, and another containing your package, element or diagram
  3. Auto-generate a profile for the document. This examines which kinds of Elements and stereotypes you have used, and how you have chosen to connect them together. . This uses the same technology as the Model Expert.
  4. Generate the document.

​...and all in a few seconds.

If you're really lucky, this will be exactly the document you want. More likely this will be nearly the document you want, but it will have all the essential elements defined, so you can now refine the document to look exactly the way you want.

For more information on eaDocX Quick Documents, see the eaDocX Help, or the Video: eaDocX Quick Document