eaDocX Sections

Navigation:  eaDocX Profiles >

eaDocX Sections

Previous pageReturn to chapter overviewNext page

When eaDocX adds information from your EA model into your Word document it does so in Sections.  There are various types of Section:

Package Section

A Package Section documents the contents of an EA package.  It follows the order of the EA package structure and automatically allocates headings to match.  The formatting of all elements is that specified in your profile.

Report Section

Instead of adding an EA package to a section, you can also define an eaDocX Report to be inserted at that point

Report types are:

Element Report

Matrix Report

Gap Matrix

Other Section Types

There are a number of other types of section you can add; these add a variety of project and document data:

 

Section Type

Explanation

Profile Element Type

Project Glossary

Creates a list of terms from the Glossary of the EA model. To find the EA glossary, click (in EA, not eaDocX) View>> More Project tools >> Project Information. Project Glossary is one of the tabs in the resulting pane.

Term

Document Information

Creates a table of document information. See Add Document Information.

Document Information

Project Tasks

Creates a table of project tasks. See EA System menu (as Glossary)

Project Task

Project Issues (*)

Creates a table of project issues. See EA System menu (as Glossary)

Project Issue

Repository Data

Prints information about the project repository.

Project Repository

Authors

See EA menu Settings | Project Types | People | Project Author(s)

Project Author

Stereotypes

See EA menu Settings | UML Types

Project Stereotypes

Data Types

See EA menu Settings | Database datatypes

Project Datatypes

Clients

See EA menu Settings | Project Types | People | Project Clients

Project Clients

Resources

See EA menu Settings | Project Types | People | Resources

Project Resources

(*) The Project Issues report specified here captures only those Issues defined at Project level.

Tip:

An alternative approach for documenting issues is to define 'Issue' as a stereotype and then identify and link each issue to its related or impacted elements (eg Use case, Actor, Requirement etc.).  In this way we can then print Issues within Package Sections or in Report Sections, and take advantage of other eaDocX features such as hyper-linking.