MySQL database documentation generator

Documentation generator embedded in dbForge Studio for MySQL allows you to document MySQL databases in several formats and helps facilitate the communication between teams with a bunch of useful functions.

The documentation generator feature of dbForge Studio for MySQL is a MySQL database instrument that automatically generates documentation in the HTML, PDF, and Markdown file formats. It will take you just a couple of minutes and a few clicks to document multiple MySQL and MariaDB databases with all their objects and properties. The feature includes a wide range of options to customize the generated documentation file to meet your specific requirements. The functionality is also available as a separate MySQL documentation tool.

  • Generate your documentation in a format that is most suitable for you
  • Create a complete picture of your database structure with its elements
  • Fine-tune the documentation options and select a desirable layout

Database structure overview

The documentation generator extracts extensive database information, including MySQL object types, their details, and properties, as well as inter-object dependencies and DDL code.

The documenter feature shows the database structure

Customizable options

The feature allows selecting individual MySQL objects and their properties for documenting. Documenter also includes a rich collection of style templates and allows changing the documentation layout with various Bootstrap themes.

Documenter for MySQL offers different themes for ease of reading

Supported formats

You can generate documentation in three file formats: HTML, PDF, and Markdown. HTML and Markdown suit for databases to be published on the web, PDF is optimal for distributing to various systems and devices. All formats are searchable, which is very convenient especially for large databases.

Choose from 3 different formats to generate documentation with dbForge Studio for MySQL

Searchable documentation

Search across the generated documentation for MySQL database objects. As you type the name of a required object in the search field, Documenter highlights the matching text in the object tree. Besides, navigate through the documentation via built-in hyperlinks.

Navigate through the documentation with convenient search options of the Documenenter feature

Explore Examples

Study the example documentation generated by the Documenter feature of dbForge Studio for MySQL for the AdventureWorks and Sakila sample databases and check the effectiveness.

Conclusion

MySQL Database Documenter is an immensely helpful feature incorporated into dbForge Studio for MySQL that allows you to document MySQL and MariaDB databases in 3 different formats and thus simplifies the communication between multiple teams working on the same database project and saves their time and efforts targeted at understanding various database objects and properties. Help your team keep track of the database progress, stay tuned for all of the updates, and benefit from numerous custom options to generate documentation tailored to your needs.

dbForge Studio for MySQL

Cross-functional IDE with advanced documentation tool

Availability in the editions of dbForge Studio for MySQL

Feature

Enterprise
Professional
Standard
Express
Document Databases
Yes
None
None
None