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.
To: techwr-l @ listserv.okstate.edu
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.