How to set databases to document database objects from SSMS

Last modified: March 2, 2023

dbForge Documenter for SQL Server comes with a free add-in for SQL Server Management Studio. It allows you to launch the documentation generation for database objects from the Object Explorer of SQL Server Management Studio.

The Documenter add-in is bundled with the Documenter tool. When you run the installer of the tool, make sure that the add-in installation check box is selected.

To start generating documentation from SSMS

1. In Object Explorer, right-click the database you want to document and select Documenter > New Documentation.

2. In the preview Database Documenter project that opens, set up the documentation:

• Set up the cover page of the generated document
• Include the database objects you want to document from the database documentation tree
• Include or exclude object-specific sections and properties

For more information about the documentation setup, see Setting up the documentation.

3. To start generating the documentation, click Generate. To learn more about how to generate documentation in available file formats, see Generating documentation.

Download dbForge database schema documentation tool and try it absolutely free for 30 days!