DB Documentation Template Overview

The Db Documentation template generates MSDN-like HTML documentation and VSHIK (Visual Studio .NET Help Integration Kit) project files.

The VSHIK files allow you to compile and integrate the generated documentation with the Help content in Visual Studio.NET. More information about the VSHIK and integration instructions can be found at the Microsoft website.

Note: Each version of VSHIK targets a specific version of Visual Studio .NET; make sure to install the version of VSHIK that corresponds to your version of Visual Studio .NET.

Please note that the Db Documentation template is only available to RapTier Enterprise users.

DB Documentation live example

DB Documentation Screenshots

RapTier generates complete database documentation that contains information about tables, views, stored procedures, indexes, triggers, and table relations.

MS SQL Server, Documented Table

Figure 1. Documented Table.

MS SQL Server, Documented View

Figure 2. Documented View.

MS SQL Server, Documented Stored Procedure

Figure 3. Documented Stored Procedure.

MSDN-like interface, Navigation Tree

Figure 4. MSDN-like user interface. All pages are crosslinked for easy navigation.