Customizing documentation is an integral feature of DOC xPress. Showing only the information necessary to your targeted consumer of your data is a great way to save you time on generating the documentation and saves time for the consumer of your data so they don't need to comb through information that is of no use to them.
- To begin, we recommend starting at the Layout window. Your documentation will include any data sources that are included in the Layout and will exclude any data sources that are not included in the layout. To begin, start by highlighting the items included in your Layout and then select 'Delete' to remove them from the Layout. Note thatdeleting items directly from the 'Items' section will completely remove them from your solution, which is not the goal of these steps.
- This step is optional and is a good way to organize the documentation by grouping items together if you wish to do so (if not you can skip to step 3). By selecting 'Add' you can name a node before adding specified pieces of information into this node. This is useful if you want to group your items with a meaningful name within your documentation.
- To add items into your documentation, simply drag it from ‘Items’ into the layout OR drill into your data sources from the 'Items' section if you want to only pull specified data sources. In my example, I am going to only produce documentation on my 'AdventureWorks2012' database, so I drill into the databases level and drag only the 'AdventureWorks2012' database into my Layout. You can repeat this process until you have all items you wish to be included in your documentation.
- When you are satisfied with the Layout configuration, you are ready to select ‘Generate Documentation’ which is located below the Layout window. You can also further customize what is included/excluded from the data sources that you have included in your layout by continuing below.
- The next stage of filtering is customizing your 'Output type' to decide what specific groups of information will be included or excluded in your documentation. Select the arrow next to 'Output type'.
- This is where you can do the greatest customization tailored to the consumer of your documentation. If your documentation is for someone who needs to see tables but has no need to see to the column level, you can remove columns from being documented - continue down the list until you are satisfied with the selection. Note that DOC xPress flags sets of data that will generate a large amount of documentation with a yellow exclamation point. Once you are satisfied, you can save this preference of documentation by checking 'Save my selection as' and entering a meaningful name to the right. If you do not save your selection, you will still generate this customized documentation, however you won’t have this preference set saved for quick use next time.