Monday, December 15, 2008

Technical Writer

A technical writer is a professional writer who designs, writes, creates, maintains, and updates technical documentation—including online help, user guides, white papers, design specifications, system manuals, and other documents. Engineers, scientists, and other professionals may also produce technical writing, sometimes handing their work to a professional technical writer for editing and formatting. A technical writer's primary responsibility is to produce technical documentation for technical, business, and consumer audiences.

When creating a document, a technical writer gathers information by studying existing material and interviewing subject matter experts (SMEs). The technical writer also studies the audience to learn their needs and technical level.

Well-formed technical documents follow common publishing guidelines. Technical documentation comes in all styles and formats, depending on the medium. Printed documentation has different standards from online documentation. Usually, technical writers follow formatting conventions described in a standard style guide. In the US, most technical writers use the Chicago Manual of Style (CMS). Many companies have their own corporate style guides, typically extensions of the CMS to cover specific corporate issues. One of these, the Microsoft Manual of Style for Technical Publications is even used by some other companies.

Engineering projects, particularly defense or aerospace related projects often follow national and international documentation standards—such as ATA100 for civil aircraft, or S1000D for defense platforms.

Technical writers normally possess a mix of technical and language abilities. They may have a degree or certification in technical communications. Many technical writers switch from another technical field such as engineering or science, often after taking classes in technical communications.

A good technical writer has the ability to create, assimilate and convey technical material in a concise and effective manner. A technical writer may specialize in a technical area in which they have acquired expertise. For example, some API writers mostly work on API documents, while others specialize in medical or environmental material.

1 comment:

Unknown said...

Hi there! this is such an informative post. Thank you for sharing. Cheers!

- The technical writer jobsens