Database Documentation for SQL Server, Oracle and Access
Document! X is a combination of an automated database schema documentation tool and a full documentation authoring environment which can be used to create
accurate, professional quality database documentation for SQL Server 2000, SQL Server 2005, Oracle, Access or other ODBC databases.
Document! X is not just an automated database documentation build tool - it is also includes a fully featured documentation authoring environment allowing you to author
supplementary content (descriptions of database elements, hyperlinks to related pages or web sites etc.) where required.
- Fast, accurate, professional quality database documentation;
- Market leading authoring tools for creating supplementary content;
- Document tables, columns, views, stored procedures, functions, triggers, indexes, relationships, defaults, checks, roles, users, permissions, file groups,
dependencies;
- Output includes colorized SQL / T-SQL / PL-SQL source code where available;
- Customizable HTML based template driven output can be adapted to your requirements;
- Generate documentation to HTML Help 1.x (CHM) or web ready pure HTML including a full Table of Contents, Index and Full Text Search.
Author content in SQL Server, Source Comments and / or externally
Document! X will use the content of Access and SQL Server description properties in the generated database documentation where available. This means that you can
continue to use SQL Server Management Tools or the Access Table Designer to define descriptions for your tables, columns, triggers, indexes etc. and Document! X will use them
automatically.
In addition, you can include specifically formatted comments in your T-SQL code and views. Document! X will extract the comments and use them in the generated sql
documentation.
Example source comments
-- ##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
-- ##SEEALSO target="pubs_db~t-Authors", caption="A see also link to a table topic"
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
...
Authoring additional content externally
You can also author content in Document! X Content Files if you would like to maintain some or all of the database documentation content outside of SQL Server or
T-SQL source code.
The full featured HTML Editor, Dynamic and Project Spell Check, Find and Replace and Link Check tools make authoring activities as productive as possible.
Benefits of using Document! X
Using an automated documentation tool immediately delivers the following benefits:
- Database documentation can be built by Document! X in moments, reducing the amount of manual effort involved in creating a documentation set to virtually zero;
- The documentation generated by Document! X is accurate and always up to date. Creating the same documentation manually is error prone;
- Producing a documentation set for your database schema makes it more maintainable as there is a structured reference to accompany the schema;