Qualifications and Methodology - Technical Writer

Started by sukishan, Aug 13, 2009, 02:32 PM

Previous topic - Next topic

sukishan

Qualifications
Technical writers work under many job titles, including Technical Communicator, Information Developer, Data Development Engineer, and Technical Documentation Specialist. In the United Kingdom and some other countries, a technical writer is often called a technical author or knowledge author.

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 particular area. For example, API writers mostly work on API documents, while other technical writers specialize in e-commerce, manufacturing, scientific, or medical material.

Methodology
To create a technical 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 many 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. The Microsoft Manual of Style for Technical Publications typifies these.

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 writer gathers information by studying existing material & interviewing subject matter experts.
A good beginning makes a good ending