Incorporating Revision

Revision refers to the process of reviewing one's work and making changes (either local or global) to improve the writing.  Most teachers of writing encourage students to revise their work by creating drafts and going through a process of review -- either by having teacher review drafts or having other students review drafts.

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

Learning the Fine Art of Reviewing

If you asked me what the most painful part of being a technical writer is, my answer would be: 'Getting reviews on time. Getting good feedback and inputs on your work.' For me technical writing has been very pleasurable because I hardly got any review comments. My morale has therefore been very high. Project managers, developers and others are so busy trying to come up with good software (read trying to fix all the goof-ups and bugs!) that they usually tend to give documentation lesser importance. User manuals, who reads them anyway? We do not have time for it!

Kamath, Gurudutt R. IT People (2003). Articles>Editing>Collaboration>Technical Writing

More Than Just Error Correction: Students' Perspectives on Their Revision Processes During Writing    

Drawing on the second phase of a 2-year study of students' linguistic and compositional processes, this article describes students' reflections on their online revision processes, those revisions made during the process of translating thoughts into written text. The data collected were from classroom observation and post hoc interviews with 34 students, who were observed during a writing task in the English classrooms and interviewed subsequently to elicit their reflections and understandings of their own revising processes. The analysis indicates that students tend to conceptualize revision as a macro-strategy and as a task that is predominantly undertaken as a posttextual production reviewing activity. It also indicates that students engage in multiple revising activities during writing, including many revisions that are not concerned with simple matters of surface accuracy, and many students are able to talk about these perceptively and with insight.

Myhill, Debra and Susan Jones. Written Communication (2007). Articles>Writing>Editing

Nancy's Wordsmithy: Rules You Don't Have to Obey, Part III

The funny thing is, this rule should be running out of steam, because certain standards of written English have changed in ways that make the rule at least partly obsolete. Learning it is kind of like learning to change a cloth ribbon on an old manual typewriter.

Allison, Nancy. Boston Broadside (1989). Articles>Writing>Editing>Grammar

Now That You've Got a Double Agent, What Do You Do With 'Em?  

Having demonstrated the importance of acquiring a double agent for writing projects, we now want to explain the best ways to successfully indoctrinate a double agent. This paper will help you prepare for, orient, train, and become a mentor for a double agent to help make him or her an effective member of your writing team.

Fisher, Judith R., Karen L. Mobley and Michelle M. Wright. STC Proceedings (1994). Articles>Writing>Technical Editing>Collaboration

One Hundred Simple Tech Writing Errors

Here are the 100 writing errors that the author has encountered in his experience. (Followed by the subsequent article 'Ten More Errors in Technical Writing.')

Kamath, Gurudutt R. IT People (2003). Articles>Editing>Grammar>Technical Writing

"Prescriptive" Audience Analysis: Moving Beyond the Purely Descriptive

Editing and writing both require an understanding of our audience, because without that knowledge, we can't shape our words to help them easily grasp difficult concepts. To understand our audience, we do what all writers and editors do, whether consciously or unconsciously: We create an image of our audience that guides our choice of words, images, and metaphors. This image is variously known as a 'stereotype' or a 'persona'. Keeping that image in mind as we work helps us satisfy the reader's needs, but if we're not careful, it can also cause us to waste valuable time collecting information that doesn't really help us communicate.

Hart, Geoffrey J.S. TECHWR-L (2003). Articles>Writing>Editing>Rhetoric

Reviewing a Peer's Work  

If we've been asked by a peer to review his or her work before it is sent out to be scrutinized by the world, our job is to neither edit nor rewrite the information. Our job is to give helpful, specific feedback about where the information communicates well and where it needs work. The more we understand about how to review a peer's work effectively, and how doing this is different from editing, the better feedback we can provide.

Gillihan, Dana L. STC Proceedings (1993). Articles>Collaboration>Editing>Writing

The Role of the Editor in the Technical Writing Team

Editing today covers far more than printed materials. In this discussion, I am assuming a technical editor may be required to deal with: printed materials (for example, books, pamphlets, quick reference cards); electronic (for example, online documentation, online help, web pages); video scripts; computer-based training materials. I am also assuming that the audience for the material being edited is not comprised of other technical people; or if it is, the editor is not the person responsible for ensuring the technical accuracy of the material.

Hollis Weber, Jean. Technical Editors Eyrie (2002). Articles>Editing>Collaboration>Technical Writing

Strategies for Peer-Reviewing and Team-Writing

When you peer-review other people's writing, remember above all that you should consider all aspects of that writing, not just--in fact, least of all--the grammar, spelling, and punctuation.

McMurrey, David A. Illuminati Online (2001). Articles>Collaboration>Editing>Writing

Substantive Editing: Building the Logical Inner Sanctum  

The inner sanctum of any good piece of writing is a solid, logical core. To produce the logical core, a writer frequently has to synthesize complex information, which means understanding it well enough to transform often muddled and random detail to clear and easy to apprehend expression. Synthesis of new information, being one of the most difficult thinking skills, can require more of a writer than the writer has time for. An editor's job, from the first draft to the last, is to help build the writing around an appropriate logical core. In this workshop, participants will practice techniques that editors can use to make sure that they find, or help the writer find, the core - what users need to know, and the order in which they need to know it. Participants will form groups to scan a document, using a checklist of tips to spot problems in the document's structure. Each group will report its findings to the larger group.

Nahigian, Alma L. and Jacquelyn Malone. STC Proceedings (1993). Articles>Editing>Information Design>Writing

Tech Writers, Grammar, and the Prescriptive Attitude

Prescriptive grammar is useful for teaching English as a second language, but it has little value for the practicing writer. Clinging to it may provide emotional security, but only at the expense of making writing harder than it needs to be. The culture-wide devotion to it will not be changed in a moment. But conscientious writers can at least change their own habits, and make life easier for themselves.

Byfield, Bruce. TECHWR-L (2008). Articles>Writing>Editing>Technical Writing

Technical Translation: Craft, Not Commodity  

Describes the work of translators and suggests strategies buyers can use to find the best translator for their needs.

Cardillo, Louis M. Intercom (2004). Articles>Editing>Localization>Technical Writing

Technical Writing's Big Secret

The big secret in technical writing is that most of the harder documents aren't written by the technical writers at all. In fact, many "technical writers" never do any writing at all. Instead, the drafts are written by engineers or marketers. The technical writers perform editorial functions and provide publications services -- copy-editing, layout, review management, and so on.

Plamondon, Robert. High-Tech Technical Writing (2008). Articles>Writing>Technical Writing>Technical Editing

Technischer Redakteur

Der Technische Redakteur erstellt und aktualisiert aussagefähige, umsetzbare, verständliche technische Dokumentationen aller Art.

Wikipedia. (German) Articles>Writing>Technical Editing

Technology: A Blessing for Writers and Editors?

Computers have changed the way writers and editors work. But are we getting the most from the new tools?

Bodzin, Gene. Writer's Block (1996). Articles>Writing>Editing>Online

Ten More Errors in Technical Writing

So, well, here are 10 more errors. This time we will focus on grammar and punctuation. Most of these are simplistic and obvious. But then they are too common. As usual, I have slipped in some content for the advanced writers too. (This article is a follow-up to 'One Hundred Simple Tech Writing Errors .)

Kamath, Gurudutt R. IT People (2003). Articles>Editing>Grammar>Technical Writing

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

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

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