At last, direct from the trenches, here's the book technical editors have been waiting for. Unlike other guides which review grammar and spelling,but don't address the special challenges of technical editing,this lively, practical book deals with the real-world problems, issues, and decisions that face technical editors and writers.In this book you'll get tips for preparing a style guide technical writers will want to use. You'll find checklists of what to look for during different types of editorial reviews, learn how to make the transition from traditional to desktop publishing, and see how you can build true usability into printed and online documentation. Enhanced by real examples, case studies, and practical techniques, these flexible and pragmatic solutions go far beyond the mechanics of marking up manuscripts. You get guidance that will help you decide how heavily to edit, how to manage and track large projects, and even how to position yourself for the future when software will handle the copy editing.Whether you edit technical documentation for a living, write technical material, or review the work of others, this book helps you improve your skills and your understanding of the technical editing function.
Judith A. Tarutz, a former Senior Technical Editor at Hewlett-Packard, is a co-founder of Ibis Communications Inc. in Lynnfield, MA. She also teaches a graduate-level course in software technical editing.
The Editors Role * What is Technical Editing? * The Twelve Basic Rules * Editing As a Mindset, Not Just a Skill Set * The Editor As Team Player * Working with Writers: Ten Lessons I had to Unlearn The Editors Job * Types of Editorial Reviews * The 100 Most Common Errors * Levels of Edit * Following, Breaking, and Making the Rules * How to Write a Style Guide Writers Will Want to Use * Tips and Tricks of the Trade * Editing Computer Manuals The Editors Career * Editing in a Desktop Publishing Environment * Managing Projects and Time * How to Get Hired As a Technical Editor and How to Hire Technical Editors * Is Editing Becoming Obsolete? * Case Studies * Sample Style Guides