Documentation Made Easy
Document! X is a combination of an automated documentation tool and a full authoring environment which can be used to create, publish and maintain accurate, professional quality documentation for .NET, Web Services, Databases, XSD Schemas, COM Components and Type Libraries, Java and Javascript.
Document! X is not just an automated documentation build tool - it includes a fully featured documentation authoring environment allowing you to supplement the automatically generated content where required.
Document! X is the documentation solution trusted by individuals and corporations worldwide since 1998
Document The Whole Solution
Document! X supports a wide variety of solution elements. One consistent, customizable and comprehensive toolset for all of your technical documentation requirements.
.NET Assemblies
.NET Framework Assemblies (.NET 1.0 - 4.x, .NET Standard, .NET Core)
Web Services
REST or SOAP from Swagger, WCF, WSDL, WADL or Other
Databases
Access, SQL Server, Oracle or other OLEDB
Javascript Libraries
Plain Javascript, jQuery plugins and jQuery UI Widgets
XSD Schemas
XSD Schema files or implied Xml Schemas from Xml files
Java Projects
From Java source code created with any Java development tool.
COM
Compiled COM Components, Controls or Type Libraries
Sample Outputs
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.
Lightbox .NET Documentation, Class Overview Page
Overview of a .NET class, including an automatically generated Object Relationship Diagram, Inheritance Hierarchy and Syntax in multiple .NET languages.
Lightbox .NET Documentation, Constructor Overload Page
Page for a specific .NET constructor overload, including a link to the method summary page listing other overloads.
Lightbox COM Documentation, Class Overview Page
Overview of the COM class, including an automatically generated Object Relationship Diagram.
Lightbox XSD Documentation, Complex Type Page
Page generated for an XSD Complex Type, including a type diagram, overview data tree and XSD Source Code.
Lightbox Javascript Documentation, Method Page
Page generated for a Javascript method, documenting the syntax and parameters.
Lightbox Database Documentation, Table Page
Page generated for a Table, including Properties, Columns, Indexes, Relationships and SQL Source (where available). Also includes dependencies if documenting a Sql Server database.
Lightbox Web Service Documentation, GET Operation Page
Page generated for a GET Operation in a REST Web Service. Details the parameters, request/response data types and any fault responses.
Lightbox Web Service Documentation, Method Page
Page generated for a SOAP Web Service method. Details the parameters, request/response data types and any fault responses.
Lightbox Web Service and XSD Schema Documentation, Diagrams
Schema diagrams are automatically generated for web service operations that use XSD Types and XSD documentation pages.
Demonstration Movies
These short movies provide a great way to discover what can be achieved using Document! X.
Documenting an Xsd Schema
This movie will take you through the process of producing documentation from an XSD Schema file using Document! X. (10 mins)
Documenting a Javascript Library
This movie will demonstrate how Document! X can be used to create documentation for Javascript, both simple javascript function libraries as well as javascript object models and jQuery plugins and widgets. (13 mins)
Documenting a Web Service
This movie will take you through the process of producing documentation for a Web Service (SOAP or REST) using Document! X. (11 mins)
Documenting .NET Assemblies
This introductory movie will take you through the process of creating a new Document! X Project for one or more Microsoft .NET Assemblies (13 minutes).
Documenting a Database
This short introductory movie will take you through the process of creating a new Document! X Project for a Database (7 minutes).
Documenting a COM Component
This short introductory movie will take you through the process of creating a new Document! X Project for a COM Component or Type Library (6 minutes).
Publishing to a web site, ftp server or network location
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)
Automatic optimization for Tablet and Mobile devices
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)
Using Build Profiles to create multiple outputs
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)
Why Use Document! X?
Developing accurate documentation, particularly for complex components or database schemas, has traditionally been a time consuming, costly and skills intensive task. Documentation during development can be seen as a moving target and at the end of a project developers are often immediately re-assigned to new development tasks, which can leave most projects poorly documented.
With Document! X, documentation can be automatically produced throughout design and development without requiring investment of developer resources, providing development teams with an accurate and up to date reference and allowing new developers to jump the learning curve of new components and schemas. Document! X makes producing documentation a natural and productive activity for developers and technical writers alike.
- Fast, accurate, professional quality documentation;
- Market leading authoring tools for creating supplementary content;
- Automatically uses source content where available (.NET xml source comments, Web Service Definition descriptions, SQL Server Extended Properties, SQL/T-SQL/PL-SQL source comments, XSD Annotations, Javascript JsDoc or Xml format source comments, Java Javadoc format source comments, COM HelpStrings );
- Customizable HTML based template driven output can be adapted to your requirements and ships with standard phrases pre-translated to 9 different languages;
- Generate documentation to HTML Help 1.x (CHM), Help 2.x, Microsoft Help Viewer (Visual Studio Help Format) or web ready pure HTML Browser Help including a full Table of Contents, Index and Full Text Search.
Content Authoring Options
You can choose to author content in your Source Code (using .NET xml source comments, Web Service Definition descriptions, SQL Server Extended Properties, SQL/T-SQL/PL-SQL source comments, XSD Annotations, Javascript JsDoc or Xml format source comments, Java Javadoc format source comments, COM HelpStrings ) and/or using the rich authoring environment of the Content File editor.
This flexibility allows you to include basic documentation in the source code and use the rich Document! X Content File editor to author extended content or make post-development edits.
Lightbox Content File Editor (.NET Documentation)
In combination with, or as an alternative to authoring content in source comments (.NET documentation illustrated here), create and maintain documentation content using the Document! X Content File Editor.
Lightbox Content File Editor (Database Documentation)
In combination with, or as an alternative to authoring content in source comments (Database documentation illustrated here), create and maintain documentation content using the Document! X Content File Editor.
Lightbox Source comments always visible
The Document! X Content File editor shows you the source comments ( .NET Xml format source comments, COM HelpStrings, XSD Annotations, Web Service Descriptions, SQL/T-SQL/PL-SQL Source Comments, Javadoc comments, JsDoc comments) whilst you are editing (.NET is shown here), so that you can instantly see where the source documentation might require additional detail or replacement. Document! X will automatically populate the description of members inherited from elsewhere in your assembly or the .NET Framework to further reduce the amount of documentation authoring effort.
Lightbox Object Model Digrams
The generated documentation for classes and structures in .NET, Java, COM and Javascript documentation will automatically include an Object Relationship Diagram. These diagrams are invaluable in helping users of your documentation make sense of the object model contained in your components.
Lightbox Visual Studio F1 Help Integration
Document! X can output to a variety of formats, including browser help for publishing to a website, CHM and Microsoft Help Viewer. Microsoft Help Viewer is the help technology used by Visual Studio. Integrating documentation with Microsoft Help Viewer ensures that help for the assemblies you document is only ever an F1 key press away.
Visual Studio Integration
Document! X integrates seamlessly with Visual Studio® 2010-2019. Documentation Projects can be created, opened and built directly from your Visual Studio solution. A Visual Comment Editor is included for creating and maintaining your source code comments in Visual Basic .NET, C#, C++/CLI and F# source code.
Author and maintain your Visual Basic .NET, C#, C++/CLI or F# source code comments directly within a preview of how the generated documentation will look.
Lightbox Visual Studio Comment Editor
The Document! X Visual Studio Visual Comment Editor provides a unique fully Visual Editor for your VB.NET, C# or C++/CLI source code comments, integrated directly with the Visual Studio IDE. The Visual Comment Editor allows you to create and edit Xml comments in a WYSIWYG preview of the generated documentation.
Lightbox Standard Xml Source Comments
Even though you can author your content in a fully WYSIWYG editor, comments created or edited with the Visual Comment Editor are written back to your source code in standard XML source comment format.
Lightbox Your .NET Language of Choice
Document! X can document assemblies created with any Visual Studio language. The Visual Comment Editor supports C#, Visual Basic, C++/CLI and F# projects.
Lightbox Build from Visual Studio
Build your documentation projects directly from Visual Studio. Integrate Document! X with your team build using the provided command line build .exe, msbuild task or Workflow activity.
Our Customers
Organizations large and small trust Innovasys products for their Documentation and Help Authoring requirements. Some of the more well known organizations are listed below.
Learn More About Document! X
Planning to use Document! X for a specific type of documentation, or looking for a case study? Check out the feature guide, functional area and case study pages below for targeted product information, examples and screenshots.
Feature Guides
Functional Areas
Products
Community
+1 (844) 591-6865
+44 800 029 1435
sales@innovasys.com
Contact Us | Terms and Conditions | Privacy Policy
Copyright @2021 Innovasys Limited. All Rights Reserved.
Document! X 2021.1
HelpStudio 2021.1