Technical communication tools
   HOME

TheInfoList



OR:

Technical communication is used to convey scientific, engineering, or other technical information. Individuals in a variety of contexts and with varied professional credentials engage in technical communication. Some individuals are designated as technical communicators or
technical writer A technical writer is a professional information communicator whose task is to transfer information between two or more parties, through any medium that best facilitates the transfer and comprehension of the information. Technical writers researc ...
s. These individuals use a set of methods to research, document, and present technical processes or products. Technical communicators may put the information they capture into paper documents, web pages, computer-based training, digitally stored text, audio, video, and other media. The
Society for Technical Communication The Society for Technical Communication (STC) is a professional association dedicated to the advancement of the theory and practice of technical communication with more than 4,500 members in the United States, Canada, and the world. The society pu ...
defines the field as any form of communication that focuses on technical or specialized topics, communicates specifically by using technology, or provides instructions on how to do something.What is Technical Communications?
TechWhirl. Accessed 9 December 2014.
More succinctly, the
Institute of Scientific and Technical Communicators The Institute of Scientific and Technical Communicators (ISTC) is the UK's largest professional association for those involved in technical communication and information design. It encourages professional education and standards, provides guidance ...
defines technical communication as factual communication, usually about products and services. The
European Association for Technical Communication The European Association for Technical Communication (tekom Europe e.V.) is the largest professional association for technical communication worldwide. The association connects more than 8,500 professionals like technical communicators, technical ...
briefly defines technical communication as "the process of defining, creating and delivering information products for the safe, efficient and effective use of products (technical systems, software, services)". Whatever the definition of technical communication, the overarching goal of the practice is to create easily accessible information for a specific audience.


As a profession

