Introduction

Technical writing courses introduce you to some of the most important aspects of writing in the worlds of science, technology, and business—in other words, the kind of writing that scientists, medical professionals, computer specialists, government officials, engineers, and other professionals do as a part of their jobs.

To learn how to write effectively for the professional world, you will study common types of reports, special format items such as lists and headings, simple techniques for creating and using graphics in reports, and some techniques for producing professional-looking final copy.

Technical writing courses build on what you have learned in other writing courses but differ significantly from strictly academic writing and research projects you might have completed in those courses. If you currently have a job in which you do some writing, you will discover that you can put what you learn in your technical writing course to immediate use.

ABOUT TECHNICAL WRITING

You’re probably wondering what this “technical writing thing” is. Someone may even have told you, “it’s this course where they make you write about rocket science and brain surgery.” Actually, technical communication is essential in a wide range of occupations. It is also a fully professional field with degree programs, certifications, and even theory. The field has a lot of growth and income potential, and an introductory technical-writing course is a good way to start if you are interested in a career in this field. However, the basic technical writing skills you develop in this course will be useful in any profession that requires clear, concise communication.

WORKPLACE WRITING

The focus of this introductory technical writing course is not necessarily directed toward a career as a technical writer. No matter what sort of professional work you do, you are likely to do some writing—and much of it may be technical in nature. Mastering the basic technical writing skills covered in this course will enable you to do a better job of writing. And that will be good for the projects you work on, for the organizations you work in, and—most of all—good for you and your career.

THE MEANING OF TECHNICAL

Technical communication—or technical writing, as the course is often called—is not writing about a specific technical topic such as computers, but about any technical topic. The term “technical” refers to knowledge that is not widespread, that is more the territory of experts and specialists. Whatever your major is, you are developing an expertise—you are becoming a specialist in a particular area. And whenever you write or otherwise communicate information related to your field, you are engaged in technical communication.

IMPORTANCE OF AUDIENCE

A key factor in good technical communication is the receiver of the information—the audience. Technical communication is the delivery of technical information to readers (or listeners or viewers) in a manner that is adapted to their needs, level of understanding, and background. In fact, this audience element is so important that it is one of the cornerstones of this course: you are challenged to write about technical subjects in a way that a beginner—a non-specialist—can understand. This ability to “translate” technical information to non-specialists is a key skill for any technical communicator. In a world of rapid technological development, many people struggle to keep up with the latest developments in their fields of employment or interest. Technology companies are constantly struggling to find effective ways to help customers or potential customers understand the advantages or the operation of their new products.

So, relax. You don’t have to write about computers or rocket science—write about the area of technical specialization you know or are learning about. And plan to write about it in a way that even a non-specialist can understand.

REALLY TECHNICAL WRITING

Professional technical writers do in fact write about very technical stuff, and often they work with a team to produce the required documents. Technical writers rely on these strategies to ensure the accuracy of their work:

  • Study of books, articles, reports, websites related to the product
  • Review of product specifications: what the product is supposed to do, how it is designed
  • Interviews with subject matter experts: the product specialists, developers, engineers
  • Meetings with product development teams during the development cycle
  • Live demonstrations of the product
  • Familiarization with similar, competing products
  • Experiments with working models of the product
  • Review and editing of documents by subject matter experts

Of course, experienced technical writers will tell you that product development moves so fast that specifications are not always possible and that working models of the product are rarely available. That’s why document reviews by subject matter experts is often important.

TECHNICAL WRITING VS. ACADEMIC WRITING

You have probably taken at least one academic writing course and may be familiar with the academic practices of writing for college classes. Technical writing differs from academic writing in both audience and function. The purpose of technical writing is to provide particular information to a defined audience on a specific topic in the clearest and most concise manner possible. While you may have been required to reach certain word counts in some of your academic papers, good technical writing is clear and concise; wordiness is an obstruction to clarity.

In technical writing courses, the main focus is typically the technical report, due toward the end of the term. Just about everything you do in the course is aimed at developing skills needed to produce that report. You plan the technical report, then write a proposal in which you lay out your plan for writing that report and argue to your reader why the report is needed and why you are the right person to conduct the research and write the report. As the course progresses, you complete exercises and write short papers that allow you to get accustomed to using page design elements such as headings, lists, and graphics to effectively convey information about technical subject matter in a clear, concise manner that is appropriate for a specific audience.