DBDocumentor - Features

The DBDocumentor SQL documentation system contains a large number of features to assist development staff in producing production quality SQL documentation.

Documentation items include the ability to:

Support for multiple DBMS systems. Currently the DBMS systems supported include all versions of Microsoft SQL Server (including SQL Server 2005), Firebird 1.5 and 2.0, and Sybase SQL Anywhere (ASA) 10 and below (including Watcom SQL objects)
Produce documentation of SQL Server Reporting Services RDL files
Output documentation in XML format
Output documentation in HTML Help format (Classic and Modern MSDN style)
Output documentation in pure HTML format (Modern MSDN layout only)
Document databases without requiring any connection to the database.
Determine object usage and dependencies and provide hyperlinks between all objects.
Determine if data is modified by an object, and report which objects are modifying data from a given data source (e.g. if a stored procedure deletes data from a table, in the summary listing for both the table and the stored procedure, data modification is listed)
Produce SQL dialect specific color syntax highlighted source code output in CHM documents
Provide persons writing documentation with the ability to supply their own example text
In both example and normal object descriptions, users can indicate sections of SQL to be color syntax highlighted.
In both example and normal object descriptions, users can indicate sections of XML to be color syntax highlighted
Describe object groupings for the purposes of table of contents entries
Define custom table of contents layouts
Supply custom content for inclusion in the table of contents
Document ad-hoc queries
Produce documentation of dynamic SQL
Control the inclusion of temporary objects
Optionally use DBMS specific metadata for object descriptions. Depending upon the DBMS, the metadata may include Pikauba specific extensions. For example, users of Microsoft SQL Server can use Microsoft extended properties and Pikauba extensions to define metadata descriptions for items not defined by default in the Microsoft SQL Server metadata, such as the intent behind stored procedure execution.
Document all user specified SQL objects of the DBMS, complete with the most significant attributes of those objects. A complete listing of what is documented can be found here.

DBDocumentor and SQLDocumentation are trademarks of Pikauba Software.