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:Is It My Job? From:Tiffany Crotogino Munoz <Crotogino-Munoz_Tiffany/CORP_LABS -at- CST -dot- CA> Date:Mon, 19 Aug 1996 10:42:37 -0400
> After I prepared my initial online Help
project, the programmers
> told me that they could not work with my
context strings; they
> provided me with a file with the context
strings and numbers
> that they wanted to use. I aliased the entire
project to make
> their strings take priority.
That seems OK to me. That's how I work around
here, and I don't have a problem with that.
after all, I'm building help to work in the app.
they're creating, not the other way around.
>Then I got my next surprise: they
> told me that my Help was "worthless" because I
needed to provide
> documentation on every menu option so that a
user choosing a
> menu option could press F1 and get a
description of the command
> the option launched.
I, too, would get a little indignant if someone
had the audacity to call my work "worthless" on
such grounds. However, giving some sort of help
for the individual menu items is not
unreasonable. I do it very much the way you have
constructed yours, with a screenshot and
pop-ups. No complaints around here (as a matter
of fact, this one was considered a bonus by our
project leader, who hadn't required it.)
I will say your developers seem to be a tad
uncooperative, and I agree you'd probably be
doing better if you could coordinate this
through the project leader, rather than dealing
with the developers ("'conflict management"
would seem to be a good subtitle for project
manager, don't you think? :-)).
I do agree with Sue Gallagher, who suggested
that some good advance planning would go a long
way to avoiding these types of problems. I
learned that the hard way, on the first on-line
help I ever created. Then again, hindsight is
almost invariably 20/20, isn't it...
My opinions are mine, not the company's. If they
want to share them, that's fine. If they don't,
that's fine, too.
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-