Controlled Languages in Industry

A Controlled Language is a form of language with special restrictions on grammar, style, and vocabulary usage. Typically, the restrictions are placed on technical documents, including instructions, procedures, descriptions, reports, and cautions. One might consider formal written English to be the ultimate Controlled Language: a form of English with restricted word and grammar usages, but a standard too broad and too variable for use in highly technical domains. Whereas formal written English applies to society as a whole, CLs apply to the specialized sublanguages of particular domains.

Wojcik, Richard H. and James E. Hoard. Oregon Health and Science University (2005). Articles>Language>Technical Editing>Controlled Vocabulary

Coping with Wordslaughter and the "Good Enough" Syndrome  

Connatser provides advice for technical editors who aren't granted enough time or money to perform extensive revisions on poorly written documents.

Connatser, Bradford R. Intercom (2004). Articles>Editing>Technical Editing

Review: Copyediting: A Practical Guide  

If you could own only one book on copyediting, Karen Judd's Copyediting: A Practical Guide would be an excellent choice. Even if you already own the second edition, published in 1990, you will certainly find useful updates in the new third edition.

Judd, Karen. Technical Communication Online (2002). Articles>Reviews>Editing

A Copyeditor's Adventures in Multimedia Land

Publication in the 1990s encompasses worlds that most copyeditors never dreamed of when, with a mixture of delight and mistrust, we cautiously approached the first spell checkers. At least we could relate to the idea of mechanically checking spelling. The whole idea of multimedia is a little more unnerving.

Whalen, Elizabeth A. Editorial Eye, The (1998). Articles>Editing>Multimedia

Review: The Copyeditor's Handbook: A Guide for Book Publishing and Corporate Communications  

The Copyeditor's Handbook is a solid resource for novice and experienced copyeditors alike. Although it functions well as a textbook and a general learning tool, it certainly is not a replacement for The Chicago manual of style, nor does it purport to be. It's a book that acknowledges an assortment of vexing copyediting questions and offers multiple answers to most of them.

Hernandez, Gary. Technical Communication Online (2002). Articles>Reviews>Editing

A Course in Content Editing  

Describes a college course on content editing--editing that focuses on clarifying content. Emphasizing career opportunity, the course touches on new technologies that have transformed editing, the editor-author relationship, and the editing of user manuals.

Bush, Donald W. Intercom (2000). Articles>Education>Editing

Creating an Editing Policy  

As an editor, you realize how important it is to edit information consistently. What you might not realize how important it is to let the writer know how you are going to edit, what you are going to edit, and what you expect from the writer. An editing policy lets you communicate these things to the writer. When you and the writer know what to expect from each other, you are able to work together as a team to produce a quality document.

Reed, Wendy L. STC Proceedings (1994). Articles>Editing>Collaboration

Creating Editing Metrics  

Using simple templates, you learn how to customize editing metrics to represent your department processes.

Avanzato, Chris. STC Proceedings (1995). Articles>Editing

Critiquing Critiques: A Genre Analysis of Feedback Across Novice to Expert Design Studios    

In the discipline of design, the most common presentation genre is the critique, and the most central aspect of this genre is the feedback. Using a qualitative framework, this article identifies a typology of feedback, compares the frequencies of feedback types between different levels of design studios ranging from novice to expert, and explores what the feedback reflects about the social and educational context of these design studios. Results suggest that the feedback socialized students into egalitarian relationships and autonomous decision-making identities that were perhaps more reflective of academic developmental stages or idealized workplace contexts than of actual professional settings--therefore potentially complicating the preprofessional goals of the critique.

Dannels, Deanna P. and Kelly Norris Martin. Journal of Business and Technical Communication (2008). Articles>Editing>Collaboration

CRT - in a New Look

Although CRT is small in numbers, it is already acquainted with the 'big' sister societies, such as tekom (Germany), ISTC (Great Britain) and other Technical Communicator groups in Europe. We were very pleased with the initial contacts made in Brussels early in 2001 aimed at establishing a new umbrella organization for technical communicators in Europe.

Flacke, Marie-Louise. TC-FORUM (2000). Articles>Editing>Regional>Europe

Deciding What Needs to be Done

