SQL Doc 2

Generating the documentation

When you have selected the objects that you want to document, you can generate the database documentation.

  1. Create the project and select the databases and objects to document.
  2. Click  Generate Documentation.
  3. On the Generate Documentation dialog box, in the Save in box, specify the location where you want SQL Doc to create the documentation.
  4. Select a File type. If you choose Document or Help file, you also need to specify a file name; for web pages you don't specify a file name: instead the documentation is generated as a set of files, saved in a time-stamped folder.
    Find out more about the available file types
  5. Click Generate Documentation to start generating the database documentation.
    SQL Doc displays a message dialog box that shows the progress of your database documentation.

    If you select the Close message box on completion check box, SQL Doc closes this message dialog box automatically the next time you generate database documentation for a project.

  6. If necessary, click OK to close the message box.

To use the same settings next time you generate documentation for this project, click  Save Project.

Find out about generating documentation from the command line.


Didn't find what you were looking for?