TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
I am working on a user guide for a complex software application being
developed for use by telecommunications companies.
The product has many different screens that they are calling Forms. Each
Form has a different function and has many different data input fields that
need to be described.
But the description of some of the fields is quite obvious and can be
discerned from the field title. Since the system is so complex, each Form
field that will be described in the user guide must have some text either
descibing the use of the field or indicating the data type to input into the
field. Still, some field descriptions are self explanatory as they appear at
many instances throughout the system eg. description, country name,
international ID etc.
For consistency, what I suggest is to use a generic text to as the
desciption of these field types. Some have come up, but in my opinion these
sound a bit condescending to the user.
Can you suggest a better way to handle this situation?
Any comments or suggestions would be greatly appreciated. Thanks in advance.
Tele Danmark IT * Teglholmsgade 1 B-337 * DK-0900 København C
E-mail: smith -at- tdk -dot- dk * Phone: + 45 33 83 44 36 * Fax: + 45 33 20 17 01
When all else fails, read the manual. If that doesn't work, do what it says.