Back to articles list
Vertabelo has a great new feature: a model documentation auto-generator. You can now create and export documentation for your current model with just a few clicks.
Vertabelo has a great new feature: a model documentation auto-generator. You can now create and export documentation for your current model with just a few clicks.Think of how a complex model looks: multiple tables and tens or hundreds of columns where you can easily get lost. In a situation like this, you could really do with some well-organized documentation that lists all the tables, references, columns and other parts of your model in a structured way. You could of course write the descriptions yourself, but that’s time-consuming and open to mistakes and omissions.
Now you don’t have to spend time creating and checking your documentation. Vertabelo has a new function that will do it for you.
Using Vertabelo’s Automatic Documentation Generator
Take a look at how easily you can generate ready-made documentation for a database schema.
Once you open a specific model, find the brand-new DOC button in the main toolbar and click on it:
Now, all you have to do is choose a format (PDF, HTML or DOCX) and press GENERATE:
After you click the button, the documentation will be compiled. You can download the file directly to your computer with one click.
All documentation will share a similar look regardless of the format chosen. It will begin with a title, followed by the table of contents. Here’s a PDF-formatted example:
As you dig deeper, you’ll see descriptions of all the tables, references, and other parts of the model. Take a look at how our example items are described:
And here’s the example for references:
As you can see, everything is automatically generated based on the information you have in the Vertabelo program.
The documentation generation button is available for all models, including any that you’ve previously created. Open one and see just how quickly you can get your own well-structured model documentation.
