Creating documents with eaDocX

Details

Category: Document

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

3. Include information from EA linked documents in their proper context within an element​

4. ​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

5. 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.

5. Compact Document feature to remove empty sections & headings from your document.​

6. Include EA Project information: tasks, resources, issues etc

7. Auto-generate a Glossary of terms, using your EA glossary, and only including the terms which are actually in your document

8. 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. 

9. Manage your documents

Add version control to your eaDocX Documents.

• eaDocX prints the Document History as the document evolves
• Automatically updates versions, names, abstracts each time you re-generate the document.
• Capture who is involved with each document
• Improve document quality whilst reducing your effort.

Choose HOW to Print:

1. Structure documents based on :

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

2. 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

3. 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

4. Add Manual cross references from one part of the document to another, which automatically update each time the document is generated

5. Sorting: lots of options, including printing your package contents using the order they appear in your EA browser​

6. 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

7. 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.

8. Copy formatting options between documents, to give them all the same appearance

9. Use Conditional Formatting to highlight missing, important or just interesting data. Rules work for any table, inline or report data.

   ​

10. Add Reports to your documents: Element reports gather information from anywhere in the model, and print it using their own custom-formatting​

11. ​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.​

2. ​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.

3. Batch regeneration of a set of documents: ensures they are all consistent with each other

4.  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.