Adapting Traditional Editing Practices for Online Documentation

Developing a process and using guidelines for editing online documents, both rooted in traditional editing practices.

Fink, Bonnie L., Carol E. Gasser, Jennifer L. Giordano and Beth A. Williams. STC Orange County (1998). Presentations>Documentation>Editing

Becoming a Journal Peer Reviewer  

This session will help participants understand the process for reviewing manuscripts submitted to Technical Communication. It covers the types of articles the journal publishes, review procedures and criteria, and approaches to writing constructive evaluations.

Hayhoe, George F. STC Proceedings (1998). Presentations>Editing>Technical Editing

Careful Scientific Writing: A Guide for the Nitpicker, the Novice, and the Nervous  

Writing scientific documentation has a unique set of caveats, pitfalls, and red flags that other types of writing do not have. The very nature of scientific writing demands the precise use of words and phrases, however, this precise usage is often discounted as being pedantic by many people. The reason for this precision is to communicate sometimes highly technical information to others who may, or may not, be as knowledgeable as the author, and who may, or may not, be a native speaker of the language in which the author is writing. To do this, accurate words and phrases must be used, especially in light of globalization and sciences that involve multiple disciplines.

Firestone, Elaine R. and Stanford B. Hooker. STC Proceedings (2001). Presentations>Scientific Communication>Editing

Degrees of Edit  

The levels of edit concept can be a valuable editorial tool, especially to clarify for staff what editors do with documents. However focusing on degrees of edit (light, medium, and heavy) can simplify decisions about editorial work on a document. Dividing heavy edits into macro edits and micro edits can clarify what editors do in editing a document thoroughly. This presentation simplifies the editorial process by examining the three different degrees of edit and establishing the aims and procedures for macro and micro editing.

Samson, Donald C., Jr. STC Proceedings (1993). Presentations>Writing>Editing

Editing Computer Hardware Procedures for Multimedia Presentation    

Traditionally, technical editors have ensured consistency in the voice, grammar, and terminology of print documentation. As publications departments have moved to delivering online documentation, the role of the editor has varied and expanded. Editing multimedia documentation requires an even wider scope of skills than editing online documentation.

Jackson, Sue. ACM SIGDOC (2001). Presentations>Documentation>Editing>Multimedia

Editing Fiction: Do You Dare?  

Technical editors may wish to use their current skills in new ways by editing novels or short stories. This paper explores how, by editing such manuscripts, they create personal links to the complex and demanding world of fiction. A thorough understanding of the similarities and differences between technical editing and fiction editing is crucial, as is knowledge of the characteristics of publishable fiction.

Jennings, Ann S. STC Proceedings (1999). Presentations>Editing

Editing in a Single-Source Environment  

The trend in the technical documentation community is toward single-sourcing: reusing common bits of information. This paper examines the role of the editor in this process, and the effect it has on traditional editorial practices.

Gelb, Janice. STC Proceedings (2001). Presentations>Editing>Single Sourcing

Editing Multimedia  

Multimedia involves “many” “means of communication” – many ways of getting a message across. Whether you edit the work of others or submit your own work to the Red Pen, a closer look at what is involved in editing multimedia – tasks, process, and skills required – can help you create multimedia solutions that deliver your message with flying colors!

Prince, Deborah Smith and Cynthia C. Currie. STC Proceedings (2000). Presentations>Multimedia>Editing

Editing to Teach  

Authors often are unreceptive to editing because they see editorial comments and changes as arbitrary. Editing that offers “rules,” asks questions, gives choices to authors, and provides examples of better ways to express ideas takes very little additional editorial time and enables authors to see editing as a significant contribution to document quality. Writing problems that cannot be addressed during editing can be addressed in brief training sessions that encourage authors to incorporate what they learn into their writing.

Sartoris, Brenda E. STC Proceedings (1993). Presentations>Education>Editing

From Editing to Writing: Learning the Write Stuff  

At SAS Institute Inc., a leading software development corporation, the Documentation Development Division maintains separate staffs for writing and editing. Working as an editor and working as a writer require distinctly different skills in developing user documentation. In this paper, we discuss our experience making the transition from editing to writing: the differences between the jobs, the similarities, and how working as editors has benefited us as writers. We direct this paper to anyone interested in making the change, in either direction. While your situation may differ, we hope you find our experience informative.

Restivo, Kathryn A. and Philip R. Shelton. STC Proceedings (1994). Presentations>Editing>Writing

How Much Technical Knowledge Do Editors Need? The Authors’ Perspective  

Technical communication professionals and educators often discuss how much technical training editors need to effectively perform their job: however, their authors’ opinions are seldom considered. Thus, I designed a survey to gauge the authors’ perceptions of how much technical knowledge editors need and how this technical knowledge affects the editorial process. The survey results indicate that most authors think technical editors should have some technical background, but this background does not have to be in any particular subject. In addition, most authors believe that this technical background improves the editorial process.

Roper, Donna G. STC Proceedings (1993). Presentations>Editing

Improving The Documentation Process Through Structured Walkthroughs  

Documentation walkthroughs simplify the technical review process for both writer and reviewer. Walkthroughs are focused, interdisciplinary meetings at which technical reviewers evaluate the technical accuracy of documentation specifications. Documentation producers can use documentation specifications and walkthroughs to keep technical reviewers focused on technical accuracy rather than editorial issues. This, in turn, leads to fewer technical errors in the first draft and earlier reviewer involvement.

Chatfield, Carl S. STC Proceedings (1994). Presentations>Editing>Collaboration

The Online Editing Evolution  

Increasingly, editors are being asked to perform online editing of traditional paper documents, edit documents that will ultimately reside online, or both. Yet many editors are unfamiliar with the new tools and information media that often require us to rethink existing ways of doing our jobs. Editors and other information developers will discuss some of the issues we must face and share their own insights about this emerging area of concern as we move into new, initially intimidating territory.

Hamilton, Karen J. STC Proceedings (1996). Presentations>Editing>Online

Participles Becoming Prepositions--Some Arcane Information for Editors

A presentation that accompanies the paper of the same name at http://webhome.crk.umn.edu/~mpringle/UsingPaper.rtf.

Pringle, Mary Margaret. STCTC (2001). Presentations>Editing>Grammar>Minimalism

Participles Becoming Prepositions--Some Arcane Information for Editors

In English, some participles have already become prepositions. The author noticed in her work as a technical editor that most of her writers seemed to perceive the participle 'using' as a preposition already although it is not listed as such in the dictionary. The paper gives the evidence and rationale for making such a claim. It offers a window on written language change in progress and celebrates the language user’s ability to make the stolid dialect we call technical writing more vigorous and efficient by turning a participle into a preposition.

Pringle, Mary Margaret. STCTC (2001). Presentations>Editing>Grammar>Minimalism

Style Guide Revision: Message and Medium - A Case Study  

Creating and revising a corporate style guide is a matter of convincing, as well as showing the users, that publishing documents in a consistent manner is cost-effective. The second edition of the Style Guide for the Savannah River Site reflects the many changes that occurred in the world and at this government site in the last six years. Because documents are processed by individuals using desktop publishing products, this style guide edition was created with input from and for the individual user Topics covered the same ground as the previous edition (i.e., procedures, papers, reports, manuals, correspondence), but one major change was placing the style guide on the site intranet to reduce paper distribution and providing information on electronic publishing.

Phillips, Amy G. and Cathie Witker. STC Proceedings (1997). Presentations>Editing>Style Guides>Case Studies

Technical Editing  

A brief perspective on technical editing.

Rajan, D.V. STC India (2003). Presentations>Editing>Technical 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

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