☰ Menu ☰ Menu 
Document! X is a combination of an automated .NET Documentation Tool and a full documentation authoring environment which can be used to create and maintain accurate, professional quality .NET documentation for assemblies created with any .NET language (C#, Visual Basic, C++/CLI, F# etc.).
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 and remarks for Namespaces, Classes, Interfaces, Enumerations, members, hyperlinks to related pages, example code, index kewords etc.) where required.
These short movies provide a great way to discover what can be achieved using Document! X.
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 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)
Document! X integrates directly with Visual Studio, allowing you to author your XML Source Comments from a unique Visual Comment Editor and build your documentation directly from within Visual Studio.
Lightbox The Document! X Visual Studio Visual Comment Editor provides a unique fully Visual Editor for your VB.NET, C# or C++/CLI source code comments, integrated directly with the Visual Studio IDE. The Visual Comment Editor allows you to create and edit Xml comments in a WYSIWYG preview of the generated documentation.
Lightbox Even though you can author your content in a fully WYSIWYG editor, comments created or edited with the Visual Comment Editor are written back to your source code in standard XML source comment format.
Lightbox 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 Build your documentation projects directly from Visual Studio. Integrate Document! X with your team build using the provided command line build .exe, msbuild task or Workflow activity.
You can choose to author content in your XML source comments, and/or using 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 (e.g. examples, tutorials, more detailed descriptions etc.).
Lightbox In combination with, or as an alternative to authoring content in Xml Source Comments, create and maintain documentation content using the Document! X Content File Editor.
Lightbox The Document! X Content File editor shows you the .NET Xml source comments whilst you are editing, so that you can instantly see where the source documentation might require additional detail or replacement. Document! X will automatically populate the description of members inherited from elsewhere in your assembly or the .NET Framework to further reduce the amount of documentation authoring effort.
Lightbox A specific designer is included in both the Visual Studio Comment Editor and the Content File Editor to make creating examples quick and easy. Paste example code or use existing code files (or named regions within them) as your source.
Lightbox The generated documentation for classes and structures will automatically include an Object Relationship Diagram. These diagrams are invaluable in helping users of your documentation make sense of the object model contained in your .NET Assemblies.
Lightbox No matter where you decide to author your descriptive content, your assembly xml comment file can always be in sync - Document! X can generate an Xml comment file during build that always reflects the content of the generated documentation so intellisense will be always be accurate and up to date.
Lightbox Document! X can output to a variety of formats, including browser help for publishing to a website, CHM and Microsoft Help Viewer. Microsoft Help Viewer is the help technology used by Visual Studio. Integrating documentation with Microsoft Help Viewer ensures that help for the assemblies you document is only ever an F1 key press away.
Your documentation projects can be built to a variety of different outputs; Browser Help, CHM (Html Help 1.x), HXS (Visual Studio 2002-2008) and 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 output formats 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.
Lightbox Microsoft Help Viewer is the help technology used by Visual Studio 2010-2015. Building Microsoft Help Viewer output and integrating your documentation with Microsoft Help Viewer ensures that help for the assemblies you document is only ever an F1 key press away to Visual Studio users.
Lightbox 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.
Lightbox 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.
Lightbox Help 2.x is a compiled help format used by Visual Studio 2002-2008. You would choose this format if you need to integrate your generated documentation with these Visual Studio versions. The Help 2.x viewer includes a Table of Contents, Index and Full Text Search.
Lightbox 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.
Lightbox 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.
Lightbox 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.
Lightbox Overview of the class, including an automatically generated Object Relationship Diagram, Inheritance Hierarchy and Syntax in multiple .NET languages.
Lightbox Type members page, listing the methods, properties, fields, events and extension methods implemented by this type.
Lightbox Page for a specific constructor overload, including a link to the method summary page listing other overloads.
Lightbox Namespace overview page, listing the classes, structures, interfaces, delegates and enumerations defined in the namespace.
Lightbox Namespace hierarchy documenting the inheritance hierarchy of all types defined in the namespace.
Document! X doesn't just document .NET Assemblies, it supports a wide variety of solution elements. One consistent and comprehensive toolset for all of your technical documentation requirements.
