Naming conventions for Helptext

Apply the following guidelines when setting the HelpText property for menu buttons, menus, submenus, and menu items.

  • Phrase sentences in the imperative form.

    Example: “Create or update items”

  • If the item does not require user interaction, or if the imperative is inappropriate, use a descriptive form.

    Example: “Inventory value for the physically updated quantity (floating value)”

  • End sentences with a question mark, if necessary.

  • Avoid using exclamation marks (!), and do not use question marks to shorten a phrase.

    Example: Avoid “Update?”; use “Use to update” instead.

  • When referencing a command or menu item capitalize the name, but avoid any additional accentuation like quotation marks.

  • One-word definitions are usually inadequate.

HelpText Examples

Journals

Journals available for this module

Inquiries

Inquiries available for this module

Reports

Reports that can be printed from this module

Periodic

Jobs available for periodic processing

Wizards

Wizards available for guiding you through tasks

Setup

Setup forms with parameters for setting up this module

Post

Select a posting option for the current record

Setup

Update setup information for the current project

Inquiries

Get specific information related to the current project

Functions

Select a function to be applied on the current project

Print

Select a printing option for the current record

Transactions

View transactions entered on the current record

If possible, phrase all HelpTexts within a single menu, submenu, or menu button group identically, with a consistent choice of words.

See also

Labels