Documentation

Table of Contents:


    Introduction to Dataedo

    2018-05-09 2018-10-03
    Applies to: 7.1 (current), Article available also for: 6.3, 5.2

    Dataedo is a powerful database documentation tool. It allows you to create data dictionaries (description of all tables, columns and relationships), create ER diagrams, document server scripts (stored procedures, functions and triggerss).

    It is a desktop application that connects to existing databases and imports schema, then enables users to provide descriptions and export documentation to PDF, HTML or Excel.

    Architecture

    Architecture

    • Documented databases - databases that you want to document
    • Dataedo Editor - program that enables importing, describing and exporting
    • Repository - this is where all documentation is stored (learn about Dataedo repository)
    • Exports - exported documentation

    Key process

    Key process of documenting database with Dataedo looks like this:

    1. Import schema from database
    2. Describe database elements
    3. Export documentation (to PDF or HTML) (optional:)
    4. Update documentation when database schema changed
    5. Go to 2
    Found issue with this article? Comment below
    Comments (0)