Document! X is a combination of an automated Web Service Documentation tool and a full documentation authoring environment which can be used to create accurate, professional quality Web Api documentation for both SOAP and REST services.
Document! X is not just an automated Web Service documentation build tool - it is also includes a fully featured documentation authoring environment allowing you to author supplementary content (descriptions of resource groups, resources, operations, parameters; hyperlinks to related pages or web sites etc.) where required.
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 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.
Document! X can use existing descriptions contained in the Web Service Definition (i.e. the SOAP WSDL, .swagger file or WCF Help Pages) where they are available. This means that you can leverage your existing investment in describing your Web Service.
You can also author content in Document! X Content Files if you would like to maintain some or all of the database documentation content outside of the Web Service Definition, or if you are not using a Web Service Definition that contains descriptions.
The full featured HTML Editor, Dynamic and Project Spell Check, Find and Replace and Link Check tools make authoring activities as productive as possible.
Document! X automatically generates comprehensive diagrams for any embedded XML Schemas in the SOAP services you are documenting. The XSD diagrams provide an easy to understand representation of your Schema structure.
Example Schema Diagram
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 from an XSD Schema file using Document! X. (10 mins)
This movie will take you through the process of producing documentation for a Web Service (SOAP or REST) using Document! X. (11 mins)
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).
This short introductory movie will take you through the process of creating a new Document! X Project for a Database (7 minutes).
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).
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)
Using an automated documentation tool immediately delivers the following benefits: