|
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. Sometimes, a field engineer may need to be a technical writer, as well. In general terms, documentation is any communicable material (such as text, video, audio, etc. ...
Online Help is topic, 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 a government report outlining policy or authoritative report on a major issue. ...
Design specifications are the measurements and characteristics of a structure or object which provide for a workable, sustainable, or pleasing creation or construct. ...
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 many technical writers work in the computer/information technology area. Technical writing, a subset of technical communication, is used in fields as diverse as computer hardware and software, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology. ...
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 easy for the intended readership to understand. Some technical writers also communicate in other modes (e.g., writing scripts for industrial film or video).
Qualifications Technical writers normally possess a mix of technical and language abilities, and have degrees or certifications in areas such as Computer Science, Electrical Engineering, Telecommunications, Technical Communcations, 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. Computer software (or simply software) refers to one or more computer programs and data held in the storage of a computer for some purpose. ...
API and Api redirect here. ...
It has been suggested that this article or section be merged with embedded microprocessor. ...
A user guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system. ...
E-mail, or email, is short for electronic mail and is a method of composing, sending, and receiving messages over electronic communication systems. ...
Technical writers are known in the United Kingdom and some other countries as technical authors or Knowledge Authors. Technical writers may also be known by other names such as Technical Communicators and Technical Documentation Specialists. 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". Information design has been defined as the art and science of preparing information so that it can be used by human beings with efficiency and effectiveness (Jacobson 2000). ...
Authorship redirects here. ...
Information architecture is the science of expressing a model or concept for information. ...
Methodology Before writing any document, it is essential that a technical writer gather 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). A Subject Matter Expert (SME) is a person expert in a particular area. ...
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 for Technical Publications and the Chicago Manual of Style are two well-known examples. The Microsoft Manual of Style for Technical Publications (MSTP) is a style guide published by Microsoft. ...
The Chicago Manual of Style (CMS) is a style guide for American English published by the University of Chicago (from which it receives its name). ...
Instructional or how-to documents are written in the present tense using the second person. Use of the passive voice is avoided by Technical writers.
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). A Subject Matter Expert (SME) is a person expert in a particular area. ...
See also Collaborative editing is the practice of groups producing works together through individual contributions. ...
Software Documentation or Source Code Documentation is written text that accompanies computer software. ...
Technical communication is the process of conveying usable information about a specific domain to an intended audience. ...
This article contains information that has not been verified and thus might not be reliable. ...
Technical writing, a subset of technical communication, is used in fields as diverse as computer hardware and software, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology. ...
External links |
Feeds |
Contact