Glossary Item Box

Document! X for Technical Writers

Document! X provides a highly productive environment in which Technical Writers can author, edit and validate documentation content.

Authoring content

The Document! X Content File Editor provides a fully featured HTML based authoring environment, where content for the documentation generated by Document! X can be created and edited.

Document! X Application with a Content File Editor window open

Document! X Application with a Content File Editor window open

View a movie demonstrating the Document! X Content Authoring functionality

In addition to the Content File Editor, the Document! X IDE provides tools to aid with editing and validating content. These tools can be used when one or more Content Files are open for editing.

  • Project Find and Replace allows project wide changes to be made.
  • Project Spell Check allows the spelling in one or more open content files to be validated. Ignore words are stored with the Content File and spell check operations can be limited to content changed since the last spell check, minimizing the amount of effort required to ensure correct spell checking over time.
  • Project Link check allows you to validate that hyperlinks and image references within the authored content are valid.

Customization

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

  • Create new comment types for use in source code comments;
  • 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.

Authoring examples

The easy to use Example code designer included in the Content Editors makes adding multi-language examples a breeze. In-line or linked examples can be created and example code is automatically colorized in the generated output.

Localization

Document! X supports several different languages (English, French, German, Dutch, Italian and Russian)  for the phrases used in the generated output. All of the phrases and terminology in the generated output can be configured according to preference.

Document! X allows you to author content for multiple languages within a single project, showing you an embedded tip for the primary locale content when you are authoring in the Content File Editor for a secondary locale. If you use the Document! X and HelpStudio bundle you can export and import your localized content in XLIFF format; the industry standard for sending and receiving translation content from translation providers.