Documentation projects

Perspective  ARCAD Observer
Access  Server >  Applications > Application Name >  Documentation

A documentation project is linked with an application. You can create several documentation projects for an application, depending on what you want to document. The documentation project contains all the versions of your documentation.

Step 1   In the ARCAD Observer navigator, open Servers > the desired server > Applications.

Step 2   In the list of applications, open the desired application.

Step 3   Open  Documentation.

Accessing documentation projects

Result   The list of the documentation projects that already exist for the application is displayed.

The documentation project is the framework within which all documentation is defined.

Follow the subsequent steps to create a documentation project.

Step 1   In the Documenter Navigator view, open the desired application.

Step 2   Right-click the Documentation node and select  Add a documentation project.

Step 3   Fill in the fields in the Creating a documentation project dialog.

Name
Define the name of your project. This is the value that will be your project’s identifier. This field is required.
Description
Enter a short description of your project, limited to 255 characters.
Comment
The comments are a longer description, not limited in number of characters, which provides a full description of the contents and objectives of the documentation to be performed.
Default Project
If you check this option, you declare that the project is the default project for the application to be documented.
Project Manager
This drop-down list references all of the ARCAD Observer system’s users.

Step 4    Click Finish.

Result   The new documentation project is displayed under the Documentation node of the application.

The documentation project properties can be modified.

Important!

Projects are associated to the parent application and you cannot change the application to which the documentation project relates.

Follow the subsequent steps to rename or edit the properties of a documentation project.

Step 1   In the Documenter Navigator view, right-click on the desired project and select  Properties.

Step 2   Edit the properties in the Properties dialog.

Documentation project properties

Step 3   Click OK.

Result   The properties are edited. You may need to refresh the ARCAD Observer navigator to see the modifications to the name. Right-click the [documentation project name] node and select  Refresh.

Warning!

Deleted documentation projects cannot be accessed or recovered.

Note

Documentation projects containing documentation versions cannot be deleted.

To delete a documentation project, right-click on the item in the application navigator and select  Delete. Click OK to confirm or click Cancel to keep the documentation project in the dialog.