☰ Menu
+1 866.606.7247
×

Popular Searches

Technical Writing Documentation Services Training Methods User Documentation Consulting Services

API and Web Service
Documentation Customer Login Contiem Store

Document! X delivers the best of both worlds by seamlessly combining automatic documentation of Web Services (SOAP and REST) with a full WYSIWYG authoring environment. The generated Web Service documentation forms a comprehensive documentation set for your Web Services covering resource groups, operations, requests, responses and parameters.

Document! X can use a variety of definition sources — WSDL, WADL, Swagger, WCF REST Help Pages — to automatically determine the structure of your Web Service, or you can add an empty Web Service to the project and define the structure manually.

Content Authoring Options

If you have already defined descriptions in your source Web Service Definition (WSDL Annotations, Swagger Descriptions etc.), Document! X can use them as summary text for the generated documentation and you can view the Web Service Definition Descriptions while you are editing to spot areas that need expansion and to avoid duplication.

You can choose to author content in your Web Service Definition (WSDL Annotations, Swagger Descriptions etc.), and/or using the rich authoring environment of 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.

XSD (XML Schema Definition) Diagrams
Source Descriptions
Data Trees
Content File Editor
PlayPause
previous arrow
next arrow
 
Shadow

Single-Source Build and Publish

Your documentation projects can be generated to cross-platform Web Help, automatically responsive for tablet and mobile, or printable PDF. The specific requirements for the different output formats are handled automatically and you can build all outputs from a single project. Automatic publishing makes it quick and simple to deploy the generated output to your website, FTP server, or network location.

Responsive Output
Automatic Publishing
Community Features
Web Help
PlayPause
previous arrow
next arrow
 
Shadow

Output Samples

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.

GET Operation Page (REST Web Service)
POST Operation Page (REST Web Service)
DELETE Operation Page (REST Web Service)
JSON Schema Page
XSD (XML Schema Definition) Diagram
Web Service Overview Page
Method Page (SOAP Web Service)
Resource Group Overview Page (REST Web Service)
PlayPause
previous arrow
next arrow
 
Shadow

Template-Based Customization

  • 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 sharing content with translation providers.

Questions?

Contact Us

Try Document! X and HelpStudio

Trials

Purchase or Upgrade Document! X and HelpStudio

Contiem Store