How In-Process Measures Can Help You Manage Quality  

Some technical communicators see productivity and quality measurements as threatening when these measurements are used as an evaluation of the person, not the process or the product. Communicators can also be frustrated by the time and effort it takes to collect quality measurements with no visible result or improvement of their own work. This paper discusses how managers of technical communicators can develop and implement a system of in-process measurements to help technical communicators manage the process and improve their own final documentation before it is shipped to the customer, without being threatened by the measurement system.

Fisher, Lori H. STC Proceedings (1997). Articles>Writing>Assessment>Technical Writing

How the Web Is Changing the Role of the Service Course    

The service course is undergoing another change in its role in the Technical Communication program. Over the years, the service course has evolved from a way of providing students with mastery of genre and style to a way of introducing students to their role as communicators in the rhetorical situation. The Web drives the new role evolving out of this solid past. The service course now provides students with a basis for independent creation. Programs must fill four key needs for students entering the job market. Students must: learn to learn; master the processes involved in creating information; learn applications quickly and graduate having mastered several; and understand information design.

Riordan, Dan. CPTSC Proceedings (2001). Articles>Education>Writing>Technical Writing

How to Edit for Content  

Editing involves more than just formatting and inserting page numbers. You need to ask, 'How can I improve the communication?'

Bush, Donald W. Intercom (2003). Articles>Editing>Writing>Technical Writing

How to Find Technical Writing Jobs

There are some key differences between looking for publishing jobs and looking for technical writing jobs.

Hewitt, John. Writer's Resource Center (2004). Careers>Writing>Technical Writing

How to Hire Technical Writers: A Manager's Viewpoint  

Hiring technical writers is an infrequent but important part of a manager's job. Clearly defining the job and the required skills is the first step. Then use all of your networks to find candidates. Read résumés to find those that best match your requirements. The interview team needs to be prepared to ask relevant questions that verify and expand on the résumé and samples. Compare the interview team's evaluations, then check the references of your best one or two candidates, and make a prompt offer.

Huettner, Brenda P. and Ken Jackson. STC Proceedings (1996). Careers>Management>Writing>Technical Writing

How to Justify Hiring Technical Writers During Hard Economic Times

The marketplace for technical writers has often been challenging. In difficult economic times when companies seek to slash their budgets, it is often difficult for corporations to understand the need for a technical writer, let alone to understand the need to increase staffing in the documentation department. This article looks at the benefits of hiring technical writers, since their often diverse skill sets can be used across various departments in the organization.

Datta, Aparna. Writing Assistance (2007). Careers>Management>Writing>Technical Writing

How to Land a Career in Technical Writing

While technical writers are expected to have some knowledge of the subjects they write about, experts usually provide detailed information. Technical writers and editors organize the information, put it into user-friendly language, select graphics, write sidebars, and impose a consistent format, checking back with experts to fill in blanks and ensure that no errors have been introduced.

Bradley, Gwendolyn. Chronicle of Higher Education (2000). Careers>Writing>Technical Writing

How to Make Yourself More Marketable in a Small Company  

In a time when corporate downsizing is the norm rather than the exception, technical writers must constantly increase and market their skill sets to make themselves more valuable to employers. Based on our experiences as technical writers in a small company, we will define why and how to market yourself:

Holman, Peter M., Susan Gonzalez and Jennifer Privette. STC Proceedings (1997). Careers>Writing>Marketing>Technical Writing

How to Market a Documentation Department

When you first ventured into the tech writing ranks, marketing the department was likely the furthest thing from your mind. You already had work to do, so marketing was somebody else's job.

King, Robert. Writing Assistance (2006). Careers>Management>Technical Writing>Marketing

How to Write a Report Without Getting Lynched

You put forth your best effort to explain to the stupid sods exactly how and where they screwed up, then they have the temerity to not appreciate your fine efforts. Here's how to write a report that will cause change, instead of uproar.

Tognazzini, Bruce. Nielsen Norman Group (2001). Articles>Usability>Reports>Technical Writing

How to Write a White Paper

A white paper in the high-tech industry is a technical document that describes how a technology or product solves a particular problem. It's a marketing document and a technical document, yet it doesn't go too far in either direction. A good white paper is informative and is designed to show off the advantages of a product or technology.

Knowles, Michael. Writing World (2001). Articles>Writing>Technical Writing

How to Write Copyright Pages  

A well-designed user guide contains a copyright page, which provides copyright information for your company's products as well as for any third-party products mentioned in your document.

Amott, Lyndsey. Docsymmetry (2004). Articles>Intellectual Property>Copyright>Technical Writing

How to Write Instructions

These guidelines are written primarily for people who are not technical writers. If you are new to technical writing, you will probably find these instructions useful.

Unwalla, Mike. TechScribe (2003). Articles>Documentation>Writing>Technical Writing

How to Write Really Good Documentation

Write a really bad manual and you’ll not only lose users, you’ll create ex-users who go out of their way to tell others how bad your application is. Documentation matters.

Forte, Brian. Red Hat Magazine (2007). Articles>Documentation>Writing>Technical Writing

