Generating Documentation

Parent Previous Next

Generating Documentation


After you have finished adding your solution items and creating a snapshot, you are ready to generate the documentation.


Table of Contents

  Documentation Layout

  Generating Documentation

  Command Line Documentation


Important Note:

Documentation can be customized by modifying the DOC xPress Templates. These are advanced operations, however, and may result in unexpected documentation outputs. 


As such, it is recommended to always save a copy of the default templates before proceeding with modifying the templates in case the changes negatively impact your documentation.


Documentation Layout

What DOC xPress includes within your documentation is based on the documentation layout, which is found underneath the list of items present within the Solution. By default, all solution items are added to the Layout automatically, though items can be added, grouped, ordered, or deleted from the Layout.

1.   Adding Items to the Layout: Items can be added to the layout by selecting the specific item you wish to include within the layout and dragging and dropping the item within the Layout Panel.




Important Note:

DOC xPress utilizes template structure maps to manage the overall structure of the documentation. When a user includes an item within the Layout that does not have a corresponding structure map for that items' object type, then DOC xPress will display a yellow warning () to notify the user that a default structure map will be used instead of one of the supported structure maps.


When a default structure map is used, the generated documentation will represent the structure of the extracted metadata, which may result in a large number of pages being generated that show the full metadata content.


2.   Grouping Items in the Layout: Sometimes you might wish to group items by technology, owners, servers, et cetera. This can be done by clicking the "+ Add" button located on the right side of the Layout Panel. After creating the layout node, simply follow the steps for adding items to the layout by placing the desired item(s) within the layout node.



3.   Ordering Items within the Layout: By selecting specific items, you can adjust the order of the Layout by either clicking the up and down arrows located on the right side of the Layout, or by dragging and dropping the item within the desired location.

4.   Deleting Items from the Layout: Items can be removed from the Layout by clicking the "Delete" button located on the right side of the Layout.


Important Note:

Deleting an item from the Layout does not remove the item and its snapshots from the solution, it merely excludes the item from the documentation.


Generating Documentation

1.   Once you are satisfied with the Layout, click the "Generate Documentation" button located either at the bottom of the plug-in or within the DOC xPress ribbon



2.   On the next screen you can set the specific generation point that you wish your documentation to be generated from, the document control output type, documentation title, output folder location, as well as desired output format(s).


Important Note

Generating CHM documentation requires you to have HTML Help Workshop and Documentation.



3.   Once you have your options configured how you want them, click OK to begin generating your documentation.


4.   After document generation is completed, if the "Automatically Open Generated Documents" preference is enabled and multiple formats were generated, you will be presented with a completion window that will give you shortcuts to any of the document formats you chose to create.



5.   Generated documentation also supports images. SQL server documentation will automatically generate impact analysis.



Important Note

Lineage Analysis and Data Dictionary output can be suppressed from inclusion in the document through the DOC xPress Templating preferences.