Generating Database Document

This topic describes how to configure and generate the database documentation file.

To Generate a Database Document:

  1. Click New Documenter… on the Start Page or on the Main toolbar. If you are working in Microsoft SQL Server Management Studio, right-click a database in Object Explorer, point to Documenter, and then click New Documenter.
  2. The Select Connections dialog box opens. Select one or several existing connections
  3. or create a new connection or select an existing one from the list. Click Select.
  4. The Database Documenter project opens.

    Select Connection

  5. Optionally, select a style for the document in the Style drop-down list box. By default, the Default style is used.
  6. In the Structure pane, select Cover Page to setup the cover page of the generated document.

    Documenter Cover Page

  7. In the Structure pane, select databases, object groups and database objects for documenting.
  8. Optionally, configure documentation by including/excluding sections and properties of documented databases and database objects. dbForge Documenter for SQL Server allows you to configure elements of documentation on several levels, including: servers level, server level, databases level, database level, objects group level, and database object level.

    Documenter Objects

    Tip: You can save the Documenter project file at any time and then re-use it. For this, click Save on the Main toolbar. The Documenter project files have the .ddoc extension. To load the saved file, click Open File on the Start page, or just click its name in Recent Projects.

  9. Click Generate to start generating the document. The Generate Database Documenter dialog box opens.

    Generate Documentation

  10. Select format and directory for the document file.
  11. Click Generate.