How to Write Really Good Documentation: Donald Knuth Was Wrong

In the continuing absence of maturity in the software world, it’s the documentation that has to treat the tool-user with respect. Which is a further argument against Knuth’s Literate Programming. Since it’s all too common to see software toolmakers treat tool-users with short shrift, it’s a useful caution to have the ’software is written in one corner and documented in another’.

Forte, Brian. Red Hat Magazine (2007). Articles>Documentation>Writing>Technical Writing

How to Write Really Good Documentation: Four Rules and an Axiom

Keeping to the four rules articulated here—and never forgetting the axiom—will definitely improve your documentation. If nothing else, recognizing and observing these rules will raise the status of documentation and the people producing it. And they’ll use that raised status in at least two ways.

Forte, Brian. Red Hat Magazine (2007). Articles>Documentation>Writing>Technical Writing

How We Write: Putting the "Technical" in "Technical Writer"  

By becoming more technical, you can interact more efficiently with software developers and qualify for a greater variety of software documentation projects. This paper outlines ways to learn more about three prevalent technologies: programming languages, databases, and Web server technologies.

Owens, David. STC Proceedings (2004). Articles>Writing>Technical Writing

Hypertext as a Productivity Tool for Technical Writing  

Hypertext is a novel approach to computer-based information management based on associative indexing. The concept in general and the characteristics of typical systems are briefly reviewed. Strategies for applying hypertext techniques to the process of writing a technical document are examined. The way in which hypertext documents are used is discussed, focusing on a commonly encountered problem -- user disorientation within the document. Hypertext-based technical documents are compared and contrasted against their paper-based antecedents.

Lenarcic, John. STC Proceedings (1993). Articles>Information Design>Hypertext>Technical Writing

IBM User-Centered Design for the Documentation Designer  

The user-centered design of documentation is an aspect of product design that has often been under-emphasized. Difficulties inherent in documentation design include obtaining user, feedback to high-level design objectives; extracting user. feedback specific to a product’s documentation. rather than to the product as a whole; and managing the various resource constraints inherent in product development. IBM User-Centered Design offers a solution to these difficulties by employing a set of user feedback methodologies from which the documentation designer, a member of a multidisciplinary design team, extracts pertinent data to set design objectives and follow through to low-level designs.

Righi, Carol and Lynn VanDyke. STC Proceedings (1996). Articles>User Centered Design>Documentation>Technical Writing

Illustration and Language in Technical Communication    

Many technical documents present information both graphically and verbally. While much is known about the verbal tools of technical professionals, technical graphics have been less fully examined. Here the drawings of a United States patent are examined revealing a system for organizing and presenting visual information that is analogous to commonly-used models for organizing and presenting verbal information.

Donnell, Jeffrey. Journal of Technical Writing and Communication (2005). Articles>TC>Technical Writing>Technical Illustration

The Impact of Student Learning Outcomes Assessment on Technical and Professional Communication Programs    

Because of accreditation, budget, and accountability pressures at the institutional and program levels, technical and professional communication faculty are more than ever involved in assessment-based activities. Using assessment to identify a program's strengths and weaknesses allows faculty to work toward continuous improvement based on their articulation of learning and behavioral goals and outcomes for their graduates. This article describes the processes of program assessment based on pedagogical goals, pointing out options and opportunities that will lead to a meaningful and manageable experience for technical communication faculty, and concludes with a view of how the larger academic body of technical communication programs can benefit from such work. As ATTW members take a careful look at the state of the profession from the academic perspective, we can use assessment to further direct our programs to meet professional expectations and, far more importantly, to help us meet the needs of the well-educated technical communicator.

Allen, Jo. Technical Communication Quarterly (2004). Articles>Education>Assessment>Technical Writing

The Implications for Technical Writers of the Movement Toward Open Systems  

The movement toward open systems is gaining momentum. Those technical writers in the computer and software industries who have been accustomed to working in the world of proprietary systems will have to adjust to working in this new world of open systems. This paper briefly describes the open systems movement and then discusses in detail the implications of that movement for technical writers. This includes the challenges they will face and the skills they will need to develop. A brief case study of the involvement of technical writers in the Open Software Foundation’s DCE project is included.

Abbott, John J. STC Proceedings (1993). Articles>Knowledge Management>Open Source>Technical Writing

Implicature, Pragmatics, and Documentation: A Comparative Study    

This study investigates the link between the linguistic principles of implicature and pragmatics and software documentation. When implicatures are created in conversation or text, the listener or reader is required to fill in missing information not overtly stated. This information is usually filled in on the basis of previous knowledge or context. Pragmatics, the study of language use in context, is concerned with the situational aspects of language use that, among other things, directly affect implicatures required of the reader. I investigate how two manuals for the same software product can be analyzed on the basis of implicature and pragmatics. One is an original copy of the documentation that came with the product, the other an after-market manual. Results show that the aftermarket manual requires far fewer implicatures of the reader and does a better job of providing pragmatically helpful information for the user.

Wright, David. Journal of Technical Writing and Communication (2007). Articles>Documentation>Rhetoric>Technical Writing