TECHNICAL WRITING
Technical writing is a form of technical communication. It is a style of writing used in fields as diverse as computer hardware and software, engineering, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology. Technical writer writes communications done on the job, especially in fields with specialized vocabularies, such as science, engineering, technology, and the health sciences. The Society for Technical Communication (STC) defines technical writing as a broad field that includes any form of communication that exhibits one or more of the following characteristics: (1) communicating about technical or specialized topics, such as computer applications, medical procedures, or environmental regulations; (2) communicating by using technology, such as web pages, help files, or social media sites; or (3) providing instructions about how to do something, regardless of how technical the task is, and regardless of whether technology is used to create or distribute that communication. "The goal of technical writing is to enable readers to use a technology or understand a process or concept. Because the subject matter is more important than the writer's voice, technical writing style uses an objective, not a subjective, tone. The writing style is direct and utilitarian, emphasizing exactness and clarity rather than elegance or allusiveness. A technical writer uses figurative language only when a figure of speech would facilitate understanding1." Technical writing is accomplished by technical writers, who may be professionals or amateurs. Such writers ideally begin by forming a clear understanding of the purpose of the document that they will create. Technical writers then typically gather information from existing documentation and from subject matter experts (SME). An SME is any expert on the topic that the writer is working on. Technical writers are often not SMEs themselves (unless they are writing about creating good technical documentation). Workers at many levels, and in many different fields, have a role in producing technical communications. A good technical writer needs strong language and teaching skills and must understand the many conventions of modern technical communications. Advanced technical writers often move into specialized areas such as Advance Programming Interface writing for software programming, document architecture, or information management.
Here are the main characteristics of technical writing2: • Purpose: Getting something done within an organization (completing a project, persuading a customer, pleasing your boss, etc.) • Your knowledge of topic: Usually greater than that of the reader. • Audience: Often several people, with differing technical backgrounds. • Criteria for Evaluation: Clear and simple organization of ideas, in a format that meets the needs of busy readers. • Statistical and graphic support: Frequently used to explain existing conditions and to present alternative courses of action. Other characteristics include the following: • Source: Is there existing documentation—a rough draft? Who is the subject matter expert (SME)? • Deliverable: Is the deliverable simple text for inclusion in a book, or formatted to final form? Is the target a paper, a web page, or something else? The three C's of good technical writing are: • Clear • Concise • Complete Clear, concise, and complete writing helps the reader to grasp the meaning quickly. Communicating With The Audience Audience analysis is a key feature of all technical writing. Technical writing is a communication to convey a particular piece of information to a particular audience for a particular purpose. It is often an exposition about scientific subjects and technical subjects associated with finance, construction, medicine, agriculture, technology, and various sciences. Procedural technical writing translates complex technical concepts and instructions into a series of simple steps that enable users to perform a specific task in a specific way. To present appropriate information, writers must understand the audience and their goals. Persuasive technical writing attempts to sell products or change behaviors by putting forth compelling descriptions of how a product or service can be used in one's life. This type of
writing often delves into features and benefits of the product or service, and may use illustrations to make the benefits easier for the audience to understand. Technical Writing Is Presentational Technical writing involves attractive layout for easy reading and comprehension. Presentational strategies help readers to grasp messages quickly. • The top‐down strategy (tell them what you will say, then say it) • Headings (like headlines in newspapers) • Chunks (short paragraphs) • Plain, objective style so that readers can easily grasp details. It is also important to understand the medium typically used to view the final product. An HTML document (web page), viewed through a browser, has presentational possibilities that are different from those of the printed page, notably hyperlinks and animation, which can enhance the readers' experience. Types Of Technical Documents Technical writers use computers and other electronic communications equipment extensively in performing their work. They also work regularly with publishing software and various authoring environments to prepare material directly for the Internet. Technical writers frequently work with word processing, graphic design, page layout, and multimedia software. The nature of technical writing is evolving, and modern technical writers combine text, graphics, images, and sound into their work. Broadly speaking, technical documentation can be categorized into three types, depending on the style of writing, the level of knowledge transferred, and the target audience: 1. End‐user assistance. These information products help a user understand how to use a technical software or hardware product. User manuals for computer software, hardware, household products, medical equipment, cell phones, smartphones, and other consumer electronics belong to this category. 2. Traditional technical documentation. Here the writer's objective is to communicate to a specific audience. Maintenance guides, appliance or application repair manuals, engineering specifications, research papers, reference works, annual reports. and articles written for technical journals (to name a few examples) belong in this category.
3. Marketing communication. Product catalogs, brochures, advertisements, introductory pages for web sites, press releases, and advertising copy belong in this category. Technical writing is often associated with online help and user manuals. They also create product release notes, product troubleshooting guides, product user guides, tutorials (textual and multimedia), installation guides, API programmers' guides, marketing documentation, E‐ learning modules, web content, legal disclaimers, policies and procedures, business proposals, and white papers, among others. Technical Drawing is also considered a form of technical communication. References: 1. Gerald J. Alred, et al., Handbook of Technical Writing. Bedford/St. Martin's, 2006 2. William Sanborn Pfeiffer, Technical Writing: A Practical Approach. Prentice Hall, 2003 Source: • www.wikipedia.com ‐ http://en.wikipedia.org/wiki/Technical_writing • About.com ‐ http://grammar.about.com/od/tz/g/technicalwritingterm.htm