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.
Part of the following piece on XML editing outlines 3 levels of
documentation editing. This seems to apply to all kinds of editing, but
doesn't appear comprehensive in terms of every kind of technical editing.
The Impact of XML on Technical Editing http://www.stc-techedit.org/2008/02/15/the-impact-of-xml-on-technical-editing/
by Justin Baker
Linear-based documentation (traditionally called paper-based
documentation), has three major editing phases in my own mental editing
model: (1) Knowledge Editing, (2) Language Editing, and (3) Layout
- Knowledge Editing refers to the technical subject matter in a document
both in verbal form (words) as well as in visual form (images). I divide
Knowledge Editing into four sublevels:
- Knowledge Accuracy,
- Knowledge Completeness,
- Knowledge Logic, and
- Knowledge Hierarchy
The first two editing sublevels ensure that the subject matter is accurate
and complete. The third editing sublevel ensures that the basic logic of
the subject matter is sound, and the fourth editing sublevel ensures that
the 1.0, 1.1, 1.1.1 hierarchy of the subject matter is sensible.
- Language Editing refers to the technical subject matter in a document
both in verbal form and visual form. Language Editing focuses on the
exposition of the knowledge through words and images. Language Editing
encompasses sentence structure, grammar, diction, punctuation, spelling,
and character mechanics (font and display attributes). Language Editing
focuses on the particular standard visual elements to be used in any given
type of illustration. For example, for network diagrams, some companies
might want to consistently use the same network-server icon. Language
Editing ensures that both the verbal language and the visual language are
- Layout Editing focuses on the following document areas:
- Industry-standard, large-scale document page layout patterns (for
example, a traditional template for a specific industry project plan)
- Text and illustration spacing
- Large-scale font formatting (small-scale, or individual, font formatting
is part of character mechanics under Language Editing)
- Miscellaneous layout mechanisms such as running headers, page numbers,
The first, knowledge editing, encompasses some, but seemingly not all
aspects of developmental editing. One website says developmental editing
is "editing the big picture by paying attention to the minute details."
(From a site oriented toward fiction and nonfiction writers: http://members.tripod.com/bookeditor/devedit.html.)
Bonnie Granat's website has good descriptions of some types of editing,
including developmental, but not all. Another site, Associate Writers and
Editors, with descriptions of various kinds of editing: http://writerseditors.com/services.htm
A comprehensive outline of the many aspects of editing would be useful to
me, if anyone would like to share their knowledge.
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-