How to write custom help documentation

Prerequisites

• To create a help group – user must have a role of manager or contributor in the project that contains the help group.
• To create help documents – user must have a role of contributor or higher in the help group.

1 Create a help group

If a help group exists, go to the group.

If there is no help group in your project, create a group with name ‘help’. The title you enter for the help group is what displays in the interface.

2 Create a help document

In the help group, create a document of document type ‘help’.

To check that it worked correctly, type the title of your help document in the search bar, and it appears listed in the search suggestions as ‘Project help’.

3 Associate a help document to a page or document type

Using metadata to associate a help document to a page or document type is optional.

1. In the document info and metadata panel, click the Metadata tab.
2. Use the metadata property Page ID to attach the article to one or more pages, OR
3. Use the metadata property Document type to attach the article to one or more document types.