Technical communicators generally tailor information to a specific audience, which may be subject matter experts, consumers, end-users, etc. Technical communicators often work collaboratively to create
deliverable A deliverable is a tangible or intangible good or service produced as a result of a project that is intended to be delivered to a customer (either internal or external). A deliverable could be a report, a document, a software product, a server upgr ...
s that include
online help Online help is topic-oriented, procedural or reference information delivered through computer software. It is a form of user assistance. The purpose of most online help is to assist in using a software application, web application or operating syst ...
, user manuals, classroom training guides, computer-based training,
white paper A white paper is a report or guide that informs readers concisely about a complex issue and presents the issuing body's philosophy on the matter. It is meant to help readers understand an issue, solve a problem, or make a decision. A white paper ...
s, government documents,
industrial video An industrial video is a video that targets “industry” as its primary audience. An industrial video is a type of sponsored film (such as an educational film) which prioritizes pragmatism over artistic value. While the primary purpose of an educa ...
s,
reference card A reference card or reference sheet (or quick reference card) or crib sheet is a concise bundling of condensed notes about a specific topic, such as mathematical formulas to calculate area/volume, or common syntactic rules and idioms of a particula ...
s,
data sheet A datasheet, data sheet, or spec sheet is a document that summarizes the performance and other characteristics of a product, machine, component (e.g., an electronic component), material, subsystem (e.g., a power supply), or software in sufficie ...
s,
journal article An article or piece is a written work published in a print or electronic medium. It may be for the purpose of propagating news, research results, academic analysis, or debate. News articles A news article discusses current or recent news of eit ...
s, and patents.
Technical Technical may refer to: * Technical (vehicle), an improvised fighting vehicle * Technical analysis, a discipline for forecasting the future direction of prices through the study of past market data * Technical drawing, showing how something is co ...
domains can be of any kind, including the soft and hard sciences, high technology including computers and software, and
consumer electronics Consumer electronics or home electronics are electronic (analog or digital) equipment intended for everyday use, typically in private homes. Consumer electronics include devices used for entertainment, communications and recreation. Usually r ...
. Technical communicators often work with a range of
subject-matter expert A subject-matter expert (SME) is a person who has authority, 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 ...
s (SMEs) on these projects. Technical communication jobs include the following:
API writer 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. Overview An API is a library con ...
,
e-learning author Educational technology (commonly abbreviated as edutech, or edtech) is the combined use of computer hardware, software, and educational theory and practice to facilitate learning. When referred to with its abbreviation, edtech, it often refer ...
,
information architect Information architecture (IA) is the structural design of shared information environments; the art and science of organizing and labelling websites, intranets, online communities and software to support usability and findability; and an emerging ...
, technical content developer,
technical editor Editing is the process of selecting and preparing written, photographic, visual, audible, or cinematic material used by a person or an entity to convey a message or information. The editing process can involve correction, condensation, orga ...
, technical illustrator,
technical trainer A technical trainer is an educator or teacher who trains or coaches others in some field of technology. The task requires a certain set of competencies, but many technical trainers do not hold specific technical-training qualifications. Although th ...
,
technical translator Technical translation is a type of specialized translation involving the translation of documents produced by technical writers (owner's manuals, user guides, etc.), or more specifically, texts which relate to technological subject areas or texts w ...
,
technical writer A technical writer is a professional information communicator whose task is to transfer information between two or more parties, through any medium that best facilitates the transfer and comprehension of the information. Technical writers researc ...
,
usability expert Usability can be described as the capacity of a system to provide a condition for its users to perform the tasks safely, effectively, and efficiently while enjoying the experience. In software engineering, usability is the degree to which a soft ...
,
user experience designer User experience design (UX design, UXD, UED, or XD) is the process of defining the experience a user would go through when interacting with a digital product or website. Design decisions in UX design are often driven by research, data analysis, an ...
, and
user interface designer Ancient Egyptian roles * User (ancient Egyptian official), an ancient Egyptian nomarch (governor) of the Eighth Dynasty * Useramen, an ancient Egyptian vizier also called "User" Other uses * User (computing), a person (or software) using an ...
. Other jobs available to technical communicators include digital strategist, marketing specialist, and content manager. In 2015, the
European Association for Technical Communication The European Association for Technical Communication (tekom Europe e.V.) is the largest professional association for technical communication worldwide. The association connects more than 8,500 professionals like technical communicators, technical ...
published a competence framework for the professional field of technical communication. Much like technology and the world economy, technical communication as a profession has evolved over the last half-century. In a nutshell, technical communicators take the physiological research of a project and apply it to the communication process itself.


UX Design in Technical Communications

Historically, Technical & Professional Communication (TPC) has been as an industry that practices writing and communication. However, recently
User Experience (UX) Design User experience design (UX design, UXD, UED, or XD) is the process of defining the experience a user would go through when interacting with a digital product or website. Design decisions in UX design are often driven by research, data analysis, an ...
has become more prominent in TPC as companies look to develop content for a wide range of audiences and experiences. The User Experience Professionals Association defines user experience, or 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, TPC no longer writes content but "writes around the interface" itself as the 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."


Content creation

Technical communication is a task performed by specialized employees or consultants. For example, a professional writer may work with a company to produce a user manual. Some companies give considerable technical communication responsibility to other technical professionals—such as programmers, engineers, and scientists. Often, a professional technical writer edits such work to bring it up to modern technical communication standards. To begin the documentation process, technical communicators identify the audience and their information needs. The technical communicator researches and structures the content into a framework that can guide detailed development. As the body of information comes together, the technical communicator ensures that the intended audience can understand the content and retrieve the information they need. This process, known as the
writing process A writing process describes a sequence of physical and mental actions that people take as they produce any kind of text. These actions nearly universally involve tools for physical or digital inscription: e.g., chisels, pencils, brushes, chalk, di ...
, has been a central focus of writing theory since the 1970s, and some contemporary textbook authors apply it to technical communication. Technical communication is important to most professions, as a way to contain and organize information and maintain accuracy. The
technical writing Technical writing is writing or drafting technical communication used in technical and occupational fields, such as computer hardware and software, architecture, engineering, chemistry, aeronautics, robotics, finance, medical, consumer electronics, ...
process is based on Cicero's 5 canons of
rhetoric Rhetoric () is the art of persuasion, which along with grammar and logic (or dialectic), is one of the three ancient arts of discourse. Rhetoric aims to study the techniques writers or speakers utilize to inform, persuade, or motivate parti ...
, and can be divided into six steps: # Determine purpose and audience # Collect information (
Inventio ''Inventio'', one of the five canons of rhetoric, is the method used for the ''discovery of arguments'' in Western rhetoric and comes from the Latin word, meaning "invention" or "discovery". ''Inventio'' is the central, indispensable canon of rh ...
n) # Organize and outline information (
Arrangement In music, an arrangement is a musical adaptation of an existing composition. Differences from the original composition may include reharmonization, melodic paraphrasing, orchestration, or formal development. Arranging differs from orches ...
) # Write the first draft (
Style Style is a manner of doing or presenting things and may refer to: * Architectural style, the features that make a building or structure historically identifiable * Design, the process of creating something * Fashion, a prevailing mode of clothing ...
) # Revise and edit (
Memory Memory is the faculty of the mind by which data or information is encoded, stored, and retrieved when needed. It is the retention of information over time for the purpose of influencing future action. If past events could not be remembered, ...
) # Publish output ( Delivery)


