How to customize SQL database documentation

Using the default settings and options when documenting a SQL database via ApexSQL Doc does not have to be the only option, especially if there are additional options available, like Styles. You can personalize SQL databases documentation to make it stand out and differ, adding to its professional look.

These features are comprehensive and easily accessible in the ApexSQL Doc’s Output options pane. There’s also a preview pane, that allows tracking changes and impact depending on the selected stylesheet:

Output options - Styles, in ApexSQL Doc

ApexSQL Doc offers three predefined stylesheets:

The Classic Style:

Classic Style

The Modern Style:

Modern Style

The Metro Style:

Metro Style

However, there’s also a Custom stylesheet option, which allows users to create their own SQL documentation layout, for example:

Custom Style option

By using a custom layout, SQL database documentation can be personalized as users see it, but there are some additional possibilities, like changing the Header and Footer look and content. Why not add additional details like: company name, date, and SQL database name (or even more) for example, on every single page of the document?

This option is available via the Custom text in the Output options pane:

When using this feature, any SQL database documentation layout will contain additional user-defined information, which has not been included in the document, or needs to be pointed out and clearly visible. It can be easily used to set a standard in an enterprise environment where multiple SQL databases are documented regularly in a distinct and chronological manner.

Generating the SQL database documentation in an easy-to-read format is an important task. ApexSQL Doc allows documenting a SQL database from top to bottom in various formats. In addition, it creates built-in hyperlinks for easy navigation through database structures. Adding a personal touch is another step forward towards making SQL documentation both comprehensive and unique.

March 9, 2015