Documentation

Table of Contents:


    Tracking documentation progress

    Applies to: 7.1 (current), Article available also for: 6.3, 5.2

    One of the features of Dataedo is documentation progress tracking.

    To enable it, click the Show progress button on the ribbon. Show progress button

    Progress bars will appear in the documentation tree. Progress displayed

    Progress of individual objects

    Progress of documentation of an object is calculated with a 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 main description is non blank + 1 for each column where description is non blank + 1 for each key with description + 1 for each relation with description + 1 for each trigger with description + 1 for each input/output with 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 progress of objects up to the folders and modules and eventually to documentation level (database/connection). Documentation progress of documentation 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 a progress for each specific module. The formula is the same as for documentation, but including only objects assigned to module.

    Progress of object type/folder

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

    More information

    Ignoring triggers, keys and relations in progress calculations

    Found issue with this article? Comment below
    Comments (0)