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.
Dave Stewart reports: <<My company will be instituting a peer editing
process in the coming weeks.>>
Not as useful as actually hiring a trained editor, but I suppose it's better
than nothing.
<<I've read about the benefits and challenges of peer editing, and I'm
trying to come up with an initial list of items we should be looking for in
each other's documents.>>
Apart from company style, there are essentially three types of things you
should look for, in order of decreasing importance:
1. Substantive edits: Is the information correct? Is the sequence logical
and effective? Is the information complete (contains everything the reader
needs to know and most of the things they'd like to know)? Does the text
contradict the graphics and tables or vice versa? Is everything you
referenced (tables, figures, headings, chapters, sections) in the text
present, under the same name you used in the reference? Is it present near
where it's cited (for figures and tables) so readers don't have to flip
through dozens of pages to find it?
2. Copyediting: Is the text easy to understand? Does it use standard
terminology? Is it well written (grammatically correct too)? Is it
consistent both within the document (each word is used the same way) and
with other documents you've produced or are in the process of producing?
3. Cosmetic stuff: Are the commas in the right place? Are the correct styles
and fonts and etc. used to format the text? Any typos?
That's just the tip of the iceberg; editing involves a lot more than this.
Pick up any really good textbook on editing for details. (Check out John
Renish's bibliography at www.raycomm.com for a list of editing references.)
If none of you has professional experience as an editor, consider joining
the copyediting-l list (see note below) so you can ask professionals how
they'd do things. (I'm there regularly, as are many other techwhirlers.)
--Geoff Hart, FERIC, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca
"User's advocate" online monthly at
www.raycomm.com/techwhirl/usersadvocate.html
Tarzan's rule of data processing: Never let go of one vine until you have a
solid hold of the next.--Anon.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.