Compact documents

The problem with most generated document is that they can look....generated

They tend to have lots of empty headings, missing data and generally are hard to read.

The eaDocX compact document feature gives document authors the option to not print empty data fields, therefore making documents smaller and easier to navigate.  

The need for a Compact document feature arises because of the comprehensive way in which eaDocX captures and formats all EA data to print...

eaDocX uses the document profile to contain the definition of print formatting for each element and stereotype.  If a Section that includes packages is added to the document, all elements and stereotypes contained in those packages will be documented as defined in the profile,  whenever the document is generated.  Every occurence of those elements will be printed, whether or not there is any data in the relevant fields.

  • If you have formatted in tables, any 'missing' data' will show up as cells containing blanks  (although eaDocX allows you to define default text that will print if there is no content).  If table formatting has been chosen, the space impact of printing blank fields is not too significant, although the inclusion of large numbers of blanks can mask the 'real' data. 
  • Alternatively, if you have formatted in-line, then there can be a series of headings with no data underneath - for large models or large numbers of elements this can easily fill many pages.  

When not to use Compact Document

If the model is incomplete and you are using the document as a check for completeness or to reveal where additional work is needed this can be useful, but there may be occasions when you want to suppress printing of those empty or blank headings.  This is where the Compact Document feature comes in. 

eaDocX allows you to automatically remove document headings that contain no data.  This option can be applied independently of the element formatting defined in your document profile, so you don't have to print a draft of the document, spot the gaps then go back to manually remove them or change the formatting definition for the elements in question to limit the space taken.

As a result documents can be made considerably more compact, saving paper (or reducing scrolling) and storage space.  Then, when the model changes and the document is regenerated you can be sure that the full set of EA data will be brought across into the updated document, with no further work required from you.  

To enable Compact Documents, see eaDocX | Options and Sections | Options for this document | General | Compact Document

For more details. see the eaDocX Help - Compact Documents