Before you begin editing a document, you need to analyse it and plan what needs to be done. The exception is when your job is strictly limited (by your supervisor or the client) to correcting only the glaring errors of spelling, punctuation and grammar (a 'light edit'). There is no point to attempting a more substantive edit if doing so will only get you into trouble (or if the client won't pay you for the time you spend).

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

Defining Editing and the Top Five Rules

Do no harm: this means no harm to the author's intended meaning, reputation, or legal liability; no harm to the reader, such as by omitting necessary safety information; and no ethical harm, such as by knowingly distorting the truth.

Hart, Geoffrey J.S. Geoff-Hart.com (1999). Articles>Editing

Defining Glossaries    

Glossaries are lists of specialized word definitions contained in technical documentation that can assist the nontechnical user to comprehend fully the technical topic at hand. In a joint project with SAS Institute, I sought to discover how glossaries were first developed, what guidelines are available for technical writers in the writing of glossaries, and what rhetorical technique might be of value for glossary writers. I found that glossaries are much more than simple word lists; they are, in fact, an opportunity for the technical writer to outline and protect the parameters of technical discourse between a company and its customers across multiple communications channels, and different languages. In an increasingly global technical environment, an explicit connection between the rhetorical technique of definition and the writing of glossary definitions should be made to aid technical writers in this task.

Tackabery, Michelle Kidd. Technical Communication Online (2005). Articles>Editing>Glossary

Designing a Table of Contents  

Describes how technical writers can design usable, helpful tables of contents for both printed documentation and help files.

Wright, Marcia G. Intercom (2002). Articles>Editing>Information Design

Designing an Effective Review Process  

Review processes can easily become frustrating and complicated. Hart shows how to create and revive a review process that can be tailored to the needs of your situation.

Hart, Geoffrey J.S. Intercom (2006). Articles>Publishing>Editing>Workflow

Developing and Implementing Project Style Guides  

Style guides can be very effective tools for achieving uniformity in documentation. Their use can enhance the appearance, readability, and tone of a document. In this progression session, I would like to discuss why style guides are needed, what should be included in them, and how to create a style guide appropriate for your project. I invite participants to bring style guides with them for critique and discussion.

Marks, Sandra R. STC Proceedings (1996). Articles>Style Guides>Editing

Developing Indexes

As a technical writer, you'll typically have to create indexes for the print books and for online helps you develop. The type of index we mean here is the classic back-of-book index that shows page numbers on which topics and subtopics occur within the book. An online index is much the same except that you supply hypertext links rather than page numbers.

McMurrey, David A. Illuminati Online (2004). Articles>Editing>Indexing>Technical Writing

Developing New Levels of Edit  

In 1985, the writing and editing group at Los Alamos National Laboratory established four levels of edit for technical reports. When a survey in 1994 showed that both authors and editors felt the levels were not meeting author needs, we set about revising them. Our goals were to simplify the editing process, focus editing on improving technical clarity, and ensure that value was added in editing. This paper describes our revision process and product--—three author-based levels of edit.

Prono, Judyth, Martha DeLanoy, Robert Deupree, Jeffrey Skiby and Brian Thompson. STC Proceedings (1998). Articles>Editing>Standards

Developmental Edits: A Quick Reference  

Performing a developmental edit early in the writing process ensures that the larger issues of organization and usability will be addressed while there is still time to make changes. The writing manager, lead writer, or technical editor should do the developmental edit. This edit consists of reviewing an early (in many cases partial) draft of the document and (1) making sure it adheres to the document plan, (2) studying the table of contents to verify that the organization is effective, and (3) doing a copy edit spot check. Although many of the issues turned up in a developmental edit are similar to those found during a copy edit, finding them early on saves the writer time and effort as the rest of the book is written.

Arakelian, Caroline. STC Proceedings (1998). Articles>Editing

Did Somebody Say 'Duh'?

The year 2000 is a big duh for computers. But 2020 is when today's kids will rule the universe, as they already seem to rule the language. We'll have a State of the Union address consisting of 'duh!' with a rebuttal of 'DUH-uh' followed by the analysis, 'Excuse me?' I'm not sure whether this is a bad thing, given the present state of adult rhetoric and the occasional charms of juve-talk, or kid-lish. Concise and animated, the sardonic/ moronic idiom of school kids can slice through our stale officialese. Some of it -- the more cuddly terms, not the hard-edged hip-hop -- tickles that laugh-spot recently located in the brain. Yet, when millions of grown-ups, even those who communicate for a living, start aping little people in baggies, one has to fear for the range of human expression.

Plotnik, Arthur. Editorial Eye, The (2003). Articles>Language>Editing

Double Take

When I peer-review a four-page document and insert the word the seventeen times, I wonder: Is this what my company is paying me to do? Am I truly adding value for my customers?

Wenger, Andrea. Carolina Communique (2006). Articles>Editing>Grammar

E-Editing for Global Audiences  

The role of the technical communicator, including that of the technical editor, has evolved to encompass a broad range of responsibilities and skills. The familiar editing processes can be streamlined into four levels of editing, thus providing a basis for a business model for highperformance, global teams. By combining the familiar levels of editing with the latest innovations of one-page business plans, a streamlined e-editing model can be used by high-performance teams to produce high-quality information in a timely and an efficient manner for global audiences.

Adler, Linda J. and Helen Lenane. STC Proceedings (2003). Articles>Editing>Online