Technical writer

From Wikipedia, the free encyclopedia

Technical writers are professional writers who design, create, maintain and update many types of technical documentation, online help, user guides, white papers, design specifications, and other documents.

Their given field can be almost anything that requires specialized knowledge and information. (See technical writing.) Examples include the mechanical, electrical, or medical fields, but most technical writers work in the computer/information technology area.

A technical writer's primary responsibility is to effectively communicate a technical message. Technical writers are responsible for creating documentation that is accurate and complete, but as concise as possible, and as easy for the intended readership to understand. Some technical writers also communicate in other modes (e.g., writing scripts for industrial film or video).

1 Qualifications
2 Methodology
3 Environment
4 Associations
5 See also
6 External links

[edit] Qualifications

Technical writers normally possess a mix of technical and language abilities, and have degrees or certifications in areas such as Computer Science, Telecommunications, Journalism, Communications, English (or the applicable language), and Management. The writer should have enough expertise to understand the document's intended readers.

A good technical writer has the ability to assimilate and convey technical material in a concise, effective manner. It is more difficult to find technical writers with command of technical areas, so those writers are generally in higher demand. For example, writers who develop documentation for development software APIs, microcontroller operations, and other technical subjects often have better prospects than those who write user guides for a less technical audience (for example, "How to use email"). Writers with experience in multiple technical areas have an even greater advantage.

Technical writers are known in the United Kingdom and some other countries as technical authors. Technical writers may also be known by other names, and it is not uncommon for people in related fields to "double up" as technical writers, as technical writing is often a considerable part of their job -- e.g., "information designer", "information developer", and "information architect".

[edit] Methodology

Before writing any document, it is essential that a technical writer gathers as much information as possible on the topic and also the purpose of the document or assignment and the intended audience. Sometimes, previously written documents will provide information that the technical writer can use to frame the given work. A technical writer should be adept at tackling topics that are unfamiliar and analyzing the information in order to create a coherent document.

Technical writers work closely with technicians, engineers, developers, managers, and, occasionally, customers to ensure that the delivered product meets all requirements. Technical writers work the closest with Subject Matter Experts (SMEs).

Well-formed technical documents follow common publishing guidelines. Technical documentation comes in all styles and formats, depending on the medium used to convey the information. Printed documentation has different standards than online documentation. Usually, technical writers follow the formatting conventions described in a standard style guide; the Microsoft Manual of Style and the Chicago Manual of Style are two well-known examples.

Instructional or how-to documents are written in the present tense using the second person. Technical writers avoid using the passive voice.

[edit] Environment

Technical writers often work as part of a writing team. In most cases, after the documentation is written, it's reviewed for content accuracy and completeness by one or more "Subject Matter Experts" (SMEs), at a minimum. Others, such as users or managers, may review it to ensure it suffices from a more practical or high-level perspective (such as review of administrative errors and organizational problems). Finally, it should be edited for spelling and reviewed for correct and proper grammar and usage (generally by a native speaker of the language of the document).