Document! X is a combination of an automated documentation tool and a complete authoring environment that can be used to create, publish and maintain accurate, professional-quality documentation for .NET, Web Services, Databases, XSD Schemes, COM Components and Type libraries, Java and Javascript.
Document! X is not just an automated documentation creation tool – it includes a complete documentation authoring environment, allowing you to complement the automatically generated content when needed.
Document! X has been the trusted documentation solution for individuals and corporations worldwide since 1998
Document the entire solution
Document! X supports a wide variety of solution elements. A consistent, customizable and comprehensive set of tools for all your technical documentation requirements.
.NET assemblies
.NET Framework Assemblies (.NET 1.0 – 4.x, .NET Standard, .NET Core, Silverlight)
Web Services
Swagger, WCF, WSDL, WADL or Other REST or SOAP
Data base
Access, SQL Server, Oracle or another OLEDB
XSD Schemes
XSD schema files or implicit Xml schemas from Xml files
Java Projects
From the Java source code created with any Java development tool.
WITH
COM components, controls, or compiled type libraries
Sample outputs
These output examples illustrate how much can be generated by Document! X straight out of the box. The whole document! The X models 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, builder overload page
Page for a specific overload of the .NET constructor, 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 a complex XSD Type, including a type diagram, an overview data tree and the 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 (when available). It also includes dependencies if you are documenting a Sql Server database.
Lightbox
Web service documentation, GET operation page
Page generated for a GET Operation on a REST Web Service. Details the parameters, request / response data types and any failure responses.
Lightbox
Web service documentation, method page
Page generated for a SOAP Web Service method. Details the parameters, request / response data types and any failure responses.
Lightbox
Web service documentation and XSD schema, diagrams
Schema diagrams are automatically generated for web service operations using XSD Types and XSD documentation pages.
Demonstration films
These short films offer a great way to find out what can be achieved using Document! X.
Documenting a database
This short introductory film will guide you through the process of creating a new document! X Project for a database (7 minutes).
Documenting a COM component
This short introductory film will guide you through the process of creating a new document! X Project for a COM component or a type library (6 minutes).
Documenting an Xsd schema
This film will guide you through the documentation production process from an XSD Schema file using Document! X. (10 minutes)
Documenting a Javascript library
This film will demonstrate how Document! X can be used to create documentation for Javascript, both simple libraries of javascript functions and models of javascript objects and jQuery plugins and widgets. (13 mins)
Documenting a web service
This film will guide you through the process of producing documentation for a web service (SOAP or REST) using Document! X. (11 minutes)
Documenting .NET assemblies
This introductory film will guide you through the process of creating a new document! X Project for one or more Microsoft .NET assemblies (13 minutes).
Publishing to a website, FTP server or network location
This film demonstrates the new publishing functionality introduced in 2015.1. Publishing facilitates the publication of the output generated by Document! X or HelpStudio for a web server or network location. A variety of publishing methods are supported; you can publish to an Azure website, a website running on IIS, a website that supports uploading via ftp or directly to a local network path. (11 mins)
Finding undocumented items
This film provides a quick introduction to finding items in a project that still requires documentation using the Undocumented Items tool. (4 minutes)
Using document! X with Visual Studio 2010
This film demonstrates how Document! X integrates with Visual Studio 2010 and how it can become part of a routine development documentation workflow (5 minutes).
Introduction to source control
This video provides a demonstration of how to enable Source Control functionality, add a project to Source Control and access Source Control features in a Source Control-enabled project. (6 mins)
Automatic optimization for tablets and mobile devices
This video demonstrates how the Responsive Output feature allows you to generate content that automatically adapts to your browser’s device type, providing an ideal experience for users of mobile devices, tablets and computers from a single output. (5 minutes)
Introduction to location features
This video will demonstrate how to use the localization features, enabling localization and creating an output in English and Japanese from the document! Sample project X .NET (9 minutes).
Using Build Profiles to create multiple outputs
This short video provides a demonstration of how you can set up a project to create multiple outputs from a single source, with each output driven by separate options defined in the build profile. (3 minutes)
Why use documents! X?
Developing accurate documentation, particularly for complex components or database schemas, has traditionally been a time-consuming, costly and skill-intensive task. Documentation during development can be seen as a moving target, and at the end of a project, developers are usually reassigned immediately to new development tasks, which can leave most projects poorly documented.
With document! X, documentation can be produced automatically throughout design and development without requiring the investment of developer resources, providing development teams with an accurate and up-to-date reference and allowing new developers to jump the learning curve for new components and schemas. Document! X makes the production of documentation a natural and productive activity for developers and technical writers.
- Fast, accurate and professional quality documentation;
- Market-leading authoring tools for creating supplemental content;
- Automatically uses source content when available (XML xml source comments, web service definition descriptions, extended SQL Server properties, SQL / T-SQL / PL-SQL source comments, XSD annotations, source comments Javascript JsDoc or Xml format, Java Javadoc comments format source, COM HelpStrings);
- The customizable template-driven output based on HTML can be adapted to your requirements and is supplied with pre-translated standard phrases for 9 different languages;
- Generate documentation for HTML Help 1.x (CHM), Help 2.x, Microsoft Help Viewer (Visual Studio Help Format) or Help for the pure web-ready HTML browser, including a Table of Contents, Full Text Search and Index.
Content creation options
You can choose to create the content in your source code (using XML xml source comments, web service definition descriptions, extended SQL Server properties, SQL / T-SQL / PL-SQL source comments, XSD annotations , XSD annotations, JsDoc or Xml Javascript source comments, Java Javadoc 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 for creating extended content or making post-development edits.
Lightbox
Content File Editor (.NET Documentation)
In combination with or as an alternative to creating content in source comments (.NET documentation illustrated here), create and maintain the content of the documentation using Document! X Content file editor.
Lightbox
Content file editor (database documentation)
In combination with or as an alternative to creating content in source comments (database documentation illustrated here), create and maintain the content of the documentation using the document! X Content file editor.
Lightbox
Source comments always visible
The document! The X Content File editor shows the source comments (source comments in .NET Xml format, COM HelpStrings, XSD Annotations, web service descriptions, SQL / T-SQL / PL-SQL source comments, Javadoc comments, comments JsDoc) while you are editing (.NET is shown here), so you can instantly see where the source documentation may require additional details or replacement. Document! X will automatically populate the description of members inherited from other parts of your assembly or the .NET Framework to further reduce the amount of documentation creation effort.
Lightbox
Object model digrams
The documentation generated for classes and structures in the .NET, Java, COM and Javascript documentation will automatically include an object relationship diagram. These diagrams are invaluable in helping users of your documentation to understand the object model contained in their components.
Lightbox
Visual Studio F1 Help integration
Document! X can produce in a variety of formats, including browser help for publication on a website, CHM and Microsoft Help Viewer. Microsoft Help Viewer is the help technology used by Visual Studio. The integration of documentation into the Microsoft Help Viewer ensures that help for the assemblies you document is pressed only once with the F1 key.
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 Comments Editor is included to create and maintain your source code comments in Visual Source .NET, C #, C ++ / CLI and F #.
Create and maintain your Visual Basic .NET, C #, C ++ / CLI, or F # source code comments directly within a preview of what the generated documentation will look like.
Lightbox
Visual Studio Comment Editor
The document! X The Visual Studio Visual Comment Editor provides a totally unique visual editor for your VB.NET, C # or C ++ / CLI source code comments, integrated directly into the Visual Studio IDE. The Visual Comments Editor allows you to create and edit XML comments in a WYSIWYG view of the generated documentation.
Lightbox
Standard XML source comments
Even though you can create your content in a fully WYSIWYG editor, comments created or edited with Visual Comment Editor are written back to your source code in the standard XML source comments 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
Compile from Visual Studio
Create your documentation projects directly from Visual Studio. Integrate document! X with your team created using the command line provided .exe, msbuild task or workflow activity.
Our clients
Large and small organizations rely on Innovasys products for their documentation and help authoring requirements. Some of the most well-known organizations are listed below.
Learn more about the document! X
Planning to use the document! X for a specific type of documentation or are you looking for a case study? Check out the resource guide, functional area and case study pages below for information on targeted products, examples and screenshots.
