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: 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

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 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

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

Why I Hate The Body of Your Article

I really don't care what you write about. I am more interested in the format of the article, not your view or take on the subject matter.

Pires, Halstatt. Ezine Articles (2005). Articles>Writing>Editing

Why I Hate Your Article Headlines

I’m a publisher for numerous sites. Here’s why I hate your headline and what you can do about it.

Pires, Halstatt. Ezine Articles (2005). Articles>Writing>Editing

WikiWiki as Tech Review Vehicle

Like most technical writers, getting my feature team to review my help topics for technical accuracy is like keeping an Iditarod team from making a dash for the nearest McDonalds or garbage dump in the middle of a blinding blizzard.  Technical contributors want to participate in technical documentation reviews but they rarely have enough bandwidth to do so effectively. Consequently, I spend a lot of time trying to determine the most effective way to squeeze my teammates for feedback.  This can be a painstaking process, especially for technical writers who are unlucky enough to work with teams that are halfway around the world or spread across the country. Some contributors only produce if I corner them in their office with a paper copy.  Others are overly motivated, but I love them all the same.  Most technical reviewers, at least at Microsoft, require a combination of:  incentives (food, beer, ...), attention getters (a stern note from their manager) and tech review tools that fit their working style and team culture.

Parnell, Korby. Microsoft (2004). Articles>Editing>Engineering>Assessment

Working Electronically

Editors need to know some basic techniques for dealing with files if they are going to be editing them electronically. These techniques apply to files in any format, but exactly what you do depends on which word-processor, desktop publishing program, help authoring system, or other software you are using.

Hollis Weber, Jean. Technical Editors Eyrie (2001). Articles>Editing>Technical Editing>Online

Working Memory in an Editing Task    

A number of studies have found that writers produce text in bursts of language. That is, when creating a text, writers produce a few words, pause, produce a few more words, pause, and so on. Chenoweth and Hayes (2003) hypothesized that language bursts occur when writers translate ideas in to new language. This study tested this hypothesis against the following two alternative hypotheses: (a) Language bursts are caused by proposing new ideas rather than by translating ideas in to written language and (b) language bursts depend on the form of the input to the writing process rather than on the translation process. The study employed an editing task in which participants were required to translate a written language input. The alternative hypotheses led to contradictory predictions about writers' performance in this task. The study also explored the impact of working memory restrictions on task performance.

Hayes, John R. and N. Ann Chenoweth. Written Communication (2007). Articles>Editing>Workflow>Cognitive Psychology

Writer-Editor Interactions: What Works?  

Successful writer-editor relationships require a commitment from both parties to teamwork, open communications, and shared accountability for the success of each project. The benefits from this ejj?ort include better igformation products for users and a more congenial working environmentfor you. Equally important, your clients will develop cor@ence and trust when they see a project’s writer and editor combining their skills and collaborating on shared project goals.

Collins, William L. and Susan M.J. Lester. STC Proceedings (1997). Articles>Collaboration>Editing>Writing

Writer-Editor Relationships in Revisions

Editors, professional or otherwise, can be annoying individuals. The trick is to focus on the helpful parts of that annoyance and try to ignore the less-helpful parts.

Hart, Geoffrey J.S. Geoff-Hart.com (1995). Articles>Writing>Editing>Collaboration

Writing Across the Curriculum

The phrase 'writing across the curriculum' is relatively new, as far as I am aware. I want to examine its underlying meaning, its various administrative forms, and its implications for the faculties of colleges and of high schools to look at the theory, the practice, and occasionally the history of the notion.

Kinneavy, James L. ADE Bulletin (1983). Articles>Editing>Writing>Collaboration

Writing And Editing Stem Overview  

As part of the process of developing this overview I went back to some of the Proceedings for STC conferences that were held 10 years ago. I also reviewed issues of Technical Communication that were published at the same time.

Forbes, Christopher J. STC Proceedings (1994). Articles>Writing>Editing

Writing and Editing Stem Overview  

What could embody this year’s theme of Evolution/Revolution more than the Writing and Editing Stem? On the one hand, we must continue to evolve as professionals by building our writing and editing skills, the cornerstones of our trade. On the other, we must stay on top of the information revolution our industry is experiencing. This stem will help you to do both: build upon the basics and also stay abreast of the new technology and tools that are constantly revolutionizing the ways we do our work.

Murphy, Daniel J. STC Proceedings (1996). Articles>Editing>Writing

Writing and Editing Stem Overview  

The Writing and Editing Stem of the 42nd Annual STC Conference is designed to provide sessions that speak to the questions of technical communicators today and that also remind us to 'stick to the basics' of our craft(s). In a world of to 're-imagine' the audience and gain new ever-changing technologies, we must perspectives. Find out how to motivate your accommodate both a diverse audience and a audience to learn and then keep ‘em coming back! diverse media. Our goal is to explore (proven and new) methodologies and ideas that can enhance our writing and editing skills and philosophies as we enter the 21st century.

Baxley, Deborah Lewis. STC Proceedings (1995). Articles>Writing>Editing

Writing Consistently Across Media: Ten Proofreading Tips

Last time I wrote about consistency in online writing. Soon after, I received an email from Leslie Drechsler, a reader in Tustin, CA: 'As a Marketing Communications Specialist, I'd love to hear your ideas on how to successfully implement consistency in an established business,' she wrote. 'I thought developing a company style guide would solve the problem. But perhaps there are other ways to approach it. 'Perhaps this could be the subject of another article.' Here's that article, Leslie.

Henning, Kathy. ClickZ (2001). Articles>Editing>Style Guides>Writing

Writing Drafts

One of the keys to effective technical writing is to write, edit and re-write. Once you have completed the first draft, you will need to review it several times to identify errors and inconsistencies in the text.

Klariti. Articles>Writing>Editing