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:How is your pubs dept set up? From:Kendall Robinson <kendallr -at- SMTPLINK1 -dot- CHEY -dot- COM> Date:Tue, 20 Sep 1994 13:34:55 EST
Text item: Text_1
I work for small to medium sized software company that has
experienced real hyper-growth over the past 4 years. With this
growth has come a lot of frustration and growing pains. Also, as
is the nature of the software industry, my company virtually
demands long hours, weekends, firstborn, and so on. Wait a
second, I swore I wouldn't start complaining! Sorry. Let me get
the real point of this post.
I've always had a hard time convincing management that it is
necessary to have on-line help people developing the help and
technical writers developing the printed manuals. Management
feels the technical writers ought to first do the printed docs,
then do the on-line help. I say this is a bad idea (not a good
argument, I know).
Some of the reasons I've come up with for why help should be
developed by dedicated resources are:
Most writers are already so over extended, and most "schedules"
are already so tight, that the quality of docs, help, or both,
are going to suffer.
On-line help is often reviewed as part separately from the
software and the docs, which says to me it is important.
Other companies (or so I've heard) often have more people doing
help than the printed stuff.
Which brings me to my question...how is the pubs department set
up in your company? Do you have separate resources doing the
on-line help? Do you feel it's possible, or a good idea, for
writers to write manuals and develop complex hyper help systems
at the same time?