Thanks for your download of Database Help Framework

If the download doesn't start automatically, please click here to access the download URL directly.

Quick Start

Database Help Framework allows creating SQL Server database documentation in Microsoft Excel.

Take a look at the output documentation:

The workbooks folder contains a sample workbook.

The SaveToDB add-in installed is required (free edition).

Download SaveToDB

Installing Database Help Framework

To install, update, or remove the Database Help Framework:

  1. Unzip the downloaded package to a folder on a local hard drive.
  2. Open the setup folder.
  3. Run setup.exe and follow wizard steps.

Editing Documentation

To edit the documentation, create a workbook:

  1. Open Microsoft Excel.
  2. Run the Application Workbooks wizard of the SaveToDB add-in.
  3. Connect to your database and select the database_help.xlsx workbook.

You will get a ready-to-use workbook with all available worksheets.
You can create such workbooks yourself by connecting to the required objects.

Click the Save button when you need to save your changes.

Use the cell editor to edit multiline text.
You can turn it on using the Show Cell Editor button in the Options menu.

Generating Documentation

To generate the documentation, use make-help.cmd in the make-single-page-help or make-multiple-page-help folder.

Edit the gsqlcmd.exe.config file before the first use.

Also, you have to adapt regex values to change documentation URLs in the make-help.mak file.


Feel free to contact us at .