Document! X and HelpStudio 2019
In This Topic
    Welcome to Document! X
    In This Topic

    What is Document! X

    Document! X is a documentation and help authoring tool to aid you in the production of technical reference documentation. Document! X automates the production of the core reference information, using existing source content (.NET Xml comments, TSQL comments, COM Typelib HelpStrings, Database descriptions, Javadoc comments, XSD Annotations) where available whilst still allowing you to author additional content in a comprehensive authoring environment.

    Document! X delivers all of the benefits of automated, accurate and comprehensive documentation without sacrificing your ability to customize, supplement and extend the generated content.

    Document! X allows you to concentrate on developing help content by automatically laying out generated Topics in a consistent and professional style. This template based approach to help development makes it easy to change and evolve the look and feel of your help project without requiring any rework in the help content itself.

    When installed with HelpStudio, Document! X can import existing HTML files, HTML Help 1.x Projects, Microsoft Help 2.x Projects, RoboHelp Projects and Word Documents.

    Items you can automatically document

    Document! X shortcuts the otherwise lengthy process of generating technical documentation and context sensitive help for:

    Generated Output

    Output Formats

    Document! X can generate:

    • Cross-platform Web Help, with expandable Table of Contents, Index and Full Text Search (with search term highlighting);
    • Compiled HTML Help 1.x files;
    • Compiled Microsoft Help 2.x help files (Visual Studio 2002-2008 help format);
    • Compiled Microsoft Help Viewer help files (Visual Studio 2015, 2017 and 2019 help format);
    • Pdf Booklets (containing conceptual topics).

    All outputs are generated from XML and XHTML based content.


    What is generated

    Document! X generates a comprehensive set of HTML files, optionally compiled into an HTML Help 1.x, Microsoft Help 2.x or Microsoft Help Viewer file. Generated content includes:

    • A full Table of Contents and Index;
    • Full text search;
    • F1 Context Sensitive / Visual Studio Dynamic Help support;
    • Object Relationship Diagrams;
    • Inheritance Trees and Language Filtered Syntax Summaries (.NET only)
    • and much more.


    Standard look and feel

    The standard templates shipped with Document! X reflect the current Microsoft standard for technical documentation in order to provide a consistent and familiar style and layout. Developers will feel immediately at home with the documentation you create.

    Templates can be fully customized (including the Table of Contents, Page Type and style, color schemes etc.) without having to rework content.


    Getting Started Movies

    There are several movies that provide a great introduction to Document! X functionality and concepts: