Technical writing

Last updated

Technical writing is a specialized form of communication used by many of today's industrial and scientific organizations to clearly and accurately convey complex information to a user. An organization's customers, employees, assembly workers, engineers, and scientists are some of the most common users who reference this form of content to complete a task or research a subject. Most technical writing relies on simplified grammar, supported by easy-to-understand visual communication to clearly and accurately explain complex information.

Contents

An example of an "exploded" CAD model. Explosions with callouts are common visual communication created by technical writers, from CAD models, to help simplify technical writing content. Cone clutch.svg
An example of an "exploded" CAD model. Explosions with callouts are common visual communication created by technical writers, from CAD models, to help simplify technical writing content.

Technical writing is a labor-intensive form of writing that demands accurate research of a subject and the conversion of the collected information into a written format, style, and reading level the end-user will easily understand or connect with. There are two main forms of technical writing. By far, the most common form of technical writing is procedural documentation written for the general public (e.g., standardized step-by-step guides and standard operating procedures (SOPs)). Procedural technical writing is used in all types of manufacturing to explain user operation, assembly, installation instructions, and personnel work/safety steps. Written procedures are widely used in manufacturing, software development, medical research, and many other scientific fields. The software industry has grown into one of the largest users of technical writing and relies on procedural documents to describe a program's user operation and installation instructions.

In some applications, technical writing may be written for experts or fellow scientists within a field of work or study. In these applications, a "white paper" form of technical writing is used to describe a specialized topic and market a product/service or opinion/discovery to select readers. Organizations normally use the white paper form to publish technical writing as industry journal articles or academic papers. The white paper form is written to appeal to readers familiar with a technical topic. Unlike procedural technical writing, white papers often include unique industry terms and data. Sometimes called scientific technical writing, this secondary form of technical writing must show a deep knowledge of a subject and the field of work with the sole purpose of persuading readers to agree with a paper's conclusion. [1] This form of technical writing is often ghost written by a technical writer. A technical writer will closely collaborate with an organization's industry expert to author these documents but is rarely credited in the published version.

In most cases, however, technical writing is used to help convey complex scientific or niche subjects to end users in "laymen's" terms and includes purely factual content. Modern procedural technical writing relies on simple terms and short sentences, rather than detailed explanations with unnecessary information like personal pronouns, abstract words and unfamiliar acronyms. To achieve the right grammar; procedural docs are written from a third-person, objective perspective, with an active voice and formal tone. A more complete description of the technical writing style is provided in Strunk and White's book The Elements of Style. Technical writing grammar is very similar to print journalism and follows the same style. [2] Although technical writing plays an integral role in the work of engineering, health care, and science; it does not require a degree in any of these fields. Instead, the document's author must be an expert in technical writing. An organization's Subject Matter Experts (SMEs), internal specifications, and a formal engineering review process are relied upon to ensure accuracy. The division of labor helps bring greater focus to the two sides of an organization's documentation, ensuring greater accuracy and quality. Most technical writers hold a liberal arts degree in a writing discipline, such as technical communication, journalism, English, technical journalism, communication, etc. Technical writing is the largest segment of the technical communication field. [3]

Examples of fields requiring technical writing include computer hardware and software, architecture, engineering, chemistry, aeronautics, robotics, manufacturing, finance, medical, patent law, consumer electronics, biotechnology, and forestry.

Overview

Technical writing is most commonly performed by a trained technical writer and the content they produce is the result of a well-defined process. Technical writers follow strict guidelines so the technical information they share appears in a single, popularly used and standardized format and style (e.g., DITA, markdown format, AP Stylebook, Chicago Manual of Style). A technical writer's primary task is to communicate technical information in the clearest and most effective manner possible. [4] : 4  [5] To achieve the highest level of clarity, the authors of an organization's technical writing should be indistinguishable to the reader - with no variations in the established format, grammar, and/or style. The subject matter a technical writer communicates is often complex, so strong writing and communication skills are essential. Technical writers not only convey information through text, but they must be proficient with the latest graphics software. Technical writers use a wide range of programs to create and edit illustrations, diagrams, and CAD explosions. Proficiency in the latest graphics software is a requirement for most technical writing. [6]

In some cases, engineers may perform the technical writing for the project they are working on, but this rarely occurs in large organizations where products must be released or revised weekly. On the business side, marketing materials or press releases are usually written by writers trained in a marketing field and/or creative writing. However, a technical writer may be relied upon to provide editing and other input on any technical content an organization may produce.

History

Like the technical writing Ikea provides with their products, ancient Egyptian technical writers often relied purely on visual communication to explain a procedure. C+B-Egypt-Fig8-DraggingDhnthotepStatue.PNG
Like the technical writing Ikea provides with their products, ancient Egyptian technical writers often relied purely on visual communication to explain a procedure.

While technical writing has only been recognized as a profession since World War II, its roots can be traced to ancient Egypt where visual communication was regularly used to explain procedures. In ancient Greek and Roman times, technical writing by the works of writers like Aristotle and Democratus are cited as some of the earliest forms of written technical writing. The earliest examples of what would be considered modern procedural technical writing date back to the early alchemists. These early scientists developed what we now know as "recipes". Some of the earliest discoveries of written, procedural steps in Western Civilization date back to 1100 A.D. However, visual communication was used to describe procedures in ancient India and China much earlier.

With the invention of the mechanical printing press, the onset of the Renaissance and the rise of the Age of Reason, documenting findings became a necessity. Inventors and scientists like Isaac Newton and Leonardo da Vinci prepared documents that chronicled their inventions and findings. [7] : 1  While never called technical documents during their period of publication, these documents played a crucial role in developing modern forms of technical communication and writing. [7]

The field of technical communication grew during the Industrial Revolution. [8] : 3  There was a growing need to provide people with instructions for using the increasingly complex machines that were being invented. [8] : 8  However, unlike the past, where skills were handed down through oral traditions, no one besides the inventors knew how to use these new devices. Writing thus became the fastest and most effective way to disseminate information, and writers who could document these devices were desired. [8]

During the 20th century, the need for technical writing skyrocketed, and the profession became officially recognized. The events of World War I and World War II led to advances in medicine, military hardware, computer technology, and aerospace technologies. [7] : 2  This rapid growth, coupled with the urgency of war, created an immediate need for well-designed documentation to support the use of these technologies. Technical writing was in high demand during this time, and "technical writer" became an official job title during World War II. [7] : 1 

Following World War II, technological advances led to an increase in consumer goods and standards of living. [7] : 3  During the post-war boom, public services like libraries and universities, as well as transport systems like buses and highways, saw substantial growth. The need for writers to chronicle these processes increased. [7] : 1  It was also during this period that large business and universities started using computers. Notably, in 1949, Joseph D. Chapline authored the first computational technical document, an instruction manual for the BINAC computer. [9]

The invention of the transistor in 1947 allowed computers to be produced more cheaply and within the purchasing range of individuals and small businesses. [7] : 3  As the market for these "personal computers" grew, so did the need for writers who could explain and provide user documentation for these devices. [7] : 3  The profession of technical writing saw further expansion during the 1970s and 1980s as consumer electronics found their way into the homes of more and more people. [7]

In recent years, the prominence of computers in society has led to many advances in the field of digital communications, leading to changes in the tools technical writers use. [7] : 3  Hypertext, word processors, graphics editing programs, and page laying software have made the creation of technical documents faster and easier, and technical writers of today must be proficient in these programs. [4] : 8–9 

Technical documents

Technical writing covers many genres and writing styles, depending on the information and audience. Some examples of commonly used technical documentation include:

Tools

The following tools are used by technical writers to author and present documents:

List of associations

Related Research Articles

Software documentation is written text or illustration that accompanies computer software or is embedded in the source code. The documentation either explains how the software operates or how to use it, and may mean different things to people in different roles.

A document management system (DMS) is usually a computerized system used to store, share, track and manage files or documents. Some systems include history tracking where a log of the various versions created and modified by different users is recorded. The term has some overlap with the concepts of content management systems. It is often viewed as a component of enterprise content management (ECM) systems and related to digital asset management, document imaging, workflow systems and records management systems.

Documentation is any communicable material that is used to describe, explain or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, maintenance, and use. As a form of knowledge management and knowledge organization, documentation can be provided on paper, online, or on digital or analog media, such as audio tape or CDs. Examples are user guides, white papers, online help, and quick-reference guides. Paper or hard-copy documentation has become less common. Documentation is often distributed via websites, software products, and other online applications.

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. Example types of information 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.

The Construction Specifications Institute (CSI) is a United States national association of more than 6,000 construction industry professionals who are experts in building construction and the materials used therein. The institute is dedicated to improving the communication of construction information through a diversified membership base of allied professionals involved in the creation and management of the built environment, continuous development and transformation of standards and formats, education and certification of professionals to improve project delivery processes, and creation of practice tools to assist users throughout the facility life-cycle. The work of CSI is currently focused in three areas being standards and publications, construction industry professional certifications, and continuing education for construction professionals.

Release notes are documents that are distributed with software products or hardware products, sometimes when the product is still in the development or test state. For products that have already been in use by clients, the release note is delivered to the customer when an update is released. Another abbreviation for Release notes is Changelog or Release logs or Software changes or Revision historyUpdates or README file. However, in some cases, the release notes and changelog are published separately. This split is for clarity and differentiation of feature-highlights from bugs, change requests (CRs) or improvements on the other side.

Technical communication is communication of technical subject matter such as engineering, science, or technology content. The largest part of it tends to be technical writing, though importantly it often requires aspects of visual communication. Technical communication also encompasses oral delivery modes such as presentations involving technical material. When technical communication occurs in workplace settings, it's considered a major branch of professional communication. In research or R&D contexts, it can overlap with scientific writing.

Javadoc is a documentation generator created by Sun Microsystems for the Java language for generating API documentation in HTML format from Java source code. The HTML format is used for adding the convenience of being able to hyperlink related documents together.

A subject-matter expert (SME) is a person who has accumulated great knowledge in a particular field or topic and this level of knowledge is demonstrated by the person's degree, licensure, and/or through years of professional experience with the subject. For example, a PhD in chemistry could be easily declared as a SME in chemistry, or a person with a Second Class Radiotelegraph License or equivalent issued by the national licensing body could be considered a SME in radiotelegraphy. A person with a master's degree in electronic engineering could be considered a subject-matter expert in electronics, or a person with many years of experience in machining could be considered a SME in machining.

Behavior-driven development (BDD) involves naming software tests using domain language to describe the behavior of the code.

A software audit review, or software audit, is a type of software review in which one or more auditors who are not members of the software development organization conduct "An independent examination of a software product, software process, or set of software processes to assess compliance with specifications, standards, contractual agreements, or other criteria".

The Microsoft Manual of Style: Your Everyday Guide to Usage, Terminology, and Style for Professional Technical Communications (MSTP), in former editions the Microsoft Manual of Style for Technical Publications, was a style guide published by Microsoft. The fourth edition, ISBN 0-7356-4871-9, was published in 2012. Microsoft employees and partners also had access to a Microsoft Compressed HTML Help (CHM) version.

User experience design, upon which is the centralized requirements for "User Experience Design Research", defines the experience a user would go through when interacting with a company, its services, and its products. User experience design is a user centered design approach because it considers the user's experience when using a product or platform. Research, data analysis, and test results drive design decisions in UX design rather than aesthetic preferences and opinions, for which is known as UX Design Research. Unlike user interface design, which focuses solely on the design of a computer interface, UX design encompasses all aspects of a user's perceived experience with a product or website, such as its usability, usefulness, desirability, brand perception, and overall performance. UX design is also an element of the customer experience (CX), and encompasses all design aspects and design stages that are around a customer's experience.

<span class="mw-page-title-main">Functional specification</span> Type of document

A functional specification in systems engineering and software development is a document that specifies the functions that a system or component must perform.

In technical communication, topic-based authoring or topic-based writing is a modular approach to content creation where content is structured around topics that can be mixed and reused in different contexts. It is defined in contrast with book-oriented or narrative content, written in the linear structure of written books.

A specification often refers to a set of documented requirements to be satisfied by a material, design, product, or service. A specification is often a type of technical standard.

An API writer is a technical writer who writes documents that describe an application programming interface (API). The primary audience includes programmers, developers, system architects, and system designers.

Technical documentation is a generic term for the classes of information created to describe the use, functionality or architecture of a product, system or service.

An application programming interface (API) is a connection between computers or between computer programs. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how to build such a connection or interface is called an API specification. A computer system that meets this standard is said to implement or expose an API. The term API may refer either to the specification or to the implementation.

References

  1. ↑ Hamlin, Annemarie; Rubio, Chris; DeSilva, Michele (2015). "Audience Analysis". Technical Writing. Pressbooks.
    It appears that the supported passage is based on a synthesis from the source rather than a directly attributed statement.
  2. ↑ Marshall, Carrie (2018). Technical Writing For Business People (1st ed.). Swindon UK. p. 1.
  3. ↑ "Technical Communications - What is it? - Tech Writer Today".
  4. 1 2 3 4 5 6 Mike Markel (2012). Technical Communication 10th Edition. Bedford/St. Martins.
  5. ↑ "Technical Writers: Occupational Outlook Handbook: U.S. Bureau of Labor Statistics". www.bls.gov. Retrieved 2024-02-14.
  6. ↑ Johnson, Tom (December 19, 2011). "What Tools Do Technical Writers Use". I'd Rather Be Writing. Retrieved May 4, 2014.
  7. 1 2 3 4 5 6 7 8 9 10 O'Hara, Fredrick M. Jr. "A Brief History of Technical Communication" (PDF). Montana State University Billings. Retrieved April 22, 2014.
  8. 1 2 3 Crabbe, Stephen (2012). "Constructing a Contextual History of English Language Technical Writing" (PDF). University of Portsmouth. Archived from the original (PDF) on May 12, 2014. Retrieved April 30, 2014.
  9. ↑ "History of Technical Writing". Proedit. 14 September 2012. Retrieved May 9, 2014.
  10. ↑ "Dictionary and Thesaurus". Merriam-Webster. Retrieved 2016-01-22.
  11. ↑ Johnson, Tom "What Tools Do Technical Writers Use". I'd Rather Be Writing. December 19, 2011. Retrieved May 4, 2014.
  12. ↑ Hewitt, John (January 18, 2005). "How Technical writers use Microsoft Visio". Poe War. Archived from the original on May 12, 2014. Retrieved May 9, 2014.
  13. ↑ Brierley, Sean (2002). Screen Captures 102 (PDF). STC Carolina (Report). pp. 5–8. Retrieved May 9, 2014.
  14. ↑ Johnson, Tom (December 19, 2011). "What Tools Do Technical Writers Use". I'd Rather Be Writing. Retrieved May 4, 2014.
This page is based on this Wikipedia article
Text is available under the CC BY-SA 4.0 license; additional terms may apply.
Images, videos and audio are available under their respective licenses.