Examining the Relationship Between Quality Writing and Quality Reading    

This article introduces the ISTE approach as a way to measure the relationship between the design of a document and the way that users handle it. ISTE is an acronym for Information SubTypes and Effects. The article describes the classification of information into a general typology as well as into a specific one, to illustrate how the approach can be adapted to specific usability questions. ISTE also requires a typology for categorizing possible user reactions. This article first positions ISTE within the broader context of usability testing and then describes its basic approach and some recent applications. Unlike most formal research methods, ISTE does not require an inordinate amount of time and effort for analyzing high-fidelity data. Electronic versions such as the ERR instrument allow for the creation of a complete and detailed profile of the use of a document 10 minutes after task completion. These characteristics make ISTE a viable instrument for gathering usability metrics in industrial settings.

van der Meij, Hans. Technical Communication Online (2000). Articles>Usability>Testing>Assessment

The Executive Summary: A Key to Effective Communication    

Presenting the correct written information to a business decision maker in the appropriate form is often critical to the success of the project. A lengthy report is not likely to be read, while a project abstract with insufficient information may not allow the decision maker to act. In these cases, the executive summary may be the writer's only opportunity to convince the decision-maker to act.

Emanuel, Joseph T. Technical Communication Online (1996). Articles>Communication>Writing

Expanding the Scope of Technical Communication: Examples from the Department of Technical Communication at the University of Washington    

Argues that the technical communication field is expanding far beyond traditional areas of writing, editing, and production. Describes research at the University of Washington that helps clarify the expanding scope of our field.

Haselkorn, Mark P., Geoffrey Sauer, Jennifer Turns, Deborah L. Illman, Michio Tsutsui, Carolyn Plumb, Tom Williams, Beth E. Kolko and Jan Spyridakis. Technical Communication Online (2003). Articles>TC

Facets Are Fundamental: Rethinking Information Architecture Frameworks    

This article presents three problems with existing information architecture frameworks. First, they are too focused on organizing information based on topic. Second, they treat facets as a supplemental form of classification. Third, they conflate the organization and representation of information. Analysis of these three problems suggests that information architects should provide navigation systems and user interfaces'based on an underlying framework of faceted classification'that allow users to flexibly navigate through complex information spaces in the service of particular tasks and goals. To this end, this article introduces a faceted classification framework, and provides an example of a model framework, called 'Facets are Fundamental' (FaF). The purpose of the FaF framework is to explicitly designate faceted classification (rather than a hierarchical classification) as the starting point of the IA development process. Both of these approaches encourage information architects to employ non-topical methods for organizing and representing information.

Crystal, Abe. Technical Communication Online (2007). Articles>Information Design>Project Management

Fear and Loathing of the Help Menu: A Usability Test of Online Help    

A usability test of online Help for a Windows-based database-searching application showed that test subjects avoided the Help menu for as long as possible. When finally obliged to use Help, they read the information carelessly and bailed out quickly, even without finding the necessary information. On the other hand, the test subjects did use dialog-box Help and pop-up Help for tools. The article identifies three qualities and two requirements that are apparent in dialog-box Help and pop-up Help for tools but which are not shared by the Help menu. It suggests that these qualities and requirements may make any Help access method that contains them attractive to users. It then goes on to examine dialog-box Help, pop-up Help for tools, and several other Help access methods, that use these qualities and requirements.

Grayling, Trevor. Technical Communication Online (1998). Articles>Usability>Online

Finding Funding: Writing Winning Proposals for Research Funds    

Identifies funding sources and describes the proposal review process. Provides example criteria and identifies ways to write proposals to meet the needs of its audience of reviewers.

Grove, Laurel K. Technical Communication Online (2004). Articles>Grants>Proposals>Rhetoric

Review: The Fine Art of Copyediting  

Even though you might not be a copyeditor in a publishing house, the information that Stainton provides can be useful to any editor as well as to any writer.

Staples, Jeff. Technical Communication Online (2004). Articles>Reviews>Editing

The Five W's: An Old Tool for the New Task of Task Analysis    

An audience pays attention to your attempts at communication because they have certain needs that they expect you to solve. As journalists have long known, it's possible to meet the majority of an audience's need for information by answering five 'W' questions: what, who, where, when, and why. Although this approach is a core element of journalism, it has obvious applications to technical communicators, who must create information in the context of meeting an audience's needs.

Hart, Geoffrey J.S. Technical Communication Online (1996). Articles>Writing

Focus Groups or Individual Interviews? A Comparison of Text Evaluation Approaches    

