Previous Topic: Designing Help TextNext Topic: Command Help Text

IBM i General Design Standards › Design Standards for Help Text › Panel Help Text

Panel Help Text

All interactive programs should have operating instructions that should be displayed when the HELP key is pressed. The help text should follow the UIS standards used on system panels and should contain:

  1. Function: A synopsis of the purpose the program; for example, what the program does for the user, or for the application system. This may contain hypertext links to related objects.
  2. Option values: A brief description of any line selection functions (for example, 4=Delete).
  3. Field descriptions: A description of all data items, including all allowed values and any input validation rules.
  4. Notes and examples: Any special notes or additional comments that may be useful to the user.
  5. Function keys: A short description of any command key functions (for example, F3=Exit).