Creating Project Documentation

Carry out the following steps to create project documentation:

Step

Action

1

Open the documentation structure.

2

Select the documentation view.

3

Select the individual subjects that you want to include or exclude (Include heading or Exclude heading).

4

Set up the page for printing.

5

Define the parameters for the printout.

6

Prepare the subjects for printing.

7

Check the settings with the print preview.

8

Select a printer and start printing.

Opening the Documentation Structure

To open the documentation structure choose one of the two following options:

  • Double-click Documentation directory in the project browser.

  • Right-click the Documentation directory and click Open .

Selecting the Documentation View

After opening the documentation structure you can choose between the Structural View and the Functional View.

Including a Subject in the Documentation

You have the following options to include a subject in the documentation:

  • In the documentation structure, right-click the subject to include and click Include heading .

  • In the documentation structure, select the subject to include and execute the menu command Edit > Include heading.

  • In the documentation structure, click beside the subject symbol to toggle between Include heading and Exclude heading .

Subjects included in the documentation are marked with a red symbol in front of the subject.

Excluding a Subject From the Documentation

You have the following options to exclude a subject from the documentation:

  • In the documentation structure, right-click the subject to exclude and click Exclude heading .

  • In the documentation structure, select the subject to exclude and execute the menu command Edit > Exclude heading.

  • In the documentation structure, click beside the subject symbol to toggle between Include heading and Exclude heading .

Adding all Subjects in the Documentation

You have the following options to include all the subjects in the documentation:

  • In the documentation structure, right-click the project and click Include all headings .

  • In the documentation structure, select the project and execute the menu command Edit > Include all headings.

  • In the documentation structure, click beside the project symbol to toggle between Include all headings and Exclude all headings .

Subjects included in the documentation are marked with a red symbol in front of the subject.

Excluding all Subjects From the Documentation

You have the following options open to exclude all subjects from the documentation:

  • In the documentation structure, right-click the project and click Exclude all headings .

  • In the documentation structure, select the project and execute the menu command Edit > Exclude all headings.

  • In the documentation structure, click beside the project symbol to toggle between Include all headings and Exclude all headings .

Updating and Preparing

The documentation is updated dynamically whenever a change is made in the project directory.

After every update the updated or new subjects are marked with a (?) symbol.

You have the following options to prepare the project for printing:

  • In the documentation structure, right-click the project and click Generate Printout .

  • In the documentation structure, select the project and execute the menu command Edit > Generate Printout.

The subjects correctly prepared have the page number (n) displayed after the subject.

NOTE: It is only when the project subject has a page number that all the subjects are prepared.
NOTE: Printable documents are generated for every subject during preparation for printing. By default the documentation is not saved, it is deleted at the end of the Control Expert session and must be generated again in the next Control Expert session. If you want to use these documents in other sessions, check the Save Generated Printout checkbox in the Printout Setup dialog box.