Technical writer
Encyclopedia
A technical writer is a professional writer
who designs, creates, and maintains technical documentation
. This documentation includes online help
, user guide
s, Instructions for Use or IFU manuals, white papers, design specification
s, system manuals, and other documents.
Engineers, scientists, and other professionals may also produce technical writing
, usually handing their work to a professional technical writer for proofreading, editing, and formatting. A technical writer produces technical documentation for technical, business, and consumer audiences.
Technical writing
may be on any subject that requires explanation to a particular audience. A technical writer is not usually a subject matter expert
(SME), but possesses and applies expertise to interview SMEs and conduct research necessary to produce accurate, comprehensive documents. Companies, governments, and other institutions typically hire technical writers not for expertise in a particular subject, but for expertise in technical writing
, i.e., their ability to gather information, analyze subject and audience and produce clear documentation.
A good technical writer creates documentation that is accurate, complete, unambiguous, and as concise as possible. Technical writers create documentation in many forms: printed, web-based or other electronic documentation, training materials, and industrial film scripts.
and some other countries, a technical writer is often called a technical author or knowledge author. In the United States, technical writers with programming skills are called programmer writers.
Technical writers normally possess a mixture of technical and language abilities. They may have a degree or certificate in technical communications. Many technical writers switch from another technical field such as engineering or science, often after learning the required skills through technical communications classes.
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 writer
s mostly work on API
documents, while other technical writers specialize in electronic commerce
, manufacturing, scientific, or medical
material.
A technical publications development life cycle consists of five distinct phases, which are coordinated with the overall product development plan:
Well-formed technical documents follow common publishing guidelines. Technical documentation comes in many styles and formats, depending on the medium. Printed and online documentation differ in necessary ways but adhere to largely identical guidelines for prose, information structure, and layout. Usually, technical writers follow formatting conventions described in a standard style guide
. In the US, technical writers typically use the Chicago Manual of Style
(CMS). Many companies have internal corporate style guides that cover specific corporate issues such as logo use, branding, and other aspects of corporate style. The Microsoft Manual of Style for Technical Publications
is typical of 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.
On a project team, a technical writer develops the product documentation as other members of the team develop the product. For example, as engineers design and integrate a product, the technical writer generates manuals that go with the product. These manuals serve as a repository of user-oriented knowledge gained by the product development, testing, and technical support teams, including best practices for the use of the product.
Technical writers may also gain expertise in a particular technical domain and branch into related forms, such as software quality analysis or business analysis. A technical writer who becomes a subject matter expert in a field may transition from technical writing to work in that field.
Technical writers with expertise in writing skills can join printed media or electronic media, and would provide an opportunity to make handsome money and luxury of flexible working hours. A senior writer in some software documentation departments is sometimes called an individual contributor (IC). See also API writer
. In API/software documentation, ICs typically work with a team of developers or testers across many physical locations. In such software development in "software research organizations," an IC plays an important role in the delivery of API/Software documentation.
Professional writing
Professional writing involves the use of clear language to convey information in a way that is easily understood by the intended audience. Individuals who can use language well may be employed as full-time professional writers in a variety of communications-related occupations, such as journalist,...
who designs, creates, and maintains technical documentation
Documentation
Documentation is a term used in several different ways. Generally, documentation refers to the process of providing evidence.Modules of Documentation are Helpful...
. This documentation includes online help
Online help
Online help is topic-oriented, procedural or reference information delivered through computer software. It is a form of user assistance. Most online help is designed to give assistance in the use of a software application or operating system, but can also be used to present information on a broad...
, user guide
User guide
A user guide or user's guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system...
s, Instructions for Use or IFU manuals, white papers, design specification
Design specification
A design specification provides explicit information about the requirements for a product and how the product is to be put together. It is the most traditional kind of specification, having been used historically in public contracting for buildings, highways, and other public works, and represents...
s, system manuals, and other documents.
Engineers, scientists, and other professionals may also produce technical writing
Technical writing
Technical writing, a form of technical communication, is a style of writing used in fields as diverse as computer hardware and software, engineering, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology....
, usually handing their work to a professional technical writer for proofreading, editing, and formatting. A technical writer produces technical documentation for technical, business, and consumer audiences.
Skill set
In addition to solid research, language, and writing skills, a technical writer may have skills in:- Information designInformation designInformation design is the skill and practice of preparing information so people can use it with efficiency and effectiveness. Where the data is complex or unstructured, a visual representation can express its meaning more clearly to the viewer....
- Information architectureInformation ArchitectureInformation architecture is the art of expressing a model or concept of information used in activities that require explicit details of complex systems. Among these activities are library systems, Content Management Systems, web development, user interactions, database development, programming,...
- TrainingTrainingThe term training refers to the acquisition of knowledge, skills, and competencies as a result of the teaching of vocational or practical skills and knowledge that relate to specific useful competencies. It forms the core of apprenticeships and provides the backbone of content at institutes of...
material development - IllustrationIllustrationAn illustration is a displayed visualization form presented as a drawing, painting, photograph or other work of art that is created to elucidate or dictate sensual information by providing a visual representation graphically.- Early history :The earliest forms of illustration were prehistoric...
- TypographyTypographyTypography is the art and technique of arranging type in order to make language visible. The arrangement of type involves the selection of typefaces, point size, line length, leading , adjusting the spaces between groups of letters and adjusting the space between pairs of letters...
- Translation management
- Website design or management
- User InterfaceUser interfaceThe user interface, in the industrial design field of human–machine interaction, is the space where interaction between humans and machines occurs. The goal of interaction between a human and a machine at the user interface is effective operation and control of the machine, and feedback from the...
s
Technical writing
Technical writing
Technical writing, a form of technical communication, is a style of writing used in fields as diverse as computer hardware and software, engineering, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology....
may be on any subject that requires explanation to a particular audience. A technical writer is not usually a subject matter expert
Subject Matter Expert
A subject matter expert or domain expert is a person who is an expert in a particular area or topic. When spoken, sometimes the acronym "SME" is spelled out and other times voiced as a word ....
(SME), but possesses and applies expertise to interview SMEs and conduct research necessary to produce accurate, comprehensive documents. Companies, governments, and other institutions typically hire technical writers not for expertise in a particular subject, but for expertise in technical writing
Technical writing
Technical writing, a form of technical communication, is a style of writing used in fields as diverse as computer hardware and software, engineering, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology....
, i.e., their ability to gather information, analyze subject and audience and produce clear documentation.
A good technical writer creates documentation that is accurate, complete, unambiguous, and as concise as possible. Technical writers create documentation in many forms: printed, web-based or other electronic documentation, training materials, and industrial film scripts.
Qualifications
Technical writers work under many job titles, including Technical Communicator, Information Developer, Data Development Engineer, and Technical Documentation Specialist. In the United KingdomUnited Kingdom
The United Kingdom of Great Britain and Northern IrelandIn the United Kingdom and Dependencies, other languages have been officially recognised as legitimate autochthonous languages under the European Charter for Regional or Minority Languages...
and some other countries, a technical writer is often called a technical author or knowledge author. In the United States, technical writers with programming skills are called programmer writers.
Technical writers normally possess a mixture of technical and language abilities. They may have a degree or certificate in technical communications. Many technical writers switch from another technical field such as engineering or science, often after learning the required skills through technical communications classes.
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 writer
API Writer
An API writer is a technical writer who writes documents that describe an application programming interface . The primary audience includes programmers, developers, system architects, and system designers.- Overview :...
s mostly work on API
Application programming interface
An application programming interface is a source code based specification intended to be used as an interface by software components to communicate with each other...
documents, while other technical writers specialize in electronic commerce
Electronic commerce
Electronic commerce, commonly known as e-commerce, eCommerce or e-comm, refers to the buying and selling of products or services over electronic systems such as the Internet and other computer networks. However, the term may refer to more than just buying and selling products online...
, manufacturing, scientific, or medical
Medical writing
Medical writing is the activity of producing scientific documentation by a specialized writer. The medical writer typically is not one of the scientists or doctors who performed the research....
material.
Methodology
To create a technical document, a technical writer must understand the audience, the purpose, and the product. The writer gathers information by studying existing material, interviewing SMEs, and actually using the products to be documented. The technical writer also studies the audience to learn their needs and technical understanding level.A technical publications development life cycle consists of five distinct phases, which are coordinated with the overall product development plan:
- Phase 1: Information gathering and planning
- Phase 2: Content specification
- Phase 3: Content development and implementation
- Phase 4: Production
- Phase 5: Evaluation
Well-formed technical documents follow common publishing guidelines. Technical documentation comes in many styles and formats, depending on the medium. Printed and online documentation differ in necessary ways but adhere to largely identical guidelines for prose, information structure, and layout. Usually, technical writers follow formatting conventions described in a standard style guide
Style guide
A style guide or style manual is a set of standards for the writing and design of documents, either for general use or for a specific publication, organization or field...
. In the US, technical writers typically use the Chicago Manual of Style
The Chicago Manual of Style
The Chicago Manual of Style is a style guide for American English published since 1906 by the University of Chicago Press. Its 16 editions have prescribed writing and citation styles widely used in publishing...
(CMS). Many companies have internal corporate style guides that cover specific corporate issues such as logo use, branding, and other aspects of corporate style. The Microsoft Manual of Style for Technical Publications
Microsoft Manual of Style for Technical Publications
The Microsoft Manual of Style for Technical Publications is a style guide published by Microsoft. The Third Edition, ISBN 0-7356-1746-5, was published on November 12, 2003. The print version of this edition was published in June 2004. Microsoft employees and partners can also access a Microsoft...
is typical of 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.
Environment
Technical writers often work as part of a writing or project development team. Typically, the writer finishes a draft and passes it to one or more SMEs who conduct a technical review to verify accuracy and completeness. An editorial review is performed by another writer or technical editor who performs a copy edit that includes conformance to styles, grammar, readability, and requests for clarifications or other suggestions. In some cases the writer or others test the document on audience members in order to make usability improvements. A final production typically follows an inspection checklist to ensure the quality and uniformity of the published product.On a project team, a technical writer develops the product documentation as other members of the team develop the product. For example, as engineers design and integrate a product, the technical writer generates manuals that go with the product. These manuals serve as a repository of user-oriented knowledge gained by the product development, testing, and technical support teams, including best practices for the use of the product.
Career growth
A technical writer has no standard career path, but technical writers may move into project management over other writers. A writer may advance to a senior technical writer position, handling complex projects or a small team of writers and editors. In larger groups, a documentation manager might handle multiple projects and teams.Technical writers may also gain expertise in a particular technical domain and branch into related forms, such as software quality analysis or business analysis. A technical writer who becomes a subject matter expert in a field may transition from technical writing to work in that field.
Technical writers with expertise in writing skills can join printed media or electronic media, and would provide an opportunity to make handsome money and luxury of flexible working hours. A senior writer in some software documentation departments is sometimes called an individual contributor (IC). See also API writer
API Writer
An API writer is a technical writer who writes documents that describe an application programming interface . The primary audience includes programmers, developers, system architects, and system designers.- Overview :...
. In API/software documentation, ICs typically work with a team of developers or testers across many physical locations. In such software development in "software research organizations," an IC plays an important role in the delivery of API/Software documentation.
See also
- API writerAPI WriterAn API writer is a technical writer who writes documents that describe an application programming interface . The primary audience includes programmers, developers, system architects, and system designers.- Overview :...
- Collaborative editingCollaborative editingCollaborative editing is the practice of groups producing works together through individual contributions. Effective choices in group awareness, participation, and coordination are critical to successful collaborative writing outcomes. Most usually it is applied to textual documents or...
- Software documentationSoftware documentationSoftware documentation or source code documentation is written text that accompanies computer software. It either explains how it operates or how to use it, and may mean different things to people in different roles....
- Technical communicationTechnical communicationTechnical communication is a method of researching and creating information about technical processes or products directed to an audience through media. The information must be relevant to the intended audience. Technical communicators often work collaboratively to create products for various...
- Technical communication toolsTechnical communication toolsTechnical communicators use a variety of tools to create usable information. Often referred to as a "tool set", there is no defined list of tools that are used by all technical writers...
- Technical writingTechnical writingTechnical writing, a form of technical communication, is a style of writing used in fields as diverse as computer hardware and software, engineering, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology....