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.
Subject:Re: Questions: You vs. the user From:"Bergen, Jane" <janeb -at- ANSWERSOFT -dot- COM> Date:Tue, 6 Jan 1998 13:27:54 -0600
On Tuesday, January 06, 1998 11:09 AM, Susan Vineyard
[SMTP:VINEYSX -at- MAPCOINC -dot- COM] wrote:
> 1. Does ANYBODY use the terminology "the user" as in "the user must
first
> push in on button" rather than"you" in on-line documentation?
Wouldn't this depend on who you are writing for? If you are writing for
the person who is to do the task, then use "you" as a direct address. If
you are writing for someone who will work WITH a user (for example, you
are writing a guide for teachers on how to teach something), then you
might get by with not using "you." But generally, you should direct your
writing directly to the user. Also generally you will want to use the
imperative voice ("Press the button" rather than "You should press the
button") for directness. This eliminates making the user guess if you're
giving an option or an instruction.
> 2. Is there any good way to insert a table with lines and shading
(two
> features not supported by RoboHelp) into a RoboHelp document without
an
> outside graphics program. If I cut and paste into Draw, the results
are
> awful. Screen captures are also awful when saved in Draw and imported
into
> RoboHelp.
This limitation is not just RoboHelp's problem. It's a limitation of
WinHelp itself. I've seen a few workarounds but none are truly
satisfactory.
> 3. Does anyone have any thoughts on considering old user documentation
or
> other documentation commonly used when designing on-line help for new
> software--to kind of cushion the shock?
Huh? I'm afraid you lost me on this one. Can you rephrase it?
> 4. Also, if anyone out there is experienced in documenting
Oracle-based
> software and wouldn't mind answering some questions, would you please
> e-mail me at Susan Vineyard/TUL/MAPCO?
