Create user guide help documents

User guide help documents are grouped in appropriate sections on the page and listed in a configurable order.

Before you begin

Create all your help documents from within the section record. This allows you to refine their titles, adjust their placement, and decide if they are appropriate for the section.

Role required: admin

Procedure

  1. Navigate to System User Guide > Administration > Help Page Sections.
  2. Open a section record you created.
  3. In the Help related list, click New to create a help document for that section.
  4. Complete the form.
    Table 1. Help document field definitions
    Field Description
    Number Document number generated automatically by the system.
    Section Section in which this document appears.
    Order Listing order for this document in the selected section.
    Published Date this document was created.
    Updated Date this document was last updated.
    Short description Brief description of the content of this document. This description is used as the title for the document on the help page.
    Text Document content, including graphics and tables. You can format your entry, create bulleted or numbered lists, and attach images.
    User guide help document
  5. Click Submit.
    The view returns to the section record.
  6. Repeat the process to create the necessary help documents for that section.
    Section record with help documents