Schema Documentation

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

Generate the Documentation

  1. Go to Layout > Export HTML5 or PDF Documentation;
  2. Choose the format: HTML5 or PDF;
  3. Choose documentation content;
  4. You preview the documentation in your browser.
Generate database documentation dialog

Enter the Table and Column Comments in the Diagram

When creating table or columns, you can add comments about their contents in the Description section. Those comments can be seen in the HTML5 Documentation if you hover over the table or column.
Add table and column comments to schema

Explore the Documentation

Open the HTML5 documentation using any browser. Tables and columns comments can be read as mouse-over tooltips.
Read table and column comments in the HTML5 documentation as mouse-over tooltips.

Programmatically Generate Documentation

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