Lesson 1: Introduction to Becoming a Technical Writer
This lesson describes the field of technical writing and delves into some of the job tasks of such writing. Along the way we take a look at some of the skills needed to for success in the field and the reasons why you may wish to enter this writing occupation.
What is Technical Writing, Anyway?
A technical writer is someone who communicates information about a technical subject, directed at a specific audience for a specific purpose. The challenge for a good technical writer is to convey the information clearly, succinctly and in language that is understandable yet is suited to the requirements of the audience.
That audience can be anyone from an engineer working on cutting-edge software application to a novice computer user trying to find out how to set up a new computer.
Though the computer field employs many technical writers, fields as diverse as telecommunications, semiconductors, science, medicine, government, the military and manufacturing also need technical communicators.
It may help you to understand what technical writers do if we break the field down into three categories:
End-User Documentation is writing about technology for mostly non-technical audiences. Much of this writing concerns how to use a consumer product. Examples of this type of writing include:
- Hardware and software user manuals,
- Windows Help files
- Quick-start cards and quick reference guides
- Administrator guides
- scientific or technical articles intended for a lay or semi-technical audience
While the tech writer must master the product or process, you only need to have as much technical background as a typical reader will possess. However, you must understand the needs of your audience and be able to write clearly, use publishing software, work with technical people, and of course, it helps to be a fast learner.
Essentially, this job requires you to learn something and then teach it to others through a printed document or displayed on the Web or both. More and more of this kind of writing is now being published on the worldwide Web or sometimes on company intranets.
Traditional Technical Writing is writing for a technical audience. Examples of this type of writing include
- Repair and maintenance manuals
- Scientific papers and reports
- Software tool kit (programmer) manuals,
- Technical specifications, white papers, etc.
Technological Marketing Communication(also known as Marcom) includes writing to provide customers with information about the company and their products and/or services. The purpose of this type of writing is to make the public aware of what is available and to help to sell the products. "Marcom" includes:
- Promotional brochures and flyers
- Press releases and promotional articles
- Specification sheets and reports
- Advertisements, catalogs, and other pre-sale literature
While print was the medium of choice in the past, more and more material and catalogs are now distributed by CD-ROM or on the Internet. Most companies now have a web site.
While much marketing material is still produced by marketing specialists and advertising copywriters, much online documentation and Web material are now being written by technical communicators. In general, for this type of writing, you need only have as much technical background as the audience you are writing for. A background in sales or advertising is sometimes helpful in finding employment but is not considered essential.
In addition to high-tech companies, banks and financial services, insurance companies, and other large businesses utilize technical communicators to prepare hardware and software manuals, online help and instructions (e.g., technical scripts) for employees.
Recommended ReadingThe Complete Idiot's Guide To Technical Writing, Foreword and pages 1-5
