Technical writer
A technical writer is a professional communicator whose task is to convey complex information in simple terms to an audience of the general public or a very select group of readers. Technical writers research and create information through a variety of delivery media. In most organizations, a technical writer serves as a trained expert in technical writing and not as an expert in their field of employment. This, of course, does not mean technical writers aren't expected to have, at the very least, a basic understanding of their subject matter. Technical writers generally acquire necessary industry terminology and field or product knowledge on the job, through working with Subject-Matter Experts and their own internal document research.
In larger organizations, a technical writer often works as a member of a technical writing team, but may also work independently at smaller organizations and in select roles where workloads are focused. Examples of popular technical writing include online help, manuals, white papers, design specifications, project plans, and software test plans. With the rise of e-learning, technical writers are increasingly hired to develop online training material to assist users.
According to the Society for Technical Communication : In other words, technical writers take advanced technical concepts and communicate them as clearly, accurately, and comprehensively as possible to their intended audience, ensuring that the work is accessible to its users.
Kurt Vonnegut described technical writers as:
Engineers, scientists, and other professionals may also be involved in technical writing, but are more likely to employ professional technical writers to develop, edit and format material, and follow established review procedures as a means delivering information to their audiences.
History
According to the Society for Technical Communication, the professions of technical communication and technical writing were first referenced around World War I, when technical documents became a necessity for military purposes. The job title emerged in the US during World War II, Although it was not until 1951 that the first "Help Wanted: Technical Writer" ad was published. In fact, the title "Technical Writer" was not added to the US Bureau of Labor Statistic's Occupational Employment Handbook until 2010. During the 1940s and 50s, technical communicators and writers were hired to produce documentation for the military, often including detailed instructions on new weaponry. Other technical communicators and writers were involved in developing documentation for new technologies that were developed around this time. According to O'Hara:Since the early days of the profession, technical writers have worked in teams with a pool of other technical writers. To this day, most organizations still employ a team to produce and edit technical writing for an assigned product or service. As a member of a team, technical writers work independently to research their assignments. Regular one-on-one meetings with Subject Matter Experts and internal research references provide the technical writer with the necessary checks to ensure a document's accuracy. Once the accuracy of a document has been reviewed and approved by the assigned SME, technical writers rely on their writing team to provide peer reviews. The peer review focuses exclusively on content format, style, and grammar standardization. The goal of the team's peer reviews are to ensure an organization's technical writing "speaks with one voice".
During World War II, one of the most important characteristics for technical writers was their ability to follow stringent government specifications for documents. After the war, the rise of new technology, such as the computer, allowed technical writers to work in other areas, producing "user manuals, quick reference guides, hardware installation manuals, and cheat sheets." After the war, technical communicators became interested in "professionalizing" their field. According to Malone, technical communicators/writers did so by creating professional organizations, cultivating a "specialized body of knowledge" for the profession, imposing ethical standards on technical communicators, initiating a conversation about certifying practitioners in the field, and working to accredit education programs in the field.
The profession has continued to grow—according to O'Hara, the writing/editing profession, including technical writers, experienced a 22% increase in positions between the years 1994 and 2005. Modern-day technical writers work in a variety of contexts. Many technical writers work remotely using VPN or communicate with their team via videotelephony platforms such as Skype or Zoom. Other technical writers work in an office, but share content with their team through complex content management systems that store documents online. Technical writers may work on government reports, internal documentation, instructions for technical equipment, embedded help within software or systems, or other technical documents. As technology continues to advance, the array of possibilities for technical writers will continue to expand. Many technical writers are responsible for creating technical documentation for mobile applications or help documentation built within mobile or web applications. They may be responsible for creating content that will only be viewed on a hand-held device; much of their work will never be published in a printed booklet like technical documentation of the past.
Technical Writers and UX Design
Historically, technical writers, or technical and professional communicators, have been concerned with writing and communication. However, recently user experience design has become more prominent in technical and professional communications as companies look to develop content for a wide range of audiences and experiences.The User Experience Professionals Association defines UX as “Every aspect of the user’s interaction with a product, service, or company that make up the user’s perception of the whole.” Therefore, “user experience design as a discipline is concerned with all the elements that together make up that interface, including layout, visual design, text, brand, sound, and interaction."
It is now an expectation that technical communication skills should be coupled with UX design. As Verhulsdonck, Howard, and Tham state “...it is not enough to write good content. According to industry expectations, next to writing good content, it is now also crucial to design good experiences around that content." Technical communicators must now consider different platforms such as social media and apps, as well as different channels like web and mobile.
As Redish explains, a technical communications professional no longer writes content but “writes around the interface” itself as user experience surrounding content is developed. This includes usable content customized to specific user needs, that addresses user emotions, feelings, and thoughts across different channels in a UX ecology.
Lauer and Brumberger further assert, “…UX is a natural extension of the work that technical communicators already do, especially in the modern technological context of responsive design, in which content is deployed across a wide range of interfaces and environments."
UX design is a product of both technical communication and the user identity. Effective UX design is configured to maximize usability according to unique user backgrounds, in a process called design ethnography. Design ethnography closely analyzes user culture through interviews and usability tests, in which the technical writer directly immerses themself in the user environment and gathers UX information from local users.
Skill set
Technical writers must have a solid understanding of popular style guides, language, writing, research and revisioning. Additional skills often include:- Business analysis
- CAD wireframe rendering
- Computer scripting
- Content management
- Content design
- Illustration/graphic design
- Indexing
- Information architecture
- Information design
- Localization/technical translation
- Teamwork
- Training
- E-learning
- User interfaces
- Video editing
- Website design/management
- Hypertext Markup Language
- Usability testing
- Problem solving
- User experience design
Characteristics
Proficient technical writers have the ability to create, assimilate, and convey technical material in a concise and effective manner. They may specialize in a particular area but must have a good understanding of the products they describe. For example, API writers primarily work on API documents, while other technical writers specialize in electronic commerce, manufacturing, scientific, or medical material.Technical writers gather information from many sources. Their information sources are usually scattered throughout an organization, which can range from developers to marketing departments.
According to Markel, useful technical documents are measured by eight characteristics: "honesty, clarity, accuracy, comprehensiveness, accessibility, conciseness, professional appearance, and correctness." Technical writers are focused on using their careful research to create effective documents that meet these eight characteristics.