Document! X Info Pages:

Web Service Documentation Made Easy

Document! X is a combination of an automated Web Service Documentation Tool and a full documentation authoring environment which can be used to create and maintain accurate, professional quality documentation for SOAP or REST Web Services.

Document! X is not just an automated documentation build tool - it is also includes a fully featured documentation authoring environment allowing you to author supplementary content (descriptions of web service resources and operations, hyperlinks to related pages or web sites etc.) where required. Leverage your existing Web Service descriptions (WSDL Annotations, Swagger Descriptions etc.) where available and create additional content in a rich and easy to use WYSIWYG authoring environment.

Document! X produces a professional quality Web Service documentation set - automatically - with the ability to author additional content outside of the web service definition.

Download a Free Trial Version

Why Use Document! X?

Fast, accurate, professional quality Web Service documentation for SOAP and REST Web Services;
Market leading authoring tools for creating supplementary content;
Document resource groups, resources, operations, parameters, requests, responses, faults, Json Schemas and embedded XSD Schemas (SOAP);
Customizable HTML based template driven output can be adapted to your requirements;
Generates documentation to HTML Help 1.x (CHM) or web ready pure HTML including a full Table of Contents, Index and Full Text Search.

Demonstration Movies

These short movies provide a great way to discover what can be achieved using Document! X.

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)

View this Movie

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)

View this Movie

Finding Undocumented Items

This movie provides a quick introduction to finding items in a project that still require documentation by using the Undocumented Items tool. (4 mins)

View this Movie

Introduction to Source Control

This video provides a demonstration on 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)

View this Movie

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)

View this Movie

Introduction to Localization features

This video will demonstrate how to use the localization features by enabling localization and creating both an English and Japanese output from the Document! X .NET sample project (9 mins).

View this Movie

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)

View this Movie

More Movies

Content Authoring Options

You can choose to author content in your Web Service Definition (WSDL Annotations, Swagger Descriptions etc.), and/or using the rich authoring environment of the Document! X 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.

Content File Editor

In combination with, or as an alternative to authoring content in Web Service Definition descriptions (e.g. WSDL annotations, Swagger descriptions), create and maintain documentation content using the Document! X Content File Editor.

Show Source Descriptions

Whilst you are authoring in the Content File Editor, any descriptions automatically obtained from the Web Service Definition are shown (the gray boxes above the editable areas in the screenshot). This makes it quick and easy to spot content that needs extending or overriding.

XSD Schema Diagrams

Wherever an Xml datatype is referenced in your Web Service (via an imported or embedded XSD Schema), the generated documentation will include an XSD Schema Diagram. These diagrams are invaluable in making sense of complex data structures.

Data Trees

Wherever your request or response references a complex data type, Document! X will automatically generate a data tree that visually illustrates the hierarchy of your data type.

Single Source Build and Publish

Your documentation projects can be built to Browser Help, CHM (Html Help 1.x) or Microsoft Help Viewer (Visual Studio® 2010-2017). 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

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.

Tablet and Mobile Support

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)

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.

Publish to network path, ftp, Azure and IIS

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.

Community Features

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.

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.

Web Service Overview Page

Overview of the Web Service, listing the contents of the web service.

Method Page (SOAP Web Service)

Page generated for a method. Details the parameters, request/response data types and any fault responses.

Resource Group Overview Page (REST Web Service)

Page generated for a resource group, listing the operations contained within.

GET Operation Page (REST Web Service)

Page generated for a GET Operation in a REST Web Service. Details the parameters, request/response data types and any fault responses.

POST Operation Page (REST Web Service)

Page generated for a POST Operation in a REST Web Service. Details the parameters, request/response data types and any fault responses.

DELETE Operation Page (REST Web Service)

Page generated for a DELETE Operation in a REST Web Service. Details the parameters, request/response data types and any fault responses.

Json Schema Page

Page generated for a Json Schema referenced by the web service.

XSD Schema Diagram

Schema diagrams are automatically generated for operations that use XSD Types and are included inline with the request/response documentation.

Live Samples

Document Everything

Document! X doesn't just document Web Services, it supports a wide variety of solution elements. One consistent and comprehensive toolset for all of your technical documentation requirements.