Write documentation

If you are running AVEVA Process Simulation with the Model Writing role, you can write Model Library and model-specific documentation, and save what you write with your Model Libraries and models. If you are running AVEVA Process Simulation with the Simulation Building role, you will be able to view the documentation, but not edit it.

It is important to note that any documentation you write in the documentation editor will not be mirrored in the online help shipped with AVEVA Process Simulation; documentation you write is directly saved with the Model Library or model you choose to edit.

View or modify Model Library help or model-specific help

1. Right-click on one of the Model Libraries or models shipped with AVEVA Process Simulation, and then select Help.

   The Help dialog appears:

   

2. To edit the help, ensure that you are using the Model Writing role, and select Enable Edit .

   The remaining commands on the toolbar become active:

   

3. Make your changes in the Help editor. You can change the font, style, and layout of the documentation you write in addition to adding links and images.

4. Select the Save icon.

5. Close the editor.

   The next time you load the Model Library help or Model Type help, the documentation that you wrote appears in the Help dialog.