Document! X is a combination of an automated XSD Documentation Tool and a full documentation authoring environment which can be used to create and maintain accurate, professional quality documentation for XSD Schemas.
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 XSD Schema Description Annotations where available and create additional content in a rich and easy to use WYSIWYG authoring environment.
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 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)
You can choose to author content in your XSD Source (using standard XSD Annotations) 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.
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.
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 XSD Schema, listing the documented Elements, Complex Types, Simple Types, Groups, Attribute Groups and Attributes.
Page generated for an XSD Element, including a diagram, data tree and XSD Source Code.
Page generated for an XSD Complex Type, including a type diagram, overview data tree and XSD Source Code.
Page generated for an XSD Simple Type, including a type diagram, overview data tree and XSD Source Code.
Page generated for an Attribute Group, detailing the attributes contained within and XSD Source Code.
>Page generated for an Attribute Group, detailing the type information and XSD Source Code.
Schema diagrams are automatically generated on XSD documentation pages.
Document! X doesn't just document XSD Schemas, it supports a wide variety of solution elements. One consistent and comprehensive toolset for all of your technical documentation requirements.