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.
Note that I didn't say not to put the info in the manual; I said it's
best to have the info right where the users need it, beside the stuff
that needs "translating."
If you do that, there will be fewer calls to tech support than there
would be if the info were stuffed into a conventions section
elsewhere.
These generalizations are based on actual usability tests.
Beth
bkane -at- artisoft -dot- com
So, how would you handle explaining that "select File>Exit" means to select
the file command, then select the Exit command from the File command
drop-down list? Would you just spell it out at each individual step in the
instructions (thereby making the steps seem long and unruly)? Or just
explain the convention once somewhere? And if you choose the latter option,
where would you do that?
--B
barb -dot- ostapina -at- metromail -dot- com
...speaking only for myself.
