Technical Editing
Although technical editing incorporates the
same functions of the proofreader and copy/content editor, its
primarily focus is with a document’s technical content and how
well it is presented to the intended audience. It involves
reading content critically and objectively from the audience’s
point of view. The technical editor evaluates a manuscript on
the basis of representative readers and determines whether it
tells them what they need to know – completely, concisely,
clearly, and accurately..
Technical Editing: Many Aspects to Consider
Our talented technical editors can:
- Provide document assessment and recommendations for
improvement of your organization’s customer-facing text,
such as:
| • |
User Assistance Materials (e.g., user guides, quick
reference cards, product overviews, technical manuals,
procedures, informational/instructional e-mails, etc.) |
| • |
Newsletters |
| • |
Brochures |
| • |
Web content |
| • |
Annual reports and special supplements |
| • |
Association and company publications |
| • |
Other marketing collateral |
- Evaluate how ideas are expressed by looking at the
language used:
| • |
Sentence complexity |
| • |
Use of active or passive verbs |
| • |
Use of jargon or technical terms appropriate for the
intended audience |
- Rewrite, reorganize, or suggest other ways to arrange
material to facilitate clarity of presentation.
- Ensure internal consistency of your documentation. For
example:
| • |
Are references to figures, tables, sections,
part/product numbers, and other documents correct and do
the referenced items exist? |
| • |
Are page numbers and numeric/lettered sequences in
order? |
| • |
Are all graphics, listings, and other non-text items
accurate? |
| • |
Are headers/footers, page layouts, and other types
of formatting consistent? |
- Check the verifiable details.
- Test documentation content against the use of your
product for technical accuracy and validity.
- Work with your subject matter experts to resolve
document inconsistencies and correct errors.
- Ensure that the content is well organized and concisely
fits together into a coherent whole:
| • |
Is there a clear, logical development of ideas? |
| • |
Is the order of presentation logical? |
| • |
Is all necessary information included and are
redundancies removed? |
Let our technical editors assist you with
quality control of everything you put to words. For more
information, call us at 847.657.6011
or
send
us an e-mail.
Top of page |