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.
Kathleen tends to << remind the talented folks in our Marketing group not to
tell our users to "simply" do anything in the Help. If it were simple to do
in the first place, I wouldn't be asking for help. I am constantly weeding
this kind of false cheeriness from help and troubleshooting content I
receive from them.>>
I confess to using "simply" when the procedure is, in fact, simple for the
user to do. I wouldn't use it in a troubleshooting guide, or even a
tutorial. But in a reference manual, or somewhere else where I was
describing functionality (as in marketing text), I think it's acceptable.
The message (I hope!) it sends is that the software does the task in
question and requires minimal effort from the user.
Shalom from Jerusalem,
Sharon
Sharon Deitch
Technical Writer
SintecMedia
sharon -at- sintecmedia -dot- com
