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 movie provides a quick introduction to finding items in a project that still require documentation by using the Undocumented Items tool. (4 mins)
This movie demonstrates how Document! X integrates with Visual Studio 2010 and how it can become part of a routine development documentation workflow (5 mins).
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)
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 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).
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.
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.
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.
Document! X can document assemblies created with any Visual Studio language. The Visual Comment Editor supports C#, Visual Basic, C++/CLI and F# projects.
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.).
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-2017). 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.
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.
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.
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.
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 class, including an automatically generated Object Relationship Diagram, Inheritance Hierarchy and Syntax in multiple .NET languages.
Type members page, listing the methods, properties, fields, events and extension methods implemented by this type.
Page for a specific constructor overload, including a link to the method summary page listing other overloads.
Page for an overloaded method, listing the defined overloads.
Enumeration overview page, listing the enumeration members.
Namespace overview page, listing the classes, structures, interfaces, delegates and enumerations defined in the namespace.
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.