Glossary Item Box

Document! X - documentation made easy

Click here for examplesDocument! X automates the process of creating and maintaining documentation for a wide range of solution elements:

  • VB.NET/C#/Visual C++ .NET Projects (.NET Framework 1.0, 1.1, 2.0, 3.0 and 3.5);
  • Visual Basic 5 or 6 Projects;
  • Compiled COM Components and Controls;
  • COM Type Libraries;
  • ASP.NET Ajax Javascript;
  • Access, SQL Server and Oracle Databases;
  • XSD Schemas or implied XML Schemas.

Why use Document! X?

Developing accurate documentation, particularly for complex components or XSD schemas, has traditionally been a time consuming, costly and skills intensive task. Documentation during development can be seen as a moving target and at the end of a project developers are often immediately re-assigned to new development tasks, which can leave most projects poorly documented.

With Document! X, documentation can be automatically produced throughout design and development without requiring investment of developer resources, providing development teams with an accurate and up to date reference and allowing new developers to jump the learning curve of new components and schemas. Document! X makes producing documentation a natural and productive activity for developers and technical writers alike.

Document! X is the documentation tool chosen by world leading component companies including Infragistics, Data Dynamics, Dundas, Janus Systems and Telerik for their commercial documentation requirements.

Click here for larger screenshots

Content Authoring

The revolutionary authoring tools included in Document! X allow you to author additional content directly within a preview of the automatically generated page - seamlessly combining the benefits of automated documentation with fully featured authoring tools.

The same 'Full Page Edit' functionality is available within the Visual Basic 6 and Visual Studio (2002, 2003, 2005 and 2008) environments - allowing you to author and maintain your Visual Basic, Visual Basic .NET and C# source code comments directly within a preview of how the generated documentation will look.

In addition to making use of Visual Basic, Visual Basic .NET, C#, C++/CLI and ASP.NET Ajax Javascript source code comments, Document! X can use comments from Transact-SQL code, SQL Server extended attributes, XSD Schema annotations and Type Library HelpStrings.

Visual Studio and Visual Basic 6 Integration

Document! X integrates seamlessly with the Visual Basic and Visual Studio environments. Documentation Projects can be created, opened and built without leaving the development environment.

Visual Comment editors are included for creating and maintaining your source code comments in Visual Basic, Visual Basic .NET and C# source code. Content can be authored both in source code comments and in Content Files using the Document! X Content Tools. This approach makes it easy to make post-development edits and author additional content outside of the source code.

Customization

The template based configuration that Document! X is based on makes it easy to:

  • Create new content types (e.g. change history, fixed bugs);
  • Add additional standard pages to the generated documentation (for example a glossary or company information);
  • Adapt existing templates to match your existing corporate style and color scheme;
  • Customize Table of Contents definitions according to your requirements;
  • Fine tune the standard phrases and terminology used by Document! X to match your standards. Document! X ships with in-built support for English, French, German, Dutch, Italian and Russian language output.  

Help where you need it

Document! X includes a comprehensive help system, including a Contents, Index and Dynamic Help window. The Dynamic Help window (available in the Document! X IDE, Visual Basic and Visual Studio) provides a list of help topics, tutorials, getting started guides and movies relevant to your current activity enabling both new and experienced users to get to grips with Document! X functionality as quickly as possible.

Document! X includes several printable 'Getting Started' PDF booklets to enable you to get immediate results from Document! X.