proofing docs

Subject: proofing docs
From: Cathy Carr <ccarr -at- OVID -dot- COM>
Date: Wed, 14 May 1997 14:03:53 -0400

To: techwr-l @
Subject: proofing docs


I'm a newbie in the tech-writing world, still getting my feet on the

My first major project at this company was updating a UNIX sysadmin manual.
This is probably our longest document and one that gets a lot of use. As a
matter of course, I sat down with the manual and a pencil for a
read-through. One of my fellow tech writers remarked that she doubted if
she'd ever read one of our manuals all the way through. Now, I do have a
good amount of editorial experience, and this just amazed me. To me it's a
basic step, just as basic as running a program when you're done writing it!
Since then, I've asked another person here (who has experience as a
documentation manager), and she said that it's quite common for manuals,
release notes, and suchlike things to go out from software companies
without ever being proofread.

Is this true in y'all's experience? If it is, does anyone have suggestions
as to how to keep up quality control in documentation that isn't read by
the people who write it? :-)
I apologize if this is a silly or overly-basic question. You can answer me
directly if you don't want to bore the more experienced techwhirlers.


Cathy Carr
Documentation Specialist
Ovid Technologies, Inc.
1/212/563-3006 | 1/800/950-2035

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
Search the archives at or search and
browse the archives at

Previous by Author: job posting, NYC area
Next by Author: Use of OK
Previous by Thread: Two Technical Writers needed Calabasas, CA
Next by Thread: proofing docs

What this post helpful? Share it with friends and colleagues:

Sponsored Ads