Technical writer

A technical writer is a professional information communicator whose task it is to transfer information (knowledge) between two or more parties, through any medium that best facilitates the transfer and comprehension of the information. Technical writers research and create information through a variety of delivery mediums (electronic, printed, audio-visual and even touch).[1] Example types of information include online help, manuals, white papers, design specifications, project plans, software test plans, etc. With the rise of e-learning, technical writers are increasingly becoming involved with creating online training material.

According to the Society for Technical Communication (STC):[2]

Technical writing is sometimes defined as simplifying the complex. Inherent in such a concise and deceptively simple definition is a whole range of skills and characteristics that address nearly every field of human endeavor at some level. A significant subset of the broader field of technical communication, technical writing involves communicating complex information to those who need it to accomplish some task or goal.

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:[3]

...trained to reveal almost nothing about themselves in their writing. This makes them freaks in the world of writers, since almost all of the other ink-stained wretches in that world reveal a lot about themselves to the reader.

Engineers, scientists, and other professionals may also be involved in technical writing (developmental editing, proofreading, etc), but are more likely to employ professional technical writers to develop, edit and format material, and advise the best means of information delivery to their audiences.

Similar titles

  • Technical Communicator[4]
  • Technical Author
  • Tech Writer
  • Technical Content Developer
  • Content Developer
  • Content Designer
  • Information Developer
  • Technical Information Developer
  • Information Architect
  • Information Engineer
  • Information Designer
  • Documentation Specialist
  • Document Management Specialist
  • Documentation Manager
  • Text Engineer

The History of the Profession

According to the Society for Technical Communication (STC), the professions of technical communication and technical writing were first referenced around World War II[5], when technical documents became a necessity for military purposes. The job title emerged in the US during World War II[6], although it wasn't until 1951 that the first "Help Wanted: Technical Writer" ad was published.[7] In fact, the title "Technical Writer" wasn't added to the US Bureau of Labor Statistic's Occupational Employment Handbook until 2010.[8] 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:[9]

War was the most important driver of scientific and technological advance. The U.S. Army Medical Corps battled malaria in the jungles of Panama, the Chemical Corps pushed chemical advances in explosives and poisonous gases (and defenses against them), the Manhattan District of the Corps of Engineers literally made quantum leaps in the understanding of physics, and the Air Corps pioneered aviation design.

In the beginning of the profession, most technical writers worked in an office environment with a team of other writers. Like technical writers today, they conducted primary research and met with subject matter experts to ensure that their information was accurate. During World War II, one of the most important characteristics for technical writers was their ability to follow stringent government specifications for documents.[10] After the war, the rise of new technology, such as the computer, allowed technical writers to work in other areas, producing[11] "user manuals, quick reference guides, hardware installation manuals, and cheat sheets." During the time period after the war (1953-1961), technical communicators (including technical writers) became interested in "professionalizing" their field[12]. According to Malone[13], 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. [14] Modern day technical writers work in a variety of contexts. Many technical writers work remotely using VPN or communicate with their team via online portals 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.

Skill set

In addition to solid research, copywriting, language, writing, and revision skills, a technical writer may have skills in:

A technical writer may apply their skills in the production of non-technical content, for example, writing high-level consumer information. Usually, a technical writer is not a subject matter expert (SME), but interviews SMEs and conducts the research necessary to write and compile technically accurate content. Technical writers complete both primary and secondary research to fully understand the topic.

Characteristics

A proficient technical writer has 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.[15] For example, API writers primarily work on API documents, while other technical writers specialize in electronic commerce, manufacturing, scientific, or medical material.[15]

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[16], good 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.

Roles and functions

To create effective technical documentation, the writer must analyze three elements that comprise the rhetorical situation of a particular project: audience, purpose, and context.[17] These are followed by document design, which determines what the reader sees.

Audience analysis

Technical writers strive to simplify complex concepts or processes to maximize reader comprehension. The final goal of a particular document is to help readers find what they need, understand what they find, and use what they understand appropriately.[18] To reach this goal, technical writers must understand how their audiences use and read documentation. An audience analysis at the outset of a document project helps define what an audience for a particular document requires.

When analyzing an audience the technical writer typically asks:[18]

  • Who is the intended audience?
  • What are their demographic characteristics?
  • What is the audience’s role?
  • How does the reader feel about the subject?
  • How does the reader feel about the sender?
  • What form does the reader expect?
  • What is the audience’s task?
  • What is the audience’s knowledge level?
  • What factors influence the situation?

Accurate audience analysis provides a set of guidelines that shape document content, design and presentation (online help system, interactive website, manual, etc.), and tone and knowledge level.

Purpose

A technical writer analyzes the purpose (or function) of a communication to understand what a document must accomplish. Determining if a communication aims to persuade readers to “think or act a certain way, enable them to perform a task, help them understand something, change their attitude,”[17] etc., guides the technical writer on how to format their communication, and the kind of communication they choose (online help system, white paper, proposal, etc.).

Context

Context is the physical and temporal circumstances in which readers use communication—for example: at their office desks, in a manufacturing plant, during the slow summer months, or in the middle of a company crisis.[17] Understanding the context of a situation tells the technical writer how readers use the communication. This knowledge significantly influences how the writer formats the communication. For example, if the document is a quick troubleshooting guide to the controls on a small watercraft, the writer may have the pages laminated to increase usable life.

Document design

Once the above information has been gathered, the document is designed for optimal readability and usability. According to one expert, technical writers use six design strategies to plan and create technical communication: arrangement, emphasis, clarity, conciseness, tone, and ethos.[17]

Arrangement: the order and organization of visual elements so that readers can see their structure—how they cohere in groups, how they differ from one another, how they create layers and hierarchies.[17] When considering arrangement technical writers look at how to use headings, lists, charts, and images to increase usability.
Emphasis: how a document displays important sections through prominence or intensity.[17] When considering emphasis technical writers look at how they can show readers important sections, warning, useful tips, etc. through the use of placement, bolding, colour, and type size.
Clarity: strategies that “help the receiver decode the message, to understand it quickly and completely, and, when necessary, to react without ambivalence.”[17] When considering clarity the technical writer strives to reduce visual noise, such as low contrast ratios, overly complex charts or graphs, and illegible font, all of which can hinder reader comprehension.
Conciseness: the "visual bulk and intricacy" of the design—for example, the number of headings and lists, lines and boxes, detail of drawings and data displays, size variations, ornateness, and text spacing.[17] Technical writers must consider all these design strategies to ensure the audience can easily use the documents.
Tone: the sound or feel of a document. Document type and audience dictates whether the communication should be formal and professional, or lighthearted and humorous. In addition to language choice, technical writers set the tone of technical communication through the use of spacing, images, typefaces, etc.
Ethos: the degree of credibility that visual language achieves in a document.[17] Technical writers strive to create professional and error-free documentation to establish credibility with the audience.

Qualifications

Technical writers can have various job titles, including technical communicator, information developer, technical content developer or 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 mixture of technical and writing abilities. They typically have a degree or certification in a technical field, but may have one in journalism, business, or other fields. Many technical writers switch from another field, such as journalism—or a technical field such as engineering or science, often after learning important additional skills through technical communications classes.

Methodology (document development life cycle)

To create a technical document, a technical writer must understand the subject, purpose, and audience. They gather information by studying existing material, interviewing SMEs, and often actually using the product. They study the audience to learn their needs and technical understanding level.

A technical publication's development life cycle typically consists of five phases, coordinated with the overall product development plan:[19]

  • Phase 1: Information gathering and planning
  • Phase 2: Content specification
  • Phase 3: Content development and implementation
  • Phase 4: Production
  • Phase 5: Evaluation

The document development life cycle typically consists of six phases (This changes organization to organization, how they are following).

  1. Audience profiling (identify target audience)
  2. User task analysis (analyse tasks and information based on target audience)
  3. Information architecture (design based on analysis, how to prepare document)
  4. Content development (develop/prepare the document)
  5. Technical and editorial reviews (review with higher level personnel—managers, etc.)
  6. Formatting and publishing (publish the document).

This is similar to the software development life cycle.

Well-written technical documents usually follow formal standards or guidelines. Technical documentation comes in many styles and formats, depending on the medium and subject area. Printed and online documentation may differ in various ways, but still 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 Associated Press Stylebook or 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 civil and 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. Another writer or editor may perform an editorial review that checks conformance to styles, grammar, and readability. This person may request for clarification or make suggestions. In some cases the writer or others test the document on audience members to make usability improvements. A final production typically follows an inspection checklist to ensure the quality and uniformity of the published product.[20]

Career growth

There is no single standard career path for technical writers, but they 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 commonly produce training for the technologies they document—including classroom guides and e-learning—and some transition to specialize as professional trainers and instructional designers.

Technical writers with expertise in writing skills can join printed media or electronic media companies, potentially providing an opportunity to make more money or improved working conditions.

The U.S Department of Labor expects technical writer employment to grow 11 percent from 2016 to 2026, slightly faster than the average for all occupations. They expect job opportunities, especially for applicants with technical skills, to be good. The BLS also noted that the expansion of "scientific and technical products" and the need for technical writers to work in "Web-based product support" will drive increasing demand. [21]

Notable technical writers

See also

References

  1. ↑ David Farbey, Technical writer career information at the official website of the Institute of Scientific and Technical Communicators. Retrieved February 28, 2013.
  2. ↑ L. Lin. (2017, November). What is technical writing? [Web log post]. Retrieved from http://www.stc-psc.org/what-is-technical-writing/
  3. ↑ Gary Blake and Robert W. Bly, The Elements of Technical Writing, pg. 3. New York: Macmillan Publishers, 1993. ISBN 0020130856
  4. ↑ Technical Writers Thriving in 2020, presentation at ITTT 2014 forum
  5. ↑ L. Lin. (2017, November). What is technical writing? [Web log post]. Retrieved from http://www.stc-psc.org/what-is-technical-writing/
  6. ↑ O'Hara, F.M. (2001). A brief history of technical communication. In STC’s 48th Annual Conference Proceedings (pp. 500–504.)Arlington, VA: Society for Technical Communication.
  7. ↑ History of technical writing. [Webpage].Retrieved from http://www.proedit.com/history-of-technical-writing/
  8. ↑ Malone, E. A. (2011). The first wave (1953–1961) of the professionalization movement in technical communication. Technical Communication, 58(4),285-306. Retrieved from https://www.stc.org/techcomm/
  9. ↑ O'Hara, F.M. (2001). A brief history of technical communication. In STC’s 48th Annual Conference Proceedings (pp. 500–504.)Arlington, VA: Society for Technical Communication.
  10. ↑ O'Hara, F.M. (2001). A brief history of technical communication. In STC’s 48th Annual Conference Proceedings (pp. 500–504.)Arlington, VA: Society for Technical Communication.
  11. ↑ O'Hara, F.M. (2001). A brief history of technical communication. In STC’s 48th Annual Conference Proceedings (pp. 500–504.)Arlington, VA: Society for Technical Communication.
  12. ↑ Malone, E. A. (2011). The first wave (1953–1961) of the professionalization movement in technical communication. Technical Communication, 58(4),285-306. Retrieved from https://www.stc.org/techcomm/
  13. ↑ Malone, E. A. (2011). The first wave (1953–1961) of the professionalization movement in technical communication. Technical Communication, 58(4),285-306. Retrieved from https://www.stc.org/techcomm/
  14. ↑ O'Hara, F.M. (2001). A brief history of technical communication. In STC’s 48th Annual Conference Proceedings (pp. 500–504.)Arlington, VA: Society for Technical Communication.
  15. 1 2 What Does a Technical Writer Do? Wisegeek, Copyright © 2003 - 2013. Retrieved 31 October 2013.
  16. ↑ Markel, M. (2015). Introduction to technical communication. In Technical Communication (pp. 7-9). Boston: Bedford/St. Martin's
  17. 1 2 3 4 5 6 7 8 9 Kostelnick, Charles (2011). Designing Visual Language. New York, NY: Longman. pp. 3–390. ISBN 978-0-205-61640-4.
  18. 1 2 Riordan, Daniel (2005). Technical Report Writing Today. Boston, MA: Wadsworth Cengage Learning. pp. 1–546. ISBN 978-0-618-43389-6.
  19. ↑ Hackos, JoAnn T. (1994). Managing Your Documentation Projects. Wiley. p. 630. ISBN 0-471-59099-1.
  20. ↑ Tarutz, Judith A. (1992). Technical Editing. New York: Perseus Books. p. 456. ISBN 0-201-56356-8.
  21. ↑ Bureau of Labor Statistics, U.S. Department of Labor, Occupational Outlook Handbook, Technical Writers, on the Internet at https://www.bls.gov/ooh/media-and-communication/technical-writers.htm (visited February 22, 2018).
  22. ↑ "Gaddis, William, 1922-". ProQuest Learning: Literature. Retrieved 2015-01-11.
  23. ↑ "Amy Tan Biography[url=http://www.notablebiographies.com/St-Tr/Tan-Amy.html". Encyclopedia of World Biography. Missing or empty |url= (help); |access-date= requires |url= (help)

[1]

  1. ↑ "Amy Tan Biographies". Encyclopedia of World Biography. Advameg. Retrieved 2016-10-07.
This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.