Schema Documentation

DbSchema can generate interactive documentation in HTML5, PDF, and Markdown format. We recommend first creating multiple diagrams, each focused on a specific part of the schema.

Generate the Documentation

  1. Go to Diagram > Export HTML5 or PDF Documentation;
  2. Choose the format: HTML5 or PDF;
  3. Choose the diagrams to include:
    • Current
    • Open
    • Selected
    • All having tag 'documentation' - In the Diagram Properties dialog, near comments you can configure tags. The diagrams will be sorted in the documentation based on the 'documentation' tag value.
  4. Choose documentation content;
  5. You preview the documentation in your browser.
Generate database documentation dialog

Add Comments in the Diagram

When creating tables or columns, you can add comments about their contents in the Description section. Read these comments in the HTML5 Documentation if you hover over the table or column.
Add table and column comments to schema
Beside text comments, DbSchema can store comment tags, as pairs of (key-value). The comment tags will be available in the generated documentation and can be used in Automation Scripts.
DbSchema comment tags

Explore the Documentation Formats

HTML5 Interactive Documentation

Open in any browser. Click tables, hover columns, and navigate easily. Ideal for teams who need a live, visual overview of the database structure.

Works offline, includes diagrams and all schema descriptions.

HTML5 interactive schema documentation.

Printable PDF Report

Export a clean, professional PDF with your full schema structure, table details, and descriptions. Perfect for reviews, audits, or sharing with clients.

Download Sample PDF
PDF schema documentation export.

Markdown Export

Export your schema as Markdown files, ideal for GitHub, developer wikis, or internal docs. Includes table structure, field descriptions, and foreign key details in readable text format.

Download Sample Markdown
Markdown export example

Programmatically Generate Documentation

Documentation can be generated using Groovy Scripts. Read further details in the Documentation.