Share this Page URL

Chapter 10. Working With an Editor - Pg. 130

130 Chapter 10. Working With an Editor Writing computer documentation involves converting raw information from engineers and marketing professionals into a useful, well-written document. The final document often is a result of efforts from the entire publications team, including writer, editor, designer, illustrator, and production co- ordinator. However, the content of the document is most closely developed through the work of writer and editor. This chapter discusses the following topics: · · · · · · · "Technical Editor's Role" on page 187 "Editor's Role in Producing Online Documents" on page 188 "Types of Editing" on page 189 "Edit Schedules" on page 194 "Document Submission" on page 195 "Editing Marks" on page 195 "Edit Style Sheet" on page 195 Technical Editor's Role An editor helps a writer focus on content and effective presentation and provides another set of eyes to check all the details. The partnership of writer and editor produces easy-to-use, high-quality, effective documents. Any editor is concerned with use of language, flow, tone, grammar, punctuation, capitalization, spelling, sentence structure, consistency, and so forth. However, a technical editor is also concerned with technical content, compatibility of the technical depth with the reader's background, and effec- tive communication of technical information. Other areas of concern include consistent use of tech- nical terms and symbols, and careful coordination of text and artwork. By marking text and sug- gesting an alternative, an editor indicates to a writer that the original might be, for example, mis- leading, awkward, imprecise, confusing, or incomplete. Editor's Role in Producing Online Documents Editors can help the writers of online documents with the following tasks: · Identify the document's readers and purpose. An editor can help a writer use this information to decide which documents to optimize for online, which documents to optimize for print, and how to establish priorities for conversion projects. · Define online document structure and the links that are under the writer's control. Writers have control over links that are embedded in the text and links that are in jump lists. However, writers typically do not have control over standard navigational aids such as Back, Forward, and Home, which are predefined in design templates.