Documentation progress tracking

Dataedo allows you to track the progress of descriptions (and other fields) in your documentation - i.e., how many description fields are non-empty. It is displayed as data bars in a dedicated column in the repository explorer.

Modes

There are different progress tracking modes. They are:

• All descriptions - includes all descriptions from tables, columns, relations, keys, triggers, procedures, functions, and parameters.
• Tables & columns - includes descriptions only from core data dictionary elements - tables and columns.
• Custom field #1 - tracks performance of a specific custom field).

Enabling progress tracking

To enable progress tracking, select the option from the Show progress button on the ribbon.

Disabling progress tracking

To disable progress tracking, click the same button that should have a Hide progress label when progress is enabled.

Calculations

Progress of individual objects

Progress of documentation of an object is calculated with the following formula:

Progress = Actual points / Total points

where:

Total points = 5 (main description) + [number of columns] + [number of keys] + [number of relations] + [number of triggers] + [number of inputs/outputs]

Actual points = 5 if the main description is non-blank + 1 for each column where the description is non-blank + 1 for each key with a description + 1 for each relation with a description + 1 for each trigger with a description + 1 for each input/output with a description

Progress at 0% means that no descriptions are present in the repository.

Progress at 100% means that all required descriptions are filled (non-blank) in the repository.

Progress of documentation

Dataedo aggregates the progress of objects up to the folders and modules and eventually to the documentation level (database/connection). Documentation progress is a total of all documentation objects (tables, views, procedures, and functions):

Progress = Sum of actual points of all objects / Sum of total points of all objects

Progress of module

Dataedo shows progress for each specific module. The formula is the same as for documentation, but including only objects assigned to the module.

Progress of object type/folder

The same logic applies to counting the progress of documentation of a particular object type - all tables, views, etc., are summarized.