Determining purpose and audience

All technical communication serves a particular purpose—typically to communicate ideas and concepts to an audience, or instruct an audience in a particular task. Technical communication professionals use various techniques to understand the audience and, when possible, test content on the target audience. For example, if bank workers don't properly post deposits, a technical communicator would review existing instructional material (or lack thereof), interview bank workers to identify conceptual errors, interview subject matter experts to learn the correct procedures, author new material that instructs workers in the correct procedures, and test the new material on the bank workers. Similarly, a sales manager who wonders which of two sites is better for a new store might ask a marketing professional to study the sites and write a report with recommendations. The marketing professional hands the report off to a technical communicator (in this case, a technical editor or technical writer), who edits, formats, and sometimes elaborates the document in order to make the marketing professional's expert assessment usable to the sales manager. The process is not one of knowledge transfer, but the accommodation of knowledge across fields of expertise and contexts of use. This is the basic definition of technical communication. Audience type affects many aspects of communication, from word selection and graphics use to style and organization. Most often, to address a particular audience, a technical communicator must consider what qualities make a text useful (capable of supporting a meaningful task) and usable (capable of being used in service of that task). A non-technical audience might misunderstand or not even read a document that is heavy with jargon—while a technical audience might crave detail critical to their work such as
vector notation In mathematics and physics, vector notation is a commonly used notation for representing vectors, which may be Euclidean vectors, or more generally, members of a vector space. For representing a vector, the common typographic convention is l ...
. Busy audiences often don't have time to read entire documents, so content must be organized for ease of searching—for example by frequent
headings Heading can refer to: * Heading (metalworking), a process which incorporates the extruding and upsetting processes * Headline, text at the top of a newspaper article * Heading (navigation), the direction a person or vehicle is facing, usually si ...
, white space, and other cues that guide
attention Attention is the behavioral and cognitive process of selectively concentrating on a discrete aspect of information, whether considered subjective or objective, while ignoring other perceivable information. William James (1890) wrote that "Atte ...
. Other requirements vary according to a particular audience's needs. Technical communicators may need to translate, globalize, or localize their documents to meet the needs of audiences in different linguistic and cultural markets. Globalization involves producing technical content that meets the needs of "as many audiences as possible," ideally an international audience. Localization adapts existing technical content to fit the "cultural, rhetorical, educational, ethical, ndlegal" expectations of users in a specific local context. Technical communication, in the government, is particular and detailed. Depending on the segment of government (and country), the government component must follow distinct specifications. Information changes continuously and technical communications (technical manuals, interactive electronic technical manuals, technical bulletins, etc.) must be updated.


Collecting information

Technical communicators must collect all information that each document requires. They may collect information through primary (first-hand) research—or secondary research, using information from existing work by other authors. Technical communicators must acknowledge all sources they use to produce their work. To this end, technical communicators typically distinguish quotations, paraphrases, and summaries when taking notes.


Organizing and outlining information

Before writing the initial draft, the technical communicator organizes ideas in a way that makes the document flow well. Once each idea is organized, the writer organizes the document as a whole—accomplishing this task in various ways: # chronological: used for documents that involve a linear process, such as a step-by-step guide that describes how to accomplish something; # parts of an object: Used for documents that describe the parts of an object, such as a graphic showing the parts of a computer (keyboard, monitor, mouse, etc.); # simple to complex (or vice versa): starts with easy ideas and gradually goes into complex ideas; # specific to general: starts with many ideas, then organizes the ideas into sub-categories; # general to specific: starts with a few categories of ideas, then goes deeper. After organizing the whole document, the writer typically creates a final outline that shows the document's structure. Outlines make the writing process easier and save the author time.


Writing the first draft

After the outline is complete, the writer begins the first draft, following the outline's structure. Setting aside blocks of an hour or more, in a place free of distractions, helps the writer maintain a flow. Most writers prefer to wait until the draft is complete before any revising so they don't break their flow. Typically, the writer should start with the easiest section, and write the summary only after the body is drafted. The ABC (''a''bstract, ''b''ody, and ''c''onclusion) format can be used when writing a first draft of some document types. The abstract describes the subject so that the reader knows what the document covers. The body is the majority of the document and covers topics in depth. Lastly, the conclusion section restates the document's main topics. The ABC format can also apply to individual paragraphs—beginning with a topic sentence that states the paragraph's topic, followed by the topic, and finally, a concluding sentence.


Revising and editing

Once the initial draft is laid out, editing and revising can be done to fine-tune the draft into a final copy. Usability testing can be helpful to evaluate how well the writing and/or design meets the needs of end-users and to suggest improvements [] Four tasks transform the early draft into its final form, suggested by Pfeiffer and Boogard:


Adjusting and reorganizing content

In this step, the writer revises the draft to elaborate on topics that need more attention, shorten other sections—and relocate certain paragraphs, sentences, or entire topics.


Editing for style

Good style makes writing more interesting, appealing, and readable. In general, the personal writing style of the writer is not evident in technical writing. Modern technical writing style relies on attributes that contribute to clarity: headings, lists, graphics; generous white space, short sentences, present tense, simple nouns,
active voice Active voice is a grammatical voice common in many of the world's languages. It is the unmarked voice for clauses featuring a transitive verb in nominative–accusative languages, including English and most other Indo-European languages. A verb ...
Gary Blake and
Robert W. Bly Robert W. Bly (born July 21, 1957) is an American writer on the subjects of copywriting, freelance writing, and many other subjects from science and science fiction, to satire and small business. He is a copywriter. Bly grew up in Fair Lawn, New ...
, ''The Elements of Technical Writing'', pg. 63. New York City:
Macmillan Publishers Macmillan Publishers (occasionally known as the Macmillan Group; formally Macmillan Publishers Ltd and Macmillan Publishing Group, LLC) is a British publishing company traditionally considered to be one of the 'Big Five' English language publi ...
, 1993.
(though some scientific applications still use the
passive voice A passive voice construction is a grammatical voice construction that is found in many languages. In a clause with passive voice, the grammatical subject expresses the ''theme'' or ''patient'' of the main verb – that is, the person or thing t ...
), second and third person as required Technical writing as a discipline usually requires that a technical writer use a
style guide A style guide or manual of style is a set of standards for the writing, formatting, and design of documents. It is often called a style sheet, although that term also has multiple other meanings. The standards can be applied either for gene ...
. These guides may relate to a specific project, product, company, or brand. They ensure that technical writing reflects formatting, punctuation, and general stylistic standards that the audience expects. In the United States, many consider the ''
Chicago Manual of Style (''City in a Garden''); I Will , image_map = , map_caption = Interactive Map of Chicago , coordinates = , coordinates_footnotes = , subdivision_type = Country , subdivision_name ...
'' the bible for general technical communication. Other style guides have their adherents, particularly for specific industries—such as the ''Microsoft Style Guide'' in some information technology settings.


Editing for grammar and punctuation

At this point, the writer performs a ''mechanical edit'', checking the document for grammar, punctuation, common word confusions, passive voice, overly long sentences, etc.


See also

*
Digital rhetoric Digital rhetoric can be generally defined as communication that exists in the digital sphere. As such, digital rhetoric can be expressed in many different forms —including but not limited to text, images, videos, and software. Due to the incr ...
* Technical definition *
Technical editing Editing is the process of selecting and preparing written, photographic, visual, audible, or cinematic material used by a person or an entity to convey a message or information. The editing process can involve correction, condensation, org ...
*
Technical writing Technical writing is writing or drafting technical communication used in technical and occupational fields, such as computer hardware and software, architecture, engineering, chemistry, aeronautics, robotics, finance, medical, consumer electronics, ...


References


External links

* {{DEFAULTSORT:Technical Communication * Writing occupations Mass media occupations