Glossary Item Box

Document! X for Database Documentation

Document! X supports documentation of Access, SQL Server and other OLE DB databases. Database documentation covers the following database items:

  • Tables and Columns
  • Views
  • Indexes
  • Table Relationships
  • Stored Procedures
  • Triggers, User Defined Functions, Data Types, Users, Roles, Defaults, Rules, Checks, File Groups and Full Text Catalogs (SQL Server)

View a movie demonstrating how Document! X can quickly and easily create documentation for a database schema

View samples of Database documentation generated by Document! X

Download a free evaluation version

Document! X Content File Editor - editing a Content File for a Database

Document! X Content File Editor - editing a Content File for a Database

Authoring content

Document! X can extract specifically tagged comments from View, Stored Procedure and User Defined Function (SQL Server only) SQL source code. Example:

-- ##SUMMARY This procedure is an example of using various Document! X comment types
-- ##REMARKS Single line and multi-line comments can be used
-- ##RETURNS Documents the return type of a procedure
CREATE PROCEDURE ExampleTaggedComments
 @Param1 int = NULL, --##PARAM @Param1 The first parameter
 @Param2 varchar, --##PARAM @Param2 The second parameter
 @Param3 tinyint, --##PARAM @Param3 The third parameter
AS

...

Document! X can also use any existing descriptions entered into the Access Table designer, or any SQL Server descriptions entered in the SQL Server Enterprise manager or created using extended properties.

The Document! X Content File Editor allows you to author additional content for inclusion in the generated documentation. The full featured HTML Editor, Dynamic and Project Spell Check, Find and Replace and Link Check tools make authoring activities as productive as possible.

Colorized source code

Document! X outputs colorized SQL code associated with documented objects where available. Colorized SQL code is easier to read and forms a valuable reference in the generated documentation.

Customization

The template based configuration that Document! X is based on makes it easy to:

  • Create new comment types for use in source code comments;
  • Adapt existing templates to match your existing corporate style and color scheme;
  • Customize Table of Contents definitions according to your requirements;
  • Fine tune the standard phrases and terminology used by Document! X to match your standards.

Authoring examples

The easy to use Example code designer included in the Content Editors makes adding multi-language examples a breeze. In-line or linked examples can be created and example code is automatically colorized in the generated output.

Localization

Document! X supports several different languages (English, French, German, Dutch, Italian and Russian)  for the phrases used in the generated output. All of the phrases and terminology in the generated output can be configured according to preference.

Document! X allows you to author content for multiple languages within a single project, showing you an embedded tip for the primary locale content when you are authoring in the Content File Editor for a secondary locale. If you use the Document! X and HelpStudio bundle you can export and import your localized content in XLIFF format; the industry standard for sending and receiving translation content from translation providers.