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:On Line Document Review From:Richard Frederick <Fred_Ri -at- CENTRAL -dot- PRINTRONIX -dot- COM> Date:Wed, 9 Sep 1998 09:06:40 -0700
Hello one and all.
I remember seeing something in the list on my subject, but a review of
the recent archives turns up no information at all. Let me toss out my
question with a little introduction.
My company is in the process going to a completely "on-line" process for
our design change/configuration control process. This is a great move
and will free up a lot of management time. One piece of the fall-out of
this process has been difficult for the Tech Pubs Department to get our
hands around. For various good reasons, we have been asked to determine
the right way to go to a completely on-line review process.
Again, this sounds good in theory, but I'm not sure how well it will
actually work for Tech Pubs or Engineering.
* Will the comments from engineering, while more legible, become more
cryptic?
* Will the comments from engineering become more plentiful and timely?
* Will it be easier to use on-line comments for incorporation into the
documentation?
* Do on-line review copies "CYA" as well as hard copy reviews?
* What tools do you use to provide the on-line files for review?
* Most specifically, what tool is used for document "mark up?"
I would really appreciate any experience, thoughts, and opinions on
this.
If there is any experience out there, could you please let me know what
does work and what does NOT work? This could include methods of coaxing
responses from engineering. Pulling teeth from a tiger would be easier
in our organization.
Sincerely,
Richard Frederick
Senior Technical Writer
Printronix Inc.
Irvine, CA