What Is Autodoc?

Autodoc is a tool developed in-house by OnResolve that documents ClearQuest schemas - allowing you to "see" your schema in a way that isn't possible using the schema designer. Autodoc ships with our Apache OnWeb platform, which means that all of the content it generates can be served dynamically to your ClearQuest users over the web, saving you the hassle of re-creating the documentation every time the schema changes.

High Quality Documentation, Made Easy

Autodoc extracts all the information from your ClearQuest schema - for example:

• entity definitions
• entity relationships
• field descriptions
• state-transitions
• access controls
• Perl or Visual Basic hooks

and puts it all together in a readable and meaningful format.

A picture is worth a thousand words - Autodoc has the ability to dynamically generate high-quality SVG diagrams for entity relationships and state-transition diagrams.

If you're like us, you're probably no stranger to manually drawing ClearQuest entity state-transition diagrams in tools such as Microsoft Visio. This is a tedious and time-consuming task which will only get worse as the complexity of your schema increases. With Autodoc, you no longer have to spend hours slaving away at diagrams manually — it will do them all for you at the click of a button!

See for yourself in the Examples section.

Tailored Reports for Specific Audiences

By default, Autodoc produces two types of reports; User Reports and Admin Reports. As you'd expect, the former is intended for the consumption of general ClearQuest users, who aren't concerned with the behind-the-scenes mechanics that would only be of interest to a ClearQuest administrator.

User Reports are centred around the main entities defined in your schema. For each entity, the default state transition diagram is provided, as well as a list of all the fields, actions and behaviors for that entity and their corresponding descriptions.

Admin Reports are based on the same structure as User Reports, but also define field definitions, access control and value changed properties, as well as including links to all the script code that's defined in the schema (hook code, record scripts and global scripts). 

For a better idea of what's in each report, see the Examples section.