Home > Developer Tools > Code Documentor Tools > SQL Documentation Tool

SQL Documentation Tool

The SQL Documentation Tool database documentor creates technical developer documentation for Microsoft SQL Server 7.0, 2000 and 2005 databases. The documentation is created in HTML,  HTML Help, RTF text and plain text formats.

The HTML format documentation can be viewed in any web browser. It can be incorporated into an organisation's Intranet site allowing access to technical database documentation for those who require it.

The HTML Help format documentation is fully cross-referenced and searchable, and provides comprehensive database documentation in a single .chm file.

The RTF text and plain text reports may be easily incorporated into existing reports and technical documentation.

An evaluation version of the SQL Documentation Tool is available for download - the full version may be purchased online for immediate download.

Documentation Produced by the SQL Documentation Tool

For convenience the SQL Documentation Tool allows more than one database to be documented in a single help file - the databases can be on different servers.

HTML and HTML Help Reports

The SQL Documentation Tool documents the following items in a SQL Server database:

• Tables
  • Column names
  • Whether column is a primary key
  • Column data types
  • Column lengths
  • Whether column is nullable
  • Table relationships to primary and foreign keys
  • Dependency information
• Views
  • Column names
  • Column data types
  • Column lengths
  • Whether column is nullable
  • SQL script for creating each View
  • Dependency information
• Stored Procedures
  • Column names
  • Column data types
  • Column lengths
  • Column type (input or output parameter)
  • Dependency information
  • The Create Procedure SQL script for creating the stored procedure.
• Functions
  • Column names
  • Column data types
  • Column lengths
  • Dependency information
  • The Create Procedure SQL script for creating the stored procedure.
• Triggers
  • Shows which table is associated with the trigger.
  • Shows which SQL actions (insert, update, delete) the trigger is associated with
  • Dependency information
  • The Create Trigger SQL script for creating the trigger.
• Full-Text Catalogs
  • Shows the full-text catalogs that may be associated with a database.
  • Shows the tables and table columns in each full-text catalog.
• Jobs
• DTS Packages

[ View a sample HTML Report    View a sample HTML Help Report ]

RTF Report

The SQL Documentation Tool documents the following items in a SQL Server database:

• Tables
  • Column names
  • Whether column is a primary key
  • Column data types
  • Column lengths
  • Whether column is nullable
• Views
  • Column names
  • Column data types
  • Column lengths
  • Whether column is nullable
• Stored Procedures
• Functions

This report can be easily incorporated into existing word processed reports and technical documentation.

[ View a sample RTF Report ]

Plain Text Report

The SQL Documentation Tool documents the following items in a SQL Server database:

• Tables
• Views
• Stored Procedures
• Triggers
• Full-Text Catalogs

As such, the plain text report can form the basis of other database technical documentation and reports.

[ View a sample text Report ]

Advantages of using the SQL Documentation Tool database documentor

• Saves vast amounts of time and money compared to creating technical documentation by hand, leading to a significant return on investment.

• The HTML format documentation can be easily incorporated into the company Intranet as a ready source of database technical documentation.

• The report contains the transact SQL code for Views and Stored Procedures, so if a view or stored procedure becomes accidentally deleted, it is possible to replace it without requiring an often complicated system restore.

• The text format reports can form the basis of the technical database documentation for a project.

• Extracts the MS_Description field from most entities in SQL Server 2005, which allows you to create an almost self-documenting database with the minimum of effort.

• The HTML and HTML Help reports can be used by developers to build database connected websites without requiring access to the SQL Server Enterprise Manager. The reports contain useful information for developers, such as the table column names, data types, whether they accept null values etc.

• Bring new hires and contract workers up to speed on the structure of an application's database design.

• Assist with developers and database administrators (DBAs) in code reviews.

• Assist with database/application conversion to other platforms.

Download the Evaluation Version

The evaluation version is fully function except for the following limitations:

• Only the first 10 database items (tables, views etc.) are included in each report.
• JavaScript popups on some pages in the report.

• Download The SQL Documentation Tool Evaluation Version (10Mb ZIP file).
• More screenshots and sample documentation.

Purchase The SQL Documentation Tool

• The SQL Documentation Tool is available for immediate online purchase - visit the SQL Documentation Tool website for more information.

Useful Development Tools

ASP Documentation Tool™

Automatically creates developer documentation for ASP 2.0 and 3.0 web applications written in VBScript and JScript. Documentation for Microsoft Access, SQL Server 7/2000 databases and Visual Basic 6.0 components associated with the web application can also be incorporated into the reports. Documentation is created in HTML, HTML Help and plain text formats.

View Sample Output (HTML Help format).     View Sample Output (HTML Format).     Download Trial Version (5.2Mb ZIP file).

.NET Documentation Tool

Automatically creates technical documentation for .NET Framework Windows and ASP.NET applications written in C# or VB.NET and SQL Server 7/2000/2005 or Microsoft Access databases associated with the application. Documentation is created in HTML, HTML Help and plain text formats.

View Sample Output (HTML Help format).     View Sample Output (HTML Format).     Download Trial Version (5Mb ZIP file).

SQL Documentation Tool

The SQL Documentation Tool creates technical documentation for Microsoft SQL Server 7.0 and 2000 databases. Technical documentation is created in HTML and HTML Help formats. The HTML Help format documentation is fully searchable and cross referenced. The SQL Documentation Tool documents SQL Server Tables, Views, Stored Procedures, Triggers and Table Relationships.

View Sample Output (HTML Help format).     View Sample Output (HTML Format).     Download Trial Version (10.3Mb ZIP file).

VB Documentation Tool

The VB Documentation Tool creates technical documentation for Microsoft Visual Basic 6.0 projects. Technical documentation is created in HTML and HTML Help formats. The HTML Help format documentation is fully searchable and cross referenced.

View Sample Output (HTML Help format).     View Sample Output (HTML Format).     Download Trial Version (1Mb ZIP file).

Indexing Service Companion

The Indexing Service Companion is a Windows application that extends the functionality of the Microsoft Windows Indexing Service so that it is able to index content from remote websites and also from ODBC databases. As such it can be used as a low cost alternative to Sharepoint Portal Search Services.

Try Sample Search Facility.     Download Trial Version (1.7Mb ZIP file).

The Website Utility

The Website Utility examines websites for errors and areas that need to be optimised for search engines by using a built in web crawling engine. Errors checked for include broken or moved hyperlinks, missing page titles and missing meta tags. It also generates HTML for use in creating website site maps (table of contents pages - like this one), and is able to create both client-side JavaScript Search Engines and server-side ASP Search Engines for a website.

View Sample Output (HTML Format).     Download Trial Version (3Mb ZIP file).

PHP Documentation Tool™

Automatically creates developer documentation for PHP web applications. Documentation is created in HTML, HTML Help and plain text formats.

View Sample Output (HTML Help format).     View Sample Output (HTML Format).     Download Trial Version (1.0Mb ZIP file).