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 supports a wide variety of solution elements. One consistent, customizable and comprehensive toolset for all of your technical documentation requirements.
.NET Framework Assemblies (.NET 1.0 - 6, .NET Standard, .NET Core)
REST or SOAP from Swagger, WCF, WSDL, WADL or Other
Access, SQL Server, Oracle or other OLEDB
Plain Javascript, jQuery plugins and jQuery UI Widgets
XSD Schema files or implied XML Schemas from XML files
From Java source code created with any Java development tool.
Compiled COM Components, Controls or Type Libraries
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 a .NET class, including an automatically generated Object Relationship Diagram, Inheritance Hierarchy and Syntax in multiple .NET languages.
Page for a specific .NET constructor overload, including a link to the method summary page listing other overloads.
Overview of the COM class, including an automatically generated Object Relationship Diagram.
Page generated for an XSD Complex Type, including a type diagram, overview data tree and XSD Source Code.
Page generated for a Javascript method, documenting the syntax and parameters.
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 GET Operation in a REST Web Service. Details the parameters, request/response data types and any fault responses.
Page generated for a SOAP Web Service method. Details the parameters, request/response data types and any fault responses.
Schema diagrams are automatically generated for web service operations that use XSD Types and XSD documentation pages.
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.
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.
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.
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.
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.
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.
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.
Document! X integrates seamlessly with Visual Studio® 2010-2022. 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.
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.
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.
Document! X can document assemblies created with any Visual Studio language. The Visual Comment Editor supports C#, Visual Basic, C++/CLI and F# projects.
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.
Organizations large and small trust Innovasys products for their Documentation and Help Authoring requirements. Some of the more well known organizations are listed below.
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.