Document! X delivers the best of both worlds by seamlessly combining automatic documentation of SQL Server, Access, Oracle and other OLE DB databases with a full WYSIWYG authoring environment. The generated Database Documentation is an accurate and comprehensive documentation set covering:
Document! X can use descriptions and other content from your SQL/T-SQL/PL-SQL Source Code, Access Description Properties or SQL Server Extended Properties and you can extend the source descriptions using the rich authoring environment provided by the Document! X Content File Editor.
These sample outputs illustrate how much can be generated by Document! X right out of the box. All of the Document! X Templates are fully customizable and can be easily adapted or extended to meet your specific requirements.
Overview of the database, listing Schemas, Tables, Views, Stored Procedures, Functions, Data Types, Users, Roles, FileGroups etc.
Page generated for a User Defined Function, including Properties, Parameters and SQL Source (where available). Also includes dependencies if documenting a Sql Server database.
Page generated for a View, including Properties, Columns and SQL Source (where available). Also includes dependencies if documenting a Sql Server database.
Page generated for a Table, including Properties, Columns, Indexes, Relationships and SQL Source (where available). Also includes dependencies if documenting a Sql Server database.
Page generated for a Stored Procedure, including Properties, Parameters and SQL Source (where available). Also includes dependencies if documenting a Sql Server database.
Page generated for a User, including Properties, Parameters and SQL Source (where available). Also includes dependencies if documenting a Sql Server database.
Page generated for a User Defined Data Type, including Properties and SQL Source (where available). Also includes columns where the User Defined Data Type is used if documenting a Sql Server database.
Page generated for a File Group, including Properties and detailing the objects contained in the File Group.
Document! X can use descriptions and other content you define in SQL/T-SQL/PL-SQL Source Code, Access Description Properties or SQL Server Extended Properties and you can view the source content whilst you are editing in the Content File Editor to spot areas that need expansion and avoid duplication.
You can choose to author content in your SQL/T-SQL/PL-SQL Source Code, Access Description Properties or SQL Server Extended Properties, and/or using the rich authoring environment of the Document! X Content File editor. This flexibility allows you to include basic descriptive documentation in the source code and use the rich Document! X Content File editor to author extended content.
Document! X can extract specifically tagged comments from View, Stored Procedure and User Defined Function 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 manually using extended properties.
These short movies provide a great way to discover what can be achieved using Document! X.
This short introductory movie will take you through the process of creating a new Document! X Project for a Database (7 minutes).
This movie demonstrates the new Publishing functionality introduced in 2015.1. Publishing makes it easy to publish output generated by Document! X or HelpStudio to a web server or network location. A range of publishing methods are supported; you can publish to an Azure web site, a web site running on IIS, a web site that supports uploading via ftp, or directly to a local network path. (11 mins)
This video demonstrates how the Responsive Output feature allows you to generate content that automatically adapts to the device type of the browser, providing an optimal experience for Mobile, Tablet and Desktop users from a single output. (5 mins)
This short video provides a demonstration of how you can configure a project to create multiple outputs from a single source, with each output driven by a separate options defined in the Build Profile. (3 minutes)
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.
Document! X will also automatically colorize any SQL Examples you create in your documentation pages.
Your database documentation can be built to Browser Help, CHM (Html Help 1.x) or Microsoft Help Viewer (Visual Studio® 2010-2019). All of the specific requirements for the different output formats are handled for your automatically and you can build all outputs from a single project. Automatic publishing makes it quick and simple to deploy the generated output to your web site, ftp server or network location.
Browser Help output is viewable directly in the web browser, so is the ideal format for publishing documentation on a web site or intranet site. The browser help output includes a Table of Contents, Index and Full Text Search.
The automatically generated responsive support allows you to generate a single output that automatically adapts to the device profile; delivering an optimal browsing experience for Desktop, Tablet and Mobile from a single output. Tablet and Mobile devices benefit from buttonized links, a button based fly out Table of Contents and other automatic features that dramatically improve the end user experience.
Html Help 1.x (CHM) is the Microsoft Windows compiled help file format. When building to CHM, the output is a single file that can be deployed to, and viewed on, any machine with Windows installed. The CHM viewer includes a Table of Contents, Index and Full Text Search.
Your built documentation can be automatically published to a range of locations; a network path, ftp server, Azure web site or IIS (Internet Information Services) Server. Publishing recongizes which files have changed in the last build, so publishing is quick and minimizes network traffic.
The generated output can be automatically integrated with a range of Community Providers (Facebook, Disqus, Livefyre or SolidOpinion) allowing you to include rich community features in your help systems.
The template based configuration that Document! X is based on makes it easy to:
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.
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.