By providing an empirical comparison of two evaluation approaches, this article aims to make it easier to choose between focus groups and individual interviews as a way of evaluating documents, and thereby to contribute to a methodology of text evaluation. The article first presents the relevant literature and then moves on to present the results of the authors' experiment. The authors find that focus groups tended to identify acceptance problems, while individual interview participants focused on comprehension.

de Jong, Menno D.T. and Peter Jan Schellens. Technical Communication Online (1998). Articles>Interviewing>Methods

From the Moon to the Microchip: Fifty Years of Technical Communication    

Explores technologies and technical writing discussed in this journal over the past 50 years. Describes how computer technologies were applied to gain efficiency in production. Notes that single sourcing and content management focus on text creation.

Durack, Katherine T. Technical Communication Online (2003). Articles>Technology>TC

From the Steam Engine to DNA: Revolutions    

This chapter from the most recent book by STC's 1998 Honorary Fellow demonstrates that a great dynamic web of change links us to one another and to all the events of the past and the future. James Watt’s improvements to the steam engine are linked to the invention of the copier, carbon paper, and the safety match, as well as the discovery of DNA.

Burke, James. Technical Communication Online (1998). Articles>Rhetoric

From Theory to Practice: Using the Information Process-Maturity Model as a Tool for Strategic Planning     

Strategic planning is no longer an option for an information-development organization that hopes to survive and thrive in the current climate of downsizing and outsourcing. Information developers must prove their value to their products and their organizations and demonstrate that they are aligned with corporate goals and objectives. Use strategic planning both as a tool to improve your organization and as a sign that you are willing to look closely at the old and comfortable ways of working and make significant quality and process improvements.

Hackos, JoAnn T. Technical Communication Online (1997). Design>Information Design

The Future of Technical Communication: The Perspective of a Management Consultant    

This commentary summarizes the seven articles in this special issue and also argues that technical communication as a profession is in the midst of a disruption caused by low-cost innovators. Technical communicators can counter this trend by drastically reducing costs and increasing productivity in current operations. But the most valuable strategy is the difficult task of pursuing customer knowledge, which is difficult to replicate by those with little access to customers. Working for the customer and providing them with the information they need to be successful in using products and systems is critical to the future of technical communication.

Hackos, JoAnn T. Technical Communication Online (2005). Articles>Management>TC

Getting Professional Help: Why Contractors and Independent Consultants Need Lawyers    

This article begins with the premise that there is no such thing as a standard contract and goes on to explore some of the ways that the attorney/client relationship can have unexpected benefits for technical communication consultants and contractors. The conclusion is that these communicators should seek legal counsel to protect themselves and their businesses.

Glick-Smith, Judith L. 'Judy' and Carol Stephenson. Technical Communication Online (1998). Careers>Consulting>Legal

Global Issues, Local Concerns    

This introduction previews the articles in this special issue and argues that developing information products for a global audience forces us to confront differences of language, culture, and experience. It also maintains that open and global collaboration strategies offer our best approach to “dealing with difference.”

Hoft, Nancy L. Technical Communication Online (1999). Articles>Human Computer Interaction>International

Going Online: Helping Technical Communicators Help Translators    

What can technical communicators do to design documents that are easier, and therefore less costly, to translate without sacrificing quality? Nearly all writers/designers concern themselves primarily with the users of the document, the primary audience, when considering translation while overlooking the secondary audience-the translators. If the source document is not written with translation in mind, translation costs can escalate. Writers/designers can, though, help reduce the translators' cognitive load by supporting them in solving language and cultural problems. In this article, we will explain why technical communicators should help translators, and we will offer some tips to creating 'translation friendly' documentation. We will also describe the research and design process involved in creating an online tutorial on writing and designing for translation which was developed for a local Twin Cities company. Although we discovered during the course of our research that there is not one generic approach

Flint, Patricia, Melanie Lord van Slyke, Doreen Starke-Meyerring and Aimee Thompson. Technical Communication Online (1999). Articles>Language>Localization

A Good Installation Guide Increases User Satisfaction and Reduces Support Costs    

In its first endeavor, the new Customer Documentation Group at SABRE Travel Information Network has shown that it adds value.

Blackwell, C. Al. Technical Communication Online (1995). Design>Documentation>Usability

A Good User's Guide Means Fewer Support Calls and Lower Support Costs    

Good user documentation means fewer client support calls and lower support costs at GE Information Services in Rockville, Maryland.

Spencer, Cathy J. and Diana Kilbourn Yates. Technical Communication Online (1995). Design>Documentation>Usability

Good, Fast and Cheap: Producing Computer-Generated Isometrics from Engineering Drawings    

It is possible to produce a computer-generated isometric illustration of sufficient quality for most applications directly from a scanned engineering drawing. The process described in this article uses Corel Trace and Corel Draw, but it can be adapted to suit other drawing or CAD programs, and it can generate sophisticated isometric illustrations.

Morris, John M. Technical Communication Online (1997). Design>Graphic Design>Technical Illustration>Isometric

Review: Graphic Designer's Digital Printing and Prepress Handbook  

The Graphic Designer's Digital Printing and Prepress Handbook is not a beginner's manual. Sidles does not walk you step-by-step through the basics of trapping or scanning. Instead, hers is an approach that expands on the knowledge of the graphic design professional. I think her aim is to help you become someone who easily knows how to avoid buying paper that will curl or using overprinted type that is illegible. Sidles, with her print production experience, seems to care about sharing the wisdom she has acquired through decades of haps and mishaps—no small benefit.

Blount Brodersen, Carolyn. Technical Communication Online (2004). Articles>Reviews>Prepress>Graphic Design

Graphics and Invention in Engineering Writing    

This study reports on the use of graphics by engineers as a method of stimulating the writing process (rhetorical invention). Information presented here comes from working engineers, based on a questionnaire developed after informal conversations and then administered to 15 participants in private industry, with questions about specific writing genres and types of graphics. Results show that graphics have a powerful function in stimulating writing ideas. Although individual writers' preferences in graphics are strong, patterns could be seen in (1) overall number of graphics types used by each writer, (2) specific types of graphics used by each writer based on the writing genre, and (3) the most common types of graphics used overall.

Hutto, David. Technical Communication Online (2007). Articles>Scientific Communication>Engineering>Technical Illustration

Green Printing: A Guide to Environmentally Responsible Printing    

Pressure from various green organizations (such as the Forest Stewardship Council and ForestEthics), government agencies, and environmentally aware consumers combined with the development of new vegetable-based materials have resulted in the availability of several alternatives to petroleum-derived chemicals for printing and paper made from wood pulp. These alternatives are increasingly price-competitive and a bargain when all costs to our environment are considered. Whether you print documents from your desktop computer or regularly contract with a printing company to produce 100,000 annual reports, user guides, or newsletters, you now have environmentally responsible printing choices. Such choices offer your company an opportunity to reduce its environmental footprint and favorably position itself in the growing Green Market. As a technical communicator, you can also feel better about your work product. This tutorial describes some of the business benefits of going green and outlines the choices that you can make when you print documents, from choosing an environmentally responsible print company to selecting vegetable-based inks and recycled or alternative paper. Even if your organization rarely produces paper-based documents for its customers, you likely can still reduce your office's paper consumption. This tutorial tells you how.

Munger, Roger. Technical Communication Online (2008). Articles>Publishing>Prepress>Environmental

Guidelines for Authoring Comprehensible Web Pages and Evaluating Their Success    

The guidelines presented in this article should enable authors to create Web pages that their readers can understand. They should also enable evaluators to judge the comprehensibility of Web pages. The guidelines are explained and supported by an examination of relevant research and usability studies.

Spyridakis, Jan H. Technical Communication Online (2000). Design>Web Design>Writing>Usability

Guidelines for Designing and Evaluating the Display of Information on the Web    

These guidelines are intended to assist Web designers, authors, and editors in their efforts to create Web pages that effectively reveal—rather than obscure or confuse—the information they are trying to present. These guidelines are also intended to be used to assist in the evaluation of existing Web sites. Of course, the design of a Web site can, to some degree, be modified by the user or by the characteristics of the browser or monitor enlisted to display it. The guidelines, consequently, acknowledge that in a very real sense, users may also assume the role of designer. The guidelines, therefore, are also intended to help users make informed decisions about how to make a display easier to use.

Williams, Thomas R. Technical Communication Online (2000). Articles>Web Design>Assessment>Visual Rhetoric

Guidelines for Designing Web Navigation    

As Web sites grow larger and more complex, the challenge of designing effective user navigation increases. We offer designers (as well as those evaluating existing Web sites) a set of 12 guidelines encompassing that attempt to cover the most important and broadly relevant navigation issues. These guidelines are grouped under four topics: (1) Designing an effective link, (2) Managing large numbers of links, (3) Providing orientation information, and (4) Augmenting link-to-link navigation. With each guideline there is an example and a synthesis of the most relevant and compelling research, theory, and expert opinion. These guidelines apply to what can be broadly termed informational Web sites rather than sites for game-players, art sites, and sites intended for whimsy and fun.

Farkas, David K. and Jean B. Farkas. Technical Communication Online (2000). Design>Web Design>Hypertext