The Art Of Editing: User's Guides Versus Technical Documents  

While contemplating topic areas for a presentation at this year's conference, our biggest challenge was the fact that not all technical editors edit the same type of documents. Presentations at STC conferences are heavily concentrated toward user documentation and software instructional manuals. With that as our prime focus, we identified six common elements that we both consider as we edit a document. We then compared our methods of approaching these elements. One of us edits primarily user's guides and procedural manuals; the other edits scientific and technical documents.

Cluff, Susan C. and Sandra R. Marks. STC Proceedings (1994). Articles>Documentation>Editing>Technical Editing

Three Types of Editing  

Bush describes the differing challenges of editing proposals, manuals, and professional papers.

Bush, Donald W. Intercom (2002). Articles>Editing

To Err is Human, But Can It Be Forgiven?: Effects and Economics of Typos  

Technical communicators dread typos. A piece of work that contains one or more typos is seen as shoddy, not something to be proud of. Finding and correcting these errors, however, takes time and costs money. Might there be a better way to spend resources?- ways that might produce more usable information.? Effects of errors, value added by correcting them, and the economics of error detection will be discussed.

Grice, Roger A., Lenore S. Ridgway Richard K. Ridgway and Edward J. See. STC Proceedings (1995). Articles>Editing>Grammar

Total Immersion Editing

In 1977 Judith Tarutz, author of Technical Editing: The Practical Guide for Editors and Writers, rebounded from teaching into her first editing job. She soon discovered that she was having fun. Like many editors, Tarutz learned editing by total immersion.

Smith, Sally. Editorial Eye, The (1997). Careers>Editing

Tracking Change: A High Tech Solution  

This paper explains the planning process that led to a GUI-based (Graphic User Interface) change-tracking system that has enabled our writing group to effectively exchange information between subject experts and writers. The implementation that emerged has enhanced our ability to meet schedules with fewer surprises and has empowered writers with a tool that assists them in planning both routine and long-range tasks.

Leck, Louise. STC Proceedings. Presentations>Editing>Software

Tracking Reviewers' Comments

I had a manual under review by over 60 people. I posted a question about how to track all of their comments. Here is the summary. Thanks to everyone who responded. You all gave me a lot to think about. I realized as I got the comments that I left out a crucial piece of information...the manual went out to our managers and maintenance specialists in the field (we have offices all over the United States). Thus, we can't hold traditional meetings.

Hanvey, Jeff. Suite101. Reference>Editing>Groupware>Workflow

Trust Your Instincts As You Write

As I write, and even after I have finished and am proofing my work, I have to be sure to be tuned in to a diminutive little editor who sits to one side of my mind.

Usborne, Nick. Excess Voice (2002). Articles>Writing>Editing

Typography and Page Layout: Copy Preparation

Copy preparation is a skilled job which, if done properly, assists the smooth flow of work through later stages of the production cycle. All personnel, especially those involved in the composition areas, have seen the results of ineffective copy preparation.

Magnik, John. Typography First. Design>Document Design>Editing>Typography

Typography and Page Layout: Proofreaders' Marks

A collection of professional proofreaders' marks.

Magnik, John. Typography First. Articles>Editing

Typography and Page Layout: Proofreading

Proofreading involves a critical comparison of the author's copy and the typesetter's proof to be sure that the live copy (the typeset proof) matches the dead copy (the author's copy) word for word, and letter for letter.

Magnik, John. Typography First. Articles>Editing

Unexpected Text  

I know, I know, Illustrator is a drawing program - but its text-handling features can be handy, too. Here's a guide to using them.

Kvern, Olav Martin. Adobe Magazine (1996). Design>Graphic Design>Image Editing>Adobe Illustrator

Usage Experts Change Their Minds, Too

Many terms and constructions frowned on a generation ago have been admitted, like many new words, into mainstream parlance and have gained wider acceptance than before. An example is tycoon, in the sense of a wealthy businessman, labeled 'informal' in the first edition of AHD but accepted in the third. Another example is balding, called 'entirely vulgar' in a usage note by panelist Katherine Anne Porter in the first edition but entered without stigma in the third.

Soukhanov, Anne H. Editorial Eye, The (2003). Articles>Style Guides>Editing

The User Edit Method for Evaluating the Usability of Documentation

A 'user edit' (also known as a 'usability edit') enables you to evaluate the usability of documentation (Schriver, 1991). Participants in a user edit study can either think aloud as they use the documentation to complete tasks or they can mark up the pages of the documentation to indicate where they had problems. The think-aloud protocols or marked-up pages are then reviewed for usability problems. The user edit report lists the problems and recommendations about how to improve the usability of the documentation.

Wilson, Chauncey E. Usability Interface (2006). Articles>Documentation>Editing>Usability

Using Editors to Win Proposals  

Paradoxically, engineers are often forced to seek jobs by pursuing a skill at which they are, admittedly, often inferior: expository writing. To win proposals for new business, they have to put their worst foot forward. This unhappy situation presents a great opportunity for editors.

Bush, Donald W. Intercom (2004). Articles>Editing>Proposals

Using Editors Where and When It Counts, Part II: How to Edit Instructions

When I teach courses on editing, I devote about one-third of the sessions to editing instructions. Why? True, there's always a demand for someone who can edit technical manuals or cookbooks, but my real reason is that working on instructions gets you into editorial shape. It hones your ability to keep readers and their needs always in mind, to weigh each word for accuracy, and to be sure that every sentence means what the writer intends.

Waxman, Maron L. Editorial Eye, The (2003). Articles>Documentation>Editing

Using Photography to Illustrate Technology Trends and New Capabilities  

The very best of today’s public relations photography devises visual statements by carefully blending composition and lighting. Dramatic use of color has emerged as a strong graphic element over the past decade. Today’s inexpensive scanners and related image manipulation software provide new capabilities to manipulate B/W and color photos.

Brus, John M. STC Proceedings (1993). Design>Document Design>Image Editing>Visual Rhetoric

Using Total Quality Management to Manage Technical Reviews  

The purpose of this workshop is to introduce attendees to Total Quality Management (TQM) techniques and practices. TQM offers common-sense guidance in the quest for quality. Using the example of an out-of-control technical review cycle, the workshop shows attendees how to better manage the technical review process, resulting in accurate, high-quality documents.

Fisher, Charles D., Jr. and Kurt Gustafson. STC Proceedings (1993). Careers>Management>Editing>SMEs

Using Virtual Peer Review through the Online Writing Center

Virtual Peer Review is an exercise in which students review the written work of other students in online or Internet-based settings. Just like peer review--an activity in which readers make suggestions for improvement on another person's writing--virtual peer review supports revision in the writing process. The difference is that this review process is conducted using online technologies.

University of Minnesota (2004). Articles>Education>Editing>Online

What Exactly Is a Copy Editor?

Copy editors check written material, usually as the final step before it is set into type, to correct errors in grammar, spelling, usage and style (in this case, style refers to a given publication's guidelines for consistency in how words, phrases, typographical elements, etc., are to be used -- or not used). Copy editors are not proofreaders, although reading proofs is often part of the job description. The difference is that proofreaders (a job title that scarcely exists anymore) are charged with simply looking for typographical and mechanical errors on copy that has already been typeset. Proofreaders -- and, indeed, copy editors reading proofs -- are often criticized rather than praised for making picky changes at that stage in the process, whereas the same changes might well be applauded at the copy-editing stage.

Walsh, Bill. Slot, The (2002). Articles>Editing

What is Digital Imaging and Why is it Important to Technical Communicators?  

Digital imaging is one of the most significant technological tools available to developers of technical documentation. Because of digital imaging equipment such as scanners and digital cameras, developing detailed, well-organized and graphic technical documentation can be done much faster and with minimal help from outside sources (e.g., drafters, photographers, and printers). The purpose of this paper is to define the fundamentals of digital imaging technology, describe its major components and applications, and help technical communicators make informed choices when evaluating digital imaging equipment.

Knerr, Dianne. STC Proceedings (2000). Presentations>Software>Image Editing

What Makes a Technical Editor Indispensable?  

Technical editors have an opportunity to fulfill an essential role within an organization by providing invaluable knowledge and skills not only to the writers they support, but cross-functionally to other members of the organization. This paper takes a look at how technical editors can reach past their substantive and copy edit abilities to ensure they are fully-integrated team members, and are sought out and depended upon for their expertise and broadened skill sets. In doing so, I’ll look at the basic and advanced skills technical editors generally need to be successful, then I will provide tips for technical editors to help make them essential and valuable team members.

Sharon, Lorraine A. STC Proceedings (2000). Presentations>Editing

When Bigger Isn't Better  

Working with large bitmap images can clog your hard disk and slow performance to a crawl. Here are some tips for staying lean.

Katz, Wendy. Adobe Magazine (1995). Design>Graphic Design>Image Editing>Adobe Photoshop

When You Have to Edit Your Own Writing  

Many technical writers work without the benefit of professional editing. While there is no substitute for a seasoned editor, writers can and should learn to perform some checks themselves. Checklists narrow the focus of editing and provide a systematic approach to polishing familiar prose. Numerous tips can also make editing easier and more effective.

Hansen, James B. STC Proceedings (1996). Articles>Editing

"Why Do We Need Editors Anyway?" Overcoming the Obstacles Facing a New Editing Group  

In the corporate arena, an editing group (particularly a newly formed one) sometimes finds it difficult to be accepted as part of a communications team and may spend an inordinate amount of its energy seeking to justify its existence. Barriers to acceptance and credibility include lack of trust and misunderstanding about what editors do or what value editing imparts. Editors can overcome these obstacles, however, through a combination of consistent work practices, clear and frequent communication with writers, and an ongoing program aimed at demonstrating the practical value of editing.

Collins, William L. STC Proceedings (1995). Articles>Editing>Collaboration

Why Edit On Screen?  

Provides a thorough introduction to the practices of on-screen editing, including how to make corrections, insert questions and suggestions, and communicate the results to the author.

Hart, Geoffrey J.S. Intercom (2000). Articles>Editing>Online