Document! X delivers the best of both worlds by seamlessly combining automatic documentation of Web Services (SOAP and REST) with a full WYSIWYG authoring environment. The generated Web Service documentation forms a comprehensive documentation set for your Web Services covering resource groups, operations, requests, responses and parameters.
Document! X can use a variety of definition sources (WSDL, WADL, Swagger, WCF REST Help Pages) to automatically determine the structure of your web service, or you can add an empty Web Service to the project and define the structure manually.
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 Web Service, listing the contents of the web service.
Page generated for a method. Details the parameters, request/response data types and any fault responses.
Page generated for a resource group, listing the operations contained within.
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 POST Operation in a REST Web Service. Details the parameters, request/response data types and any fault responses.
Page generated for a DELETE Operation in a REST Web Service. Details the parameters, request/response data types and any fault responses.
Page generated for a Json Schema referenced by the web service.
Schema diagrams are automatically generated for operations that use XSD Types and are included inline with the request/response documentation.
If you have already defined descriptions in your source Web Service Definition (WSDL Annotations, Swagger Descriptions etc.), Document! X can use them as summary text for the generated documentation and you can view the web service definition descriptions whilst you are editing to spot areas that need expansion and avoid duplication.
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.
If your web service definition contains embedded XSD Xml Schemas, Document! X will automatically document them. In addition to documenting the Xml Schema objects themselves, Document! X will also generate relationship diagrams to illustrate the relationships between schema items (example below).
These short movies provide a great way to discover what can be achieved using Document! X.
This movie will take you through the process of producing documentation for a Web Service (SOAP or REST) using Document! X. (11 mins)
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)
Your documentation projects 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.