It is important to provide Help text for all panels, menus, and commands of an application in order to make the applications easy to use.
Because Help text is generally used mostly by new or inexperienced users, it is important that it is itself easy to use.
Use a standardized structure that can be related to the panel that it explains. Follow the OS/400 standards.
Use simple language. Avoid jargon, and explain what the panel and its fields are for, rather than how the program internals work. Make sure that terminology on panels matches with that in the Help text.
Follow UIS standards for the use of emphasis.
Use boldface type for headings and allowed values. Use underline for default values and for hypertext links (automatic) extended headings. UIM will do this automatically if you use the correct tags. Do not make an excessive use of emphasis, as it is distracting to the reader.
|
Copyright © 2014 CA.
All rights reserved.
|
|