Working with projects - SQL Doc

Whenever you document your databases, you set up a project.

You can create a new project each time you want to document your databases. Alternatively, if you will always be documenting the same database objects, you can save the project. You can then open the project file at a later date or run it from the command line.

SQL Doc project files are saved with the extension .sqldoc

Alternatively, you can document a database by right-clicking in the SQL Server Management Studio Object Explorer.

SQL Doc stores the following information as part of the project:

SQL Server connection
You can edit the connection details as part of the project configuration.
databases and objects to document
For more information about adding and removing objects from a project, see Setting up the documentation
project and copyright information included on the project information page and footer of the generated documentation
You can edit this information as part of the project configuration.

You specify the format for the generated documentation and the location that documentation is saved in when you generate the documentation. If you save the project after you generate the documentation, SQL Doc stores the settings that you specify and uses the same settings as defaults next time you generate documentation for the same project.

Editing project configuration

To edit a project's configuration:

If the project is not currently open, click Open Project.
Click Edit Project to open the Project Configuration dialog box.
- The Documentation Setup tab contains settings that specify information that is included in the generated documentation:
  
  Project name is displayed on the project information page of generated documentation, and on the title page of documentation in Document (.doc) format.
  
  Project description is displayed on the project information page.
  
  Include SQL creation script in generated documentation: choose whether the script is included in the documentation. For example, if you are going to print the documentation, you might want to exclude the script to make the documentation shorter.
  
  Copyright text is displayed in the footer of generated documentation; if you specify a Copyright URL, the copyright text is included as a hyperlink.
  
  Author is displayed on the project information page and the footer of all generated documentation, and on the title page of documentation if you generate documentation in Document (.doc) format.
  
  You can change the default copyright information used by all projects on the Application Options dialog box, if required.
- The Connection tab contains details of the SQL Server connection for the current project.
When you have edited the settings as required, click OK and then click Save Project on the SQL Doc toolbar to save your changes.