General instructions for writing HELP pages

General conditions

Do not work alone! This is teamwork. Keep up with the team!

Write so that others understand what you have written. Describe each field well, because someone else or you won’t be able to find out what you are looking at or what the help is about!

When describing a structure in the system use the symbol ” > “ to describe the path to the interface – for example Finance > Finance Settings > Taxes

Creating a Helpdesk at AWF

  1. When you create a link you must fill in the Interface name field SMALL! So when someone looks at it after you to find out what the helpa is about!
    1. Wrong – Sale
    2. Correct – P&S > Sales > New Sale
  2. When referencing a page, check that its ID(https://docs.prim.io/bg/?page_id=1507) no longer exists. If it exists check if it makes sense to create the link or if the existing link is not described well. Keep in mind that it is possible and meaningful for several different interfaces in the system to use a common help in WP!

Creating a Help in WordPress

Every module in WP has a structure:

  • Description, documents and operations
  • Operational activity
  • References
  • Settings

Description of document

When describing any document it should have at least the following pages – General Description, Create, Edit, Add/Edit Line, File. All of them should be located in the following sample structure:

  • Module
    • Description, documents and operations
      • Document (general description)
        • Create
        • Editorial
        • Add a row
        • File

Important: not every type of document makes sense to describe in such detail! For quite a few document types, you can use the general description from the System Description > Document File and System Description > Documents and Objects

Documents for detailed description

Interface description in Module Operations

Usually these are filter and result lists. Describes how the fitter works. Describes what the result shows. If the result is in more than one tab each tab is described. If there are action options in the result, describe what actions can be done with the result and reference the relevant help pages (most likely located somewhere in Module >Description, documents and operations) If the result contains links to document/object files, describe what related information can be accessed from it.

Example: the Sales interface in P&S > Sales help page should have the following structure:

  1. General description and purpose
  2. Filter –
    1. How it works – general description
    2. radio group Documents/Rows/Articles how it changes the result
    3. checkboxes how to show/hide columns
    4. specifically to explain Filter by Status
  3. Result Documents
    1. What it shows – general description
    2. Icon for quick overview of document lines
    3. Access to the customer file
    4. Description of all types of totals/digits and what they show
    5. Description of the staining and the conditions for it
    6. Access to the document file
  4. Result Lines
    1. What it shows – general description
    2. Access to the customer file
    3. Access to the item file
    4. Access to the document file
    5. Description of all types of totals/digits and what they show
  5. Result Items
    1. What it shows – general description
    2. Access to the item file
    3. Description of all types of totals/digits and what they show
  6. Possible actions from the screen
    1. Buttons to create a new document

Important: not every interface makes sense to describe in such detail! For quite a few interfaces, the general description from the System Description > Lists can be used

Interfaces for detailed description

Create a Help in WordPress Tips & Tricks

ReUse of content:

  • For all children:
  • To Parent:
  • For a specific page:

Visual layout of pages

Title of page

H3- subtitle of the described functionality

Screenshot
class=
Each screenshot indicates an enclosure with a red line on the explained functional and a red number to the right of the enclosure. Explanations on each screenshot are after it!

H3 description of the specified figure (1)

Description

H3 description of the specified figure (2)

Description

Use quotations for examples and important clarifications.
Редакция