A directory of resources inthe field of technical communication.


373 found. Page 1 of 15.

About this Site | Advanced Search | Localization | Site Maps

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15  NEXT PAGE »



The ABCs of Writing a Technical Glossary   (peer-reviewed)   (members only)

This article identifies and explains format rules, style rules, and lexicographic conventions that have been shown to improve clarity and precision in a technical glossary. Rationale for the rules of language, presentation, and style are examined. The need to allow flexibility in following the rules is discussed in terms of strengthening the technical merit and vitality of the glossary. This article also describes the computer-display techniques and file-management system used in committee to develop U.S. Federal Standard 1037C, Glossary of telecommunication terms, and to display the results both in the meeting room and on the Internet between meetings.

Gray, Evie, William Ingram and Dennis Bodson. Technical Communication Online (1998). Articles>Editing>Technical Editing>Glossary


Access to Current and Next-Generation Information Systems by People with Disabilities

The purpose of this document is to provide information and resources for those interested in learning more about accessibility issues and current and next-generation information systems. The current focus of this document is on the National Information Infrastructure (NII), sometimes known as the 'information superhighway.' This document contains both information presented at a very introductory level and information which is more technical in nature. Wherever possible, all of the technical discussions are broken out and presented separately, so that readers may course through the material at a level which is comfortable to them, and which meets their information needs. This is a living document which will be continually revised and added to as more information is collected and as the efforts in the area of research, development, and public policy continue to evolve. The most recent form of this document can be found on the Internet via our ftp, gopher, or WWW servers. All of these are located at: trace.wisc.edu The document can be viewed on-line or downloaded in one of several forms to facilitate accessibility.

University of Wisconsin. Articles>Editing>Accessibility>Usability


Review: ACES Book Reviews  (link broken)

A collection of reviews of recent books in editing (particularly for journalism).

ACES. Articles>Reviews>Editing


Achieving Consistency among Editors

I manage a group of editors at a software company. This topic describes how we strive to achieve consistency in editing software documentation among a group of editors both within a department and across divisions in a large company. We have a staff of 14 editors that serve five large writing departments. Our editors are excellent grammarians before they come to SAS, but they also get considerable training and mentoring in SAS specific guidelines when they join our staff. I acknowledge that it’s impossible to achieve 100% consistency across all editors, but consistency is worth striving for for several reasons.

Moell, Patricia G. STC Technical Editing SIG (2010). Articles>Editing>Collaboration>Technical Editing


Adapting Traditional Editing Practices for Online Documentation  (link broken)   (PDF)

Technical editors are possibly best known for their abilities to transform information with format, content, grammatical, and mechanical problems into coherent, concise, understandable, and usable documents. Editors must not only provide such services for the information authors, but they must also understand and support users' needs and expectations. This presentation gives editors an approach to editing online documentation that is rooted in traditional editing practices.

Fink, Bonnie L., Carol Gasser, Jennifer Giordano and Beth A. Williams. STC Proceedings (1998). Articles>Editing>Documentation>Online


Adding High-Impact Filters to Your Titles

Words go so well with video. They can give an emotional punch to a scene or simply announce what is going to happen next. I love using romantic quotes, Bible passages, and other forms of text in my work. The best part is that you can be just as creative with how those words are presented as you are in picking out the text in the first place.

McManus, Joe. Event DV (2008). Articles>Multimedia>Image Editing>Video


Alphabetizing an Index

It is important to alphabetize your index in a consistent manner. Otherwise, your readers may become confused or miss an important entry. There are two basic ways to alphabetize, or sort, an index: word by word; letter by letter.

Brown, Fred. Allegro Time! (2001). Articles>Indexing>Editing


Alternatives to the Paragraph

'It's all in the manual.' How many times have you heard that - or said it in frustration? After all, when you are the person who wrote the manual, you know that all the answers are there. But time and again readers can't find what they need to know, or don't understand the material. Before you blame the reader, look again at how you've presented the material.

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


Angels and Copy Editors Defend Us!  (link broken)

Tinkering with the author's words simply because 'I would not write them that way' is not discretion, but interference. Preserving the author's authentic voice is as important as enhancing its presentation so as to maintain the authority of the words. Of what, then, does the enhancing consist? And how does editorial discretion fit in?

Fothergill-Brown, Ann. Writer's Block (1999). Articles>Writing>Editing


Appropriate Use of Alternative Text

Adding alternative text for images is the first principle of web accessibility. It is also one of the most difficult to properly implement. The web is replete with images that have missing, incorrect, or poor alternative text. Like many things in web accessibility, determining appropriate, equivalent, alternative text is often a matter of personal interpretation. Through the use of examples, this article will present our experienced interpretation of appropriate use of alternative text.

WebAIM (2005). Articles>Accessibility>Image Editing>Web Design


Ask the Indexer: Get Answers to your Indexing Questions from Experienced Technical Indexers  (link broken)   (PDF)

After brief introductions by 4 panelists who are all members of the Indexing SIG (and experienced indexers and technical writers), we plan to discuss Frequently Asked Questions (FAQs) about indexing, and allow plenty of time for questions.

Bonura, Larry S., Dick Evans, Joan K. Griffitts and Peg Mauer. STC Proceedings (1999). Articles>Indexing>Technical Editing>FAQ


Assessing the Overall Quality of a Document Based on Editorial Comments   (members only)

Technical writers are often responsible for creating and maintaining multiple documents. In organizations where a formal editorial review is integral to the documentation process, technical writers who own multiple documents might need to address a huge volume of editorial input, often received late in the documentation cycle. What do all of those editorial comments, when taken as a whole, really mean in terms of the overall quality of the document? Lots of red ink might mean either that the document is in bad shape or that the editor loves to explain every comment, however minor, in great detail. On the other hand, a short comment buried on page 63 might turn out to be the single most important editorial value-add for the entire document!

Dhanagopal, Kumar. Intercom (2010). Articles>Editing>Technical Translation>Documentation


Attaining Review Nirvana with Acrobat 8 Professional  (link broken)

Getting documents reviewed has always been a tricky proposition for writers. From pleading to coercion to bribery just stopping short of third-degree torture, writers have documented many methods for getting reviews done effectively and in time. For those writers who gave up altogether and for those who just did not care too much for reviews, there is bad news coming – companies are asking for user feedback on the content that you wrote. Users, as we know them, can shame the most cynical movie critic when it comes to commenting. In my quest many a tool tried to lure me, but when Acrobat 8 strut its shared review stuff in front of me, I finally succumbed.

Kurnool, Preran. Indus (2008). Articles>Editing>Collaboration>Adobe Acrobat


Automating Your Edits  (link broken)   (PDF)

Suggests several uses of Microsoft Word's macro capabilities to help editors improve their speed and consistency. Macros, for example, are customized keystroke commands.

Hart, Geoffrey J.S. Intercom (2001). Articles>Editing>Software>Microsoft Word


Banishing Your Inner Critic

Imagine you are standing on a bridge casting a net. Above the bridge is your conscious mind, where thoughts come and go like travelers visiting a fair. Below the bridge is your subconscious—the ever-flowing stream of random thoughts, with countless ideas darting through the water like schools of brightly-colored fish. As is often the case where bridges and streams are concerned, a cold and menacing troll lurks nearby. This troll is your “Inner Critic.” The troll, aggressive and mean-spirited, doesn’t give a lick about your Grand Ideas. The troll has but one purpose: to prevent the ideas which playfully zoom about your subconscious from being gathered into the net of your consciousness and made manifest in the world. The resourceful and clever troll employs many tools to complete its task, ranging from the subtle (distractions and boredom), to the complexities of perfectionism, to diminished confidence and a paralyzing fear of failure. When the troll is in its élan (which is far more often than we’d like), its efforts decrease your ideation and productivity, dampening your awesomeness.

Jacobs, Denise. List Apart, A (2011). Articles>Editing>Advice


Barriers and Approaches to Reviewing Documentation

This article discusses some important issues in implementing a software documentation review process. If you are part of a small development organization and have few reviewer resources available, you may have to improvise techniques for providing the services and procedures suggested here.

Boston Broadside (1997). Articles>Documentation>Editing>Collaboration


Becoming a Journal Peer Reviewer    (PDF)

This session will help participants understand the process for reviewing manuscripts submitted to

Hayhoe, George F. STC Proceedings (1999). Articles>Publishing>Editing


Beginning to Edit Physics   (PDF)

A physicist-turned-editor shows you the basics required for copyediting physics papers (physical quantities, symbols, units, scientific notation, the structure of mathematical expressions, the nature of graphs), and points the way to learning enough 'editorial physics' to begin substantive editing.

Murphy, Peter W. STC Proceedings (1995). Articles>Editing>Scientific Communication


Benchmarks for Estimating Editing Speed

But editing must surely take longer than reading. Maybe it takes, say, five times longer. That would mean editing about 12 pages per hour. Sounds good. Just read the page five times, and out pop the edits. Actually, that heuristic may hold true for a simple edit, but substantive editing takes more time - 15 to 60 minutes per page, some experts say. So, how long can editing take?

McClintock, David W. STC Technical Editing SIG (2003). Articles>Editing>Technical Editing>Estimating


Best Practices for Online Review

Marking up paper is still the most common way to review documents, but online review is critical if you work as part of a distributed team. There are advantages to online review even if you sit only a cubicle away from your reviewer. Here are few tips for making your online reviews go smoothly.

Smith, Terry. Carolina Communiqué (2009). Articles>Editing>Online>Collaboration


Beyond Copy-Editing: The Editor-Writer Relationship

Editing is often narrowly defined as making corrections after a document is written. This approach typically relegates the editor to a low-status role within the organisation.

Durham, Marsha. Technical Editors Eyrie (1991). Articles>Editing>Collaboration


Beyond Gutenberg  (link broken)

Editing must change for the Web, but perhaps not so much as you think. In paper publishing, different documents require different rules and procedures: An annual report requires more editing and more attention to detail than an office memo. Similarly, not all Web documents are equal.

Ivey, Keith C. Editorial Eye, The (1996). Articles>Web Design>Editing>Writing


A Brief Guide to Communication Products Used in Online Learning

An overview of the various genres of information about online learning products.

Carliner, Saul. Saul Carliner Studio (2003). Articles>Editing>Online


A Brief Introduction to Technical Style

Technical style conveys information about a scientific or engineering topic concisely and clearly. Technical style emphasizes means, actions, and results more than human agents.

conneXions (2008). Articles>Editing>Style Guides>Technical Editing


Bug Reports: Your Road to Visibility  (link broken)   (PDF)

Argues that technical writers have a professional duty to report defects in software and presents examples of software problems that require bug reports.

Leritz-Higgins, Sarah E. Intercom (2002). Articles>Writing>Editing



Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon