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.
In our manuals, we always put exactly what they should type on a line
by itself that shows exactly what is on the screen, what you should do,
and what to expect. The information you are giving is too much for a new
user. For example, in VMS Mail, to delete something, you can just type 'd'
or 'del' or 'delete' or press a function key. We generally give them the
full command in the manual. Then on an informal basis, people learn the
shortcuts. It is better to give the simplest, least complex information
on a Type This: line and then explain why below that line. This allows
for the "lemming" syndrome and cuts down on user support.
Secondly, did you explain somewhere at the top of the section that info in
()'s was not to be typed, also the ()'s? In one of our handouts listing
macros, we have macro names listed as wpm:f(2,3,12,13)cd. The user is
instructed to put the correct printer number in place of the (2,3,12,13).
That information is simply to indicate that the macro works for those
printers in the parens. It seems to have worked fine....but our user
base is only 100 vs. whatever at your univ.
