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: This too is technical communication From:"Condo, Candis" <ccondo -at- c-cor -dot- com> To:"John Posada" <jposada01 -at- yahoo -dot- com>, "Ned Bedinger" <doc -at- edwordsmith -dot- com>, "Caroline Tabach" <caroline -dot- tabach -at- gmail -dot- com>, "Rush, Jay" <jrush -at- c-cor -dot- com> Date:Wed, 6 Jun 2007 16:42:06 -0700
Wow, I am impressed. You and your customers are very fortunate. I have
always said that making doc review a part of dev's defined
responsibility (as in part of their job description AND a part of their
year-end review) makes all the difference in the world.
Candis Condo
-----Original Message-----
From: John Posada [mailto:jposada01 -at- yahoo -dot- com]
Sent: Wednesday, June 06, 2007 4:33 PM
To: Condo, Candis; Ned Bedinger; Caroline Tabach
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: This too is technical communication
> I don't think any company pays that close attention to product doc
> today. I have not worked for such a company in, oh, 5 years. The
Because you aren't with one doesn't mean it doesn't exist, and I'm
sure there are lots of companies take as much pride in their docs as
we do.
My product documentation first gets reviewed by development and QA.
Not lip service...it is part of their defined responsibility. They're
given a week to do their final review.
After they submit their commnents and I make the changes, it goes to
what is called SVT. The SVT people are the customer advocates. They
put themselves in the place of the customer and act like the
customers. When they aen't acting like customer, they're intouch with
customers...SEs and CEs are in this group. For instance, they do an
install exactly acording to the installation and configuration
manual. I then get comments and changes from them. At release time,
they have a week.
When that is done, it goes to the mother ship, they do an editorial
review and I get those comments. They have a week. After they're
done, we create the distribution version (PDF) and that PDF gets a
peer review...two other writer in the department go through and check
for broken links and incorrect bookmrks, pagination, various stuff.
This takes a day.
Then the docs go on the manufacturer's CD.
John Posada
Senior Technical Writer
"They say everyone needs goals. Mine is to live forever.
So far, so good."
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-