Citizendia
Your Ad Here

A Technical writer is a professional writer who designs, creates, maintains, and updates technical documentation—including online help, user guides, white papers, design specifications, and other documents. Documentation may refer to the process of providing evidence ("to document something" or to the communicable material used to provide such documentation (i Online help is topic-oriented procedural or reference information delivered through Computer software. A user guide, also commonly known as a manual, is a Technical communication Document intended to give assistance to people using a particular system A white paper is an authoritative report or guide that often addresses problems and how to solve them Design specifications are the measurements and characteristics of a structure or object which provide for a workable sustainable or pleasing creation or construct Engineers, scientists, and other professionals may also produce technical writing, often handing their work to a professional technical writer for editing and formatting.

The work of technical writers includes any technical subject requiring explanation to a particular audience. A technical writer usually is not a subject matter expert (SME). Companies, governments and other institutions hire technical writers not for their expertise in a particular subject, but for their expertise in gathering information, analyzing the subject and the audience, and producing clear documentation. (See technical writing. Technical writing, a form of Technical communication, is a style of formal writing used in fields as diverse as Computer Hardware and Software )

The technical writer's primary responsibility is to gather information and produce documentation tailored to a particular audience. A good technical writer creates documentation that is accurate, complete, unambiguous and as concise as possible. Technical writers communicate in many ways: printed documentation, Web-based or other electronic documentation, training materials, and industrial film scripts.

Contents

Qualification

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 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 writers mostly work on API documents, while others only work on medical or environmental material.

Technical writers work under many job titles, such as Technical Communicator or Technical Documentation Specialists. In the United Kingdom and some other countries, a technical writer is often called a technical author or knowledge author. The United Kingdom of Great Britain and Northern Ireland, commonly known as the United Kingdom, the UK or Britain,is a Sovereign state located

Methodology

When writing a document, a technical writer gathers information by studying existing material and interviewing subject matter experts (SMEs). A Subject Matter Expert (SME is a person who is an expert in a particular area 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 than 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). The Chicago Manual of Style (abbreviated in writing as CMS or CMOS or verbally as Chicago) is a Style guide for American English 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. The Microsoft Manual of Style for Technical Publications ( MSTP) is a Style guide published by Microsoft.

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

Environment

Technical writers often work as part of a writing team. In most cases, after the writer finishes a draft of the documentation, one or more SMEs review it for accuracy and completeness. This is sometimes referred to as 'peer review' or 'verification'. In some cases the writer or others test the document on audience members.

See also

External links

© 2009 citizendia.org; parts available under the terms of GNU Free Documentation License, from http://en.wikipedia.org
 Dapyx Software network: MP3 Explorer | Ebook Manager | Zenithic