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: Editorial and technical reviews From:Patrick Dean <pdean -at- TXBASE -dot- COM> Date:Wed, 29 Jan 1997 15:23:10 -0500
>OK, the problem. I really need to have the programmers do an initial
>review of the online help -- a *technical* review first. I feel it is
>way too early to be concentrating on editorial review
I'd say that trying to do an editorial review at this stage would be
like putting your pants on before your underwear. Sure you'll have all
your clothes on but your not wearing them the way they were intended.
I'm assuming that an editorial review at your company involves copy
editing and proof reading: two editing areas that you really shouldn't
approach until you have some solid (and somewhat permanent) written
When it comes to creating a doc I make sure we first go through some
sort of approval process for the presented outline. If the writer
doesn't have an outline he/she doesn't start writing (I learned my
lesson the hard way).
Once the writing begins, I try my best to follow this editing process:
Substantive edit - involves reviewing the doc at a high level to
identify problems with the overall approach, organization, level of
info, and writing style. We usually do this after the first draft.
Technical edit - involves identifying problems with technical accuracy
and does not involve copy editing.
Copy edit - requires locating problems with sentence structure, sentence
style, grammar, and spelling. At this phase you should have solved all
organization, design, and functional issues.
Proof read - involves identifying spelling or typing errors as well as
well as problems with the overall visual appearance such as awkward
paragraph breaks, headings separated from paragraphs, and misplaced
graphics. We do the proof read just before printing.