8 – Graphics
Figures
Suzan Last; David McMurrey; Kalani Pattison; James Francis, Jr.; Nicole Hagstrom-Schmidt; Matt McKinney; and Gia Alexander
Figures comprise several types of visuals. Examples include nearly any visual that is not text-heavy or a table, such as graphs, charts, maps, and diagrams. The following sections will cover the most common types of figures in detail, as well as their potential utility in technical and professional writing.
Types of Figures and Appropriate Uses
Different figure types have different strengths and uses. For example, you would not use a pie chart if you were presenting data that could not add up to 100%, and you would not use a bar graph to show the layout of a community garden. Table 8.1 lists common figure types used in technical writing, along with their general purpose or description. [1]
Table 8.1. Common types of illustrative graphics
Type of Visual | Description and Purpose | |
---|---|---|
Graphs | Bar Graph | Compares and contrasts two or more subjects at the same point in time, or compares change over time. |
Column Graph | Reveals change in a subject at regular intervals of time. | |
Line Graph | Shows the degree and direction of change relative to two variables; compares items over time, shows frequency or distribution, or shows correlations. | |
Charts | Pie Chart | Displays the number and relative size of the divisions of a subject; shows relation of parts to a whole (parts must sum to 100% to make sense). Typically pie charts will include between three and eight slices. |
Organization chart | Maps the divisions and levels of responsibility or hierarchy within an organization. | |
Flow Chart | Shows the sequence of steps in a process or procedure. | |
Gantt Chart | Indicates timelines for multi-stepped projects, especially used in proposals and progress reports. | |
Illustrations | Diagram | Identifies the parts of a subject and their spatial or functional relationship; emphasizes detail or shows dimensions. |
Photo | Shows what a subject looks like in realistic detail or shows it being used. | |
Animation | Simulates a process, operation, or incident. | |
Film Clip | Depicts a process, operation, or incident in realistic detail. |
Note: Notice the “box heads” on the top and “stubs” on the left are bolded and centered to enhance readability.
Common Uses of Graphics in Technical Documents
As with any writing decision, use your audience as your guide. Where in technical documents (such as instructions, reports, and proposals) could your reader benefit from visual clarification? Table 8.2 below reviews common types of information that may be clarified by the use of graphics.
Table 8.2. Common places for graphics in technical documents.
What You are Writing | Graphic Ideas |
---|---|
Results of a survey question | Table, chart, or graph |
Numeric data in relation to two or more things | Table, chart, or graph |
Definitions of multiple terms | Table |
Chain of command or relationships in an organization | Organization chart |
A complex process or procedure | Flow chart |
A timeline for completing a project | Gantt chart |
An important piece of equipment | Photograph or diagram |
A specific geographic location | Map |
If you’re not sure where you could incorporate a figure, remember that charts and graphs are just another way of presenting the same data that is presented in tables. The advantage of graphs and charts is that they are more dramatic and interesting; however, this strength may come at the cost of detail or precision, where tables excel. Imagine the difference between a table of sales figures for a ten-year period and a line graph for that same data. In the graph, you get a better sense of the overall trend but not of the precise dollar amount.
Drawings, Diagrams, Photos
To depict objects, places, people, and the relationships between them, you can use photos, drawings, diagrams, and schematics.
Major types of illustrations and photographs run from minimal to maximal detail. A simple line drawing of how to graft a fruit tree reduces the detail to simple lines representing the hands, the tools, the graft stock, and the graft. Diagrams are more abstract, schematic views of things; for example, a diagram of a car engine hardly resembles the actual physical thing at all. Photographs, of course, provide the most detail of all. These graphics, supplying gradations of detail as they do, have their varying uses. Here are some examples:
- In instructions, simple drawings (often called line drawings because they use just lines, without other detail such as shading) are the most common. They simplify the situation and the objects so that the reader can focus on the key details.
- In descriptions, you would want to use drawings, but in this case drawings with more detail, such as shading and depth perspectives.
- In feasibility, recommendation, and evaluation reports, photographs are often used. For example, if you are recommending a photocopier, you might want to include photos of the leading contenders.
The ethical responsibility to promote diversity arises when incorporating photographs into technical documents. When using photos, work to achieve a balance of representations throughout your document, including both men and women, older and younger people, people using assistive technology like wheelchairs and people of color.
Effective Formatting and Design for Figures
When you create charts and graphs, keep these requirements in mind (most of these elements are illustrated in Figure 8.3 [2]below):
Labels. Certain figures contain labels—words and phrases—with pointers to the parts of the things being depicted. In bar charts and line graphs, don’t forget to indicate what the x- and y- axes represent. One axis might indicate millions of dollars; the other, five-year segments from 1960 to the present.
Keys or Legends. If the illustration has certain shadings, colors, line styles, or other details that have a special meaning in the illustration, these should be indicated in a key or a legend—an area in an unused corner of the illustration that deciphers their meaning.
Titles. Except in special cases, illustrations should have titles, and these titles should be numbered (Figure 1, Figure 2, and so on). The exceptions are these:
-
- If you have lots of illustrations (for example, in certain instructions, there are illustrations practically after every paragraph) and if there is no benefit from the titles
- If you only have one or two illustrations and they are not cross-referenced
- If you do not cross-reference your illustrations.
In some of these cases, you might want to keep the title but discard the word “Figure” and the number following it. The title of a figure goes in a caption below the figure.

Cross-references. Almost all illustrations should be referred to from the relevant point in the discussion. Prior to providing the graphic, identify its purpose and explain any relevant details for your readers.
Location within the report. Figures should be placed just after the point where they are needed. However, sometimes because of the pagination (the way the text falls on the pages) and the size of the illustrations, this close placement is not possible. If this occurs, place the graphic at the top of the next page. Your figure numbers and cross-referencing will make it clear what information the graphic is associated with.
Size of illustrations. Ideally, you want illustrations to be between one-quarter to one-half of the vertical size of the page. You also want them to fit on the page with other text. In fact, that’s what you really want—to intersperse text and graphics in a report. Extremely large figures may need to be resized, revised to focus on specific information, or placed on their own page.
Placement within margins. Make sure that your illustrations fit neatly and comfortably within standard (usually one-inch) margins. You don’t want the illustration spilling over into the right or left margins. You want to allow the equivalent of at least two blank lines above and below the illustration.
Level of technical detail. Design your figures to be at the right technical level for your readers. For example, a chip circuitry diagram for an audience of computer beginners would likely be too complex.
Design. Avoid unnecessarily convoluted, distracting, or misleading design elements. For instance, don’t use 3D for figures such as pie charts or bar graphs. A 3D pie chart can distort the impression that the size of the slices makes, and 3D bar graphs can make it difficult for the reader to tell whether to read from the “front” or the “back” of the bar. See Figure 8.4[3] for a good example of a pie chart with clear slices, labelling, and design.

Accessibility/Usability. Be sure that your figures are accessible to a wide variety of readers and in a variety of formats. In addition to using actual text rather than pictures of text and including alternative text where needed, choose your colors wisely. While different shades of the same color may look nice, those shades may be easily misread if they are too similar. Combinations of red and green or yellow and blue may make it difficult for those with the most common types of color-blindness to determine the figure’s meaning. Remember that clear communication is the most important consideration in design choices.
This text was derived from
Last, Suzan, with contributors Candice Neveu and Monika Smith. Technical Writing Essentials: Introduction to Professional Communications in Technical Fields. Victoria, BC: University of Victoria, 2019. https://pressbooks.bccampus.ca/technicalwriting/. Licensed under a Creative Commons Attribution 4.0 International License.
McMurrey, David. Online Technical Writing. n.d. https://web.archive.org/web/20230610185120/https://www.prismnet.com/~hcexres/textbook/. Licensed under a Creative Commons Attribution 4.0 International License.
- For a detailed discussion of how and when to use these kinds of visuals, see H. Graves and R. Graves, “Communicating through Visuals,” in A Strategic Guide to Technical Communications, 2nd ed. (Peterborough, ONT: Broadview Press, 2011), 137-148. ↵
- James Francis and Sarah LeMire, “Example of a Graph,” 2020. Licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. ↵
- U.S. Environmental Protection Agency, Office of Resource Conservation and Recovery, “Figure 12. Materials recovery in MSW,* 2012 86.62 Million tons,” in Municipal Solid Waste Generation, Recycling, and Disposal in the United States Tables and Figures for 2012, February 2014, 46. https://archive.epa.gov/epawaste/nonhaz/municipal/web/pdf/2012_msw_dat_tbls.pdf ↵
Tables are made up of rows and columns that contain data, usually in numerical form. They permit rapid access to and relatively easy comparison of information. If the data is arranged chronologically (for example, sales figures over a ten-year period), the table can show trends (for example, patterns of rising or falling activity). Of course, tables are not necessarily the most vivid or dramatic means of showing such trends or relationships between data—that's why we have charts and graphs. These figures are discussed in greater detail later in the chapter.
Uses for Tables
Tables are used to organize detailed data and information into categories for comparison. The most typical use of tables is for large amounts of numerical data, so tables should be used when exact figures are important. Tables also have an added advantage over charts and graphs by being able to compare multiple factors, whereas a 2D chart can only compare two variables. For example, imagine that you are comparing different models of laser printers in terms of physical characteristics such as height, depth, length, weight, and so on. A table is perfect for demonstrating and allowing comparison of the exact measurements of these specific printer models.
However, tables are not only used for numerical data. They may also be used to organize multiple qualitative categories that are best expressed using words. A qualitative category could be something like color, a ranking such as “Good” or “Ineffective,” or even a definition of a concept. Imagine again that you are comparing several models of a laser printer. As part of your evaluation, you would use different categories (such as cost, print speed, cost of ink, warranty) as criteria. These criteria would be ideal content for a table that uses words rather than numbers.
Effective Table Format and Design
When formatting your tables, there are several guidelines you should follow in order to increase their usability for your audience.
Title. Traditionally, the title of a table is placed on top of the table or is the first row of the table, rather than below. This is because tables are usually read from top to bottom, so it makes sense that the title would be in the first place a reader looks. The tables in this textbook are formatted according to this principle. To provide a title for your table, first include an identifier. This identifier will usually be the label “Table” combined with a number. Tables should be numbered sequentially, with the first table appearing in your report being labeled as Table 1, the second table labeled as Table 2, and so on. Conclude the label with a period. After the label, provide a descriptive title that identifies the content of the table. This title may be formatted in “sentence case,” with only the first word and any proper nouns capitalized, or in “title case,” with all words other than non-primary articles or prepositions being capitalized. Whichever you choose, make sure it is consistent across all tables and figures. For an example of how to title a table and other figures, see “Captions (Labels, Titles, and Citations)” later in this chapter. In addition, consider how figures and tables are labeled throughout this text.
Headings. Another major formatting feature of tables is the use of headings. Headings are used at the top of each column (where they are called box heads) and on the leftmost-side of each row (where they are called stubs). These headings are used to identify the content being provided in their given row or column. When providing a heading for a column that has numerical data, include the units for that column in the header rather than in each individual cell.
When it comes to headings, formatting becomes more complicated when rows or columns must be grouped or subdivided. In such cases, you have to create row or column subheadings. Figure 8.1[1] illustrates a way to handle this challenge. In this table, there are twelve total columns. Ten of these columns are given headings in cells of the same height. The Distributor information is first identified in an eleventh column. This information is immediately sub-divided into two separate columns and given headings below. Combined, these cells make up the same height as the rest of the row with headings.
Alignment. Left-align or center-align words and phrases in table columns (including the column heading). Right-align numeric data in table columns.
Footnotes and Citation. The final item to consider when formatting a table is whether to add a note or caption below the table itself. There are three types of notes you may use for a table: general, specific, and probability. General notes refer to general information included in a table, such as an explanation of the data source or a citation. Citations are formatted as in-text citations that follow your chosen style guide. General notes appear first and include a label such as “Note:”; “Source:”; or “Data from” (without quotation marks). Specific notes are reserved for specific details about a column, row, or cell. These notes go below any general notes and are labeled with a superscript number or letter that corresponds to a specific place on the table. Finally, probability notes provide information on probability testing. These notes appear last, after any general or specific notes. They do not contain a label. When there is some special point you need to make about one or more of the items in the table, use a footnote instead of clogging up the table with the information

Effectively Integrating Tables into Your Document
In order to integrate tables into your document effectively, include text that precedes the table and explains the general significance of the data in the table. Don't expect readers to figure out the table entirely for themselves. Also, be sure that you don’t overwhelm your readers with extremely large tables; include only the amount of data needed in order to illustrate your point.
Occasionally, rough drafts of technical reports present information in regular running-text form that could be better presented in table (or tabular) form. When revising, review your rough drafts for material that can be transformed into tables. Figure 8.2[2]below shows an example of how to revise a draft by converting information into a table format. Note how the writer pulls the specific data points from the paragraphs and places them into a table for easy reference. Note also that in the revised paragraphs below, the points in the text also clearly introduce and link to the information in the table. These details help fully integrate the table into the document and make the overall text easier to quickly read and understand.

This text was derived from
Last, Suzan, with contributors Candice Neveu and Monika Smith. Technical Writing Essentials: Introduction to Professional Communications in Technical Fields. Victoria, BC: University of Victoria, 2019. https://pressbooks.bccampus.ca/technicalwriting/. Licensed under a Creative Commons Attribution 4.0 International License.
McMurrey, David. Online Technical Writing. n.d. https://web.archive.org/web/20230610185120/https://www.prismnet.com/~hcexres/textbook/. Licensed under a Creative Commons Attribution 4.0 International License.
Writing Strategies
While constructing documents during the writing process, we often examine sample materials that can help us consider how to make our own writing more effective. Whether we are writing a research report, developing an analytical essay, creating a visual handout, crafting application materials for a job, or starting the next great novel, reviewing sample materials within the same genre of writing can be helpful in making decisions regarding the form and content for your text.
Although sample materials help writers, we have to be cognizant of how to use them effectively without falling into traps of basing our own work on them. When this situation occurs, writers may find themselves creating documents that are not appropriate for the intended audience, not unique to their own personal voice and style, and accidentally plagiarized by usurping someone else’s work without credit (see Chapter 12: Avoiding Plagiarism and Citing Sources Properly for more information). In this section, we will review a few tips to ensure that sample materials remain helpful in developing your own documents effectively.
As always remember to contact your instructor for any clarification on how they may want you to utilize sample materials. If you have questions or concerns before and/or during the construction of your writing—in form and/or content--reach out to them!
Formatting
Sample materials help demonstrate proper formatting techniques, particularly by showcasing standard elements. These elements include the following:
- Style manual guidelines
- Font selection and size
- Spacing
- Text alignment
- Headers
- Page Numbers
- Titles
- Paragraphs
- Figures (Tables, Graphics, Illustrations, Images)
- Documentation and Formatting
- In-text citations
- Figure labels
- Proper Nouns (Names of people or places; Titles of works)
- Source listing—for instance:
- Works Cited (MLA)
- References (APA)
- Bibliography (Chicago)
- Harvard (Reference List)
- Organization
- Paragraph structure
- Chronology of content
- Linear (sequential)
- Reverse (conclusion to beginning)
- In medias res (starting in the middle)
- Visual Appeal
- Color
- Emphasis (Bold, Underline, Italics, Highlights)
- Font selection and size
- Text alignment
- Figures
- Spacing
- Framing
This is not an exhaustive list, and depending on the type of document you are creating, some or all of these elements might require consideration in making your document the most effective for its intended audience and the assignment guidelines. The ways in which a document appeals to the reader help make a rhetorical connection to its content. When you examine any of these elements in sample materials, evaluate how they impact the content and the message conveyed to the intended audience. As you develop your materials, focus on the purpose, objective, and goal of the document(s) so that you may format the work as most appropriate to the rhetorical situation.
What you take away from reviewing the form of sample materials should be ideas to apply to your documents in unique ways that align with what you hope to accomplish—not a carbon copy of what someone has already produced for a sample, even if that sample represents one way to address the assignment guidelines. Let’s take a look at an example for making an informational handout (Figure 24.1[3]) and a similar document created using the exact same formatting (Figure 24.2[4]):


The student handout in Figure 24.2 assumes similar design elements of the sample without consideration of their specific subject matter. Because of this oversight, the handout is ineffective because the design elements are neither unique nor suitable for the subject matter; furthermore, the information and the tone of the content do not complement the subject matter. In order for the student to create a more effective handout, they should only use the sample to consider how it merged its form and content to relate to the topic and its intended audience. Evaluating the sample presents the student with the following question: How do I format my handout so that the design principles respond to the content and connect with the intended audience? Here is the revised student handout (Figure 24.3[5]):

In the revised handout we can recognize principles of effective design (See Chapter 7: Design) that the sample handout demonstrates, as well as that the student’s work represents an original document that benefitted from reviewing sample materials. They have created a document that is now balanced in its form and content to deliver information to its audience in an appropriate tone. But as illustrated above, let’s not forget that formatting represents only half of what we need to examine to create effective materials.
Content
Organization of content is slightly different from the technical aspects of formatting, but it still follows the same understanding that a sample document can help you consider how to arrange your writing without following the exact structure of the sample. When organizing content within a document, the writer should ensure that the text flows (i.e., includes transitions from one point to the next) and achieves clarity of communication. If you follow a sample document’s organization and general setup too closely without concern for how your writing needs to be original, the content might not seem logical, fluid, or relevant to the assignment guidelines. Here is an example that demonstrates a report of findings from primary research (note: all sources and in-text citations have been created for sample use only):
Sample Report Text
Once the survey period concluded, we tallied the final numbers and discovered more people liked the design with the blue background as opposed to the orange background. The color selection follows what Hinojosa mentioned in her article about orange causing a soporific effect (a tendency toward sleepiness and often boredom). As a result—from the surveys and research experts—we propose that the new team uniforms use the selected design with a blue background for the next season.
Student Report Text
When our survey period ended, we counted the final numbers and discovered more people liked the garlic toppings instead of the cinnamon toppings. The more-savory food topping selection agrees with what Pham detailed in their source about people having an aversion to mixing toppings—like cinnamon—that cause effluvia. In conclusion, we recommend that the pizza restaurant make the cinnamon topping a specialty item instead of a main-menu offering for patrons.
By reproducing the same organization and delivery of the sample report text, the student’s work leaves out important, vital elements—documentation for the source, along with details and description to clarify the writing—and they inadvertently plagiarize content. Always remember that samples are not examples of perfect writing because that concept does not exist; you must ask yourself what is and is not effective about the sample writing in order to consider how to avoid missteps—like not crediting a source—and how to translate a helpful writing strategy—such as providing a definition for transparency—into your own materials. Here is the revised student report:
Student Report Text (revised)
We counted the final numbers at the close of the survey period and the results showed that patrons of the pizza restaurant favored the garlic toppings over the cinnamon toppings, 72 to 28 (Figure 2.3). Supporting this finding, Pham (2019) claims, “Foodies prefer foods that taste and smell good because both senses have to be satisfied in the eating process” (p. 62). Based on our research, we recommend Pop’s Pizzeria making the cinnamon topping a specialty item instead of a main-menu offering, which will allow the establishment to simultaneously reduce the amount of product purchased each season and therefore reduce spending.
The revised content provides much more detailed, specific content to present the research findings; the survey results and academic source are properly documented; and the content offers a reason behind the recommendation. The student reviewed the effectiveness of the sample’s organization and content, and then they constructed their own report writing relevant to their project. And if you find yourself working with analysis instead of reporting, we can find similar ways to avoid replicating sample material organization and content delivery. Here is an example that demonstrates film analysis; the sample covers the text the student has been tasked to analyze:
Sample Analysis Text
Dee Rees’ Pariah contains symbols for the audience to unlock. One of those symbols is coded in the attire of the characters. Alike rejects stereotypical engendered clothing articles like dresses and the color pink for young girls. Instead, she prefers a do-rag, a ball cap, and baggy, comfortable clothes. She does this to access and present a more recognized masculine aesthetic to attract a potential love interest. De Santos writes, “People often use clothing to create a conversation concerning gender that they cannot put into words for fear of being ostracized” (37).
Student Analysis Text
In Pariah, we are provided symbolism throughout the film. The main character’s preferred name serves as a reminder that she exists as the “other” in the story. Alike prefers “Lee” instead of the name she was assigned at birth. This is ironic because she is completely unlike any of her immediate family members. She uses “Lee” to help demonstrate her masculine identity to attract other girls. Nakai is quoted as saying, “Some LGBTQ youth, upon coming into adulthood, disclose that their assigned names do not complement their self-identities” (70).
The student’s text mimics the exact sentence arrangement, presentation of discussion elements, and tone of the sample. Following the sample’s arrangement so closely makes the content sound choppy; the sentences are properly formatted, but they don’t seem to connect to each other to create a fluid discussion. Mirroring the sample analysis too closely also robs the student’s work of having a unique voice to set up the analysis, and furthermore, the sample incorporates secondary source material without fully integrating the quote. In the end, the writing becomes ineffective in communicating its message to the reader. Here is the revised student analysis:
Student Analysis Text (revised)
In Pariah (2011), the main character’s preferred name serves as a symbol that she exists as the “other” against additional characters in the film. Unlike her mother, father, and sister, Alike prefers “Lee” (the pronunciation of the second syllable in her name) instead of the name she was assigned at birth. The spelling of her assigned name is ironic because she is completely unlike her family members, and she prefers “Lee” because it feels more suitable to her understanding of butch-lesbian identity to attract other girls. The importance of naming and its connection to identity is further explored in “Nomenclature and the Self” by Dakoda Nakai. The writer claims, “Some LGBTQ youth, upon coming into adulthood, disclose that their assigned names do not complement their self-identities” (Nakai 70). As a coming-of-age film, Pariah demonstrates the disparate nature of naming and identity through Lee/Alike.
The revised content reveals analysis that is more connected structurally, which allows the student’s voice to clearly communicate its message and develop a full conversation with the incorporated secondary source. The content of your document, whether it be a handout, report, essay, novel, or other, needs to be unique—written from your perspective to respond to what the assignment requires and what the rhetorical situation demands. Organize your writing according to what the assignment guidelines stipulate, how you feel the text would be best represented, and in a manner that it connects clearly with your intended audience. When the organization is effective, the content of the document can equally accomplish its goals of communicating to the audience in the appropriate rhetorical mode.
Creative Writing: A Brief Note
Creative writing is all about invention: world-building, characterization, unique dialogue, story pacing, traditional vs. innovative narrative structure, and personal style for the author. Although many new and working writers revere the work of recognized, published authors, the goal is to establish your own voice in the field. Inspiration can veer close to imitation if a writer finds themself copying techniques—story structure, wording, setting, etc.—that another author has already established as their own. Without making any effort to distinguish between the two styles, the writer creates unoriginal work that—depending on the wording—could place them in a situation involving plagiarism.
Similar to crafting an instructions handout, researched report, or a literary analysis, the development of a creative writing piece—poetry, prose, stage play, and even film—can be aided by reviewing sample materials, but the work should avoid resembling an impersonation of another’s intellectual property. Experiment with different writing strategies, techniques, and forms to discover what methods work best for what you want to accomplish with the writing. Focus on form and content with regard to your intended audience and get creative!
Note
Using sample materials effectively takes a lot more consideration than we often think about when viewing and reading them. Always keep in mind that these materials are meant to help get us started in creating our own documents, to help us develop ideas unique to the assignment, and to act as a bridge to connect how form and content rely upon each other to resonate with the intended audience.
Seek the guidance of your instructor for any clarification needs about how to use the sample materials in your course. You might also utilize helpful services like the University Writing Center to develop your documents from their inception to their completion with the aid of a writing tutor and/or access the Writing & Speaking Guides to review handouts, podcasts, and videos to self-assist the specific needs of your document-creation.
Did you know that you probably read or create technical communication every day without even realizing it? If you noticed signs on your way to work, checked the calories on a cereal box, emailed your professor to request a recommendation, or followed instructions to send money using an app, you have been involved with technical, professional, or business communication.
Today, writing is a more important skill for professionals than ever before. The National Commission on Writing for America's Families, Schools, and Colleges declares that writing today is an essential skill for many, and that much of what is important in American public and economic life depends on strong written and oral communication skills.[6] Unfortunately, not all college students are entering the workforce well-equipped to write successfully. A survey by the Workforce Solutions group at St. Louis Community College asserts that many employers are concerned at the lack of communication and interpersonal skills among the large number of college graduates applying for jobs.[7]
Good communication skills, particularly in writing, are essential if you are going to succeed in the workplace. The working world depends on written communication because almost every action is documented in writing within modern organizations. Furthermore, many kinds of writing through a variety of communication channels or platforms—including correspondence, presentations, articles, technical reports, and formal reports—are prevalent in most workplaces. The communication within those documents needs to be relevant to the mode of delivery, accurate, and clear.
The Discipline of Technical and Professional Communication
The field of technical communication is a broad one containing professional technical writers, teachers, and people in other professions for whom technical writing is a key component of the job like engineers and researchers. Even if you do not plan on pursuing technical writing as a profession, it can be useful to understand the field and what its prominent practitioners do as a way to inform your own writing.
What Does Technical and Professional Communication Look Like?
Being a technical and/or professional writer does not necessarily mean you are solely a writer. While several companies and organizations may hire technical writers to compose, edit, and distribute documents, writing (and specifically technical writing) is done by individuals across jobs. A mining engineer, for example, must complete technical reports for sites and equipment. A public health nurse may write grants to obtain funding for a new program. Teachers compose progress reports for students and evaluations for peers. Academic and government researchers write articles and reports on their findings.
Examples of technical and professional communication are everywhere, if you know what you are looking for. Check out the CDC's statement about their mission and purpose.[8] Who is the target audience? What information does this document provide? What task or goal will it help to accomplish? What elements of this document do you think make it useful? Does it solve a problem? What about the style of the writing in this government document? Is it concise and accurate? This is just one example of the many kinds of technical documents you will work with in this course.
How Do Technical Writers Ensure Accuracy?
Not all technical writers possess a doctorate or other top-tier credentials to convey complex disciplinary-specific information about a procedure or product effectively. However, conveying information outside of their direct expertise is a challenge technical writers often face. Fortunately, there are several strategies technical writers can employ to ensure the technical accuracy of their work:
- Study of books, articles, reports, and websites related to the topic, issue, or product
- Product specifications: what the product is supposed to do, how it is designed
- Interviews with subject matter experts: specialists, developers, project managers, engineers
- Product meetings during the development cycle
- Live demonstrations of the product
- Familiarity with prior research and discourse on the topic
- Experimentation, testing for feasibility, clinical trials, and replication studies
- Subject matter experts’ review of technical writers’ work for technical accuracy and completeness
These approaches can also be useful for students of technical writing. In your other courses, you may have been expected to conduct original research using experimental data, primary sources, and secondary sources. Possibly, you have consulted with your peers, your professors, and your TAs to help ensure the correctness of your conclusions. These same skills can be thus applied to technical and professional writing.
What Standards Should I Observe to Make My Writing Successful?
As a member of any organization or team, you want to produce the absolute best writing you can. Here are the standards you must follow and some tips to help you. Good technical writing is:
- Accurate. As part of establishing your credibility and producing usable information, your documents must provide information that is credible and well-researched. There is no excuse for presenting incorrect information. In addition, needing to write a new document to correct a mistake costs time and makes you seem unprofessional.
- Clear. Technical and professional writing is user focused, meaning that it is successful when the reader understands what you haven written.
- Complete. At its most basic, “complete” means that the writer has addressed all common genre components, such as including bibliographic information for citations or sections like an abstract or table of contents. A document’s completeness is also based on its audience. Some audiences will need more background information on one area, whereas others will need more details in another.
- Concise. For many, “concision” translates to “brief.” While concise work tends to be shorter, this standard does not mean you are barred from using complex sentences or words. Every word has a purpose in a technical document. If the words do not add to the meaning, then they can safely be omitted.
- Professional. What counts as “professional” varies across contexts and audiences, but in general, audiences expect to see documents that are free from common grammatical and typographical errors. Technical documents also employ a streamlined aesthetic, using consistent fonts, headings, and other visual cues to signal to the reader how information in one part of the document relates to another.
Technical and professional writing within the U.S. is almost always situated in the conventions of Standard Written English (SWE). SWE and those who use it tend to value strict adherence to traditional rules of spelling, grammar, punctuation, and sentence structure, so make sure that you carefully check for these issues when editing. More likely than not, SWE is not an exact reflection of the English you use in casual conversation; also, it closely resembles dialects associated with perceptions of privilege, wealth/class, and conventional systems of power. Consequently, as a technical writer you will need to consider and adjust your linguistic register (formality, tone, word choice, etc.) to communicate effectively within SWE conventions and to fulfill audience expectations.
Strategies for Successful Technical and Professional Communication
Technical or professional writing is intended to solve problems, seek solutions, and provide necessary information that workers will then use to do the same: solve problems, seek solutions, and provide necessary information. Technical and professional writing conventions are thus largely centered around the needs and expectations of their audiences. We will explore this concept further in later chapters, but in order to have a basic understanding of technical writing, it’s important to consider the value of your readers’ time and to remember to be courteous to them through your documents’ content and organization.
How do you ensure that your document will be useful to your readers? Jakob Nielsen observes that readers, or users, won't read content unless it is clear, simple, and easy to understand.[9] “Clear” and “understandable,” however, are not synonymous with boring. William Zinsser, author of On Writing Well, emphasizes Nielsen’s point but with an emphasis on style: "Good writing has an aliveness that keeps the reader reading from one paragraph to the next, and it's not a question of gimmick to personalize the author. It's a question of using the English language in a way that will achieve the greatest clarity and strength."[10]
Legibility
In order for writing to be useful to readers, it first must be legible. That is, the document and its contents must be accessible to its audience. If the document itself is unable to be interacted with in its current format, then all content will be lost. For many audiences, legibility is related to visibility.
Is the document in a format that can be accessed by the audience? Different audiences will have different technological needs and tools. Is the audience downloading a PDF file? Viewing the document on a website? Using a screen reader?
Is the font large enough to be read by a variety of audiences? The font size is particularly important for presentations and for documents reaching large populations.
Is the document in an easy-to-read typeface and font that is appropriate for the content? Computer-written documents offer several kinds of typefaces and fonts that a writer may use. Different typefaces, like Calibri (the default on Microsoft Word) are designed for reading on computer screens, whereas others are more useful for reading on phones, large projection screens, or in print. Certain typefaces also have “personalities,” such as Times New Roman being associated with professionalism or Comic Sans being associated with youth.
Are graphics presented sharply and in appropriate detail? Graphics, including charts, tables, and images, are often crucial tools for helping audiences quickly understand complex information. Watch for “blurry” or “fuzzy” graphics, especially if you are copying an attributed image. For charts and tables, provide clear titles and logical organization so that your reader can quickly identify pieces of information.
Readability
Once you are sure that your document is legible, make sure your writing is readable. If you have identified and analyzed your audience, you are off to a good start. Readable means that your document can be easily understood by your target audience, and readability refers to the formula whereby words, sentence length, and sentence complexity determine how hard or easy your sentences are to read. Often, readability is linked to grade level in the written language. Documents aimed at highly educated specialists (such as journal articles) are typically written at higher levels whereas documents aimed at a broad audience (such as government websites) will have a comparatively lower readability score. If your readability is too high for the audience, then they will either take more time getting what they need from your writing or determine that the information won't be of any use to them at all. If the readability is too low, you may come across as condescending, if not unprofessional.
Microsoft Word has a readability test built into the program under the Review tab that will give you a good starting place (Figure 1.1).[11] However, don't rely completely on it to assess the ease or difficulty of your writing. Have a trusted colleague take a look and give you feedback. You can also use one of many free online readability formulas.[12]

Comprehensibility
Finally, your writing may be legible and readable, but is it comprehensible? That is, how well can your audience comprehend your document in the way you intended? Is the reader able to use the document in the manner you meant? To enhance the reader's comprehension, use language and terminology familiar to the reader and limit paragraphs to one main idea each. Strive for brevity if your users will be reading on tablets or mobile devices. Use visuals such as charts or diagrams to present a lot of information in a graphic format.
Finally, you can evaluate how easy your document is to comprehend by having another person look at it. Ask a colleague to read your text and then tell you what the important ideas are. If you are conveying your ideas clearly, your reader will be able to sum them up and repeat them back to you. This process is often called “peer review” and can be a highly structured exercise in which you ask your reader to answer specific questions about your work, or it can be relatively unstructured as you ask your reader to repeat back the most important points they’ve taken away from your writing. Peer review will be discussed in greater detail in Chapter 10: Revising and Editing.
Accessibility in Technical Writing
Accessibility is perhaps the most important standard for excellence in technical communication. In this context, “accessibility” refers to how easily readers of all abilities can read and understand your writing. For instance, an accessible document for a person who has low vision would be a document that has OCR text, alternative (or alt-) descriptions of images or content that is not screen readable, and formatted headings to organize the document. Beyond formatting, punctuation and signal phrases—instead of using bold or italics—convey emphasis, and the writer uses clear, straightforward sentences rather than overly complex ones. While it is clear that these accommodations would be especially useful for a reader with low vision, these same features further enhance the clarity for all readers.
What counts as accessibility changes depending on the genre of the technical document. At minimum, the design of your document should be useful, easy to navigate, and with all information easy to locate. Captions on videos, spoken cues throughout an oral presentation, and unique, informative titles for individual web pages on a site all add to the accessibility and ultimate readability of a document. Furthermore, websites and e-learning documents must meet American with Disabilities Act (ADA) laws for accessibility.[13] The ADA National Network provides additional information about the ADA.[14]
This text was derived from
Reardon, Tiffani, Tamara Powell, Jonathan Arnett, Monique Logan, and Cassandra Race, with contributors David McMurrey, Steve Miller, Cherie Miller, Megan Gibbs, Jennifer Nguyen, James Monroe, and Lance Linimon. Open Technical Communication. 4th Edition. Athens, GA: Affordable Learning Georgia, n.d. https://web.archive.org/web/20220521190055/https://alg.manifoldapp.org/projects/open-tc. Licensed under a Creative Commons Attribution 4.0 International License.
Gross, Allison, Annemarie Hamlin, Billy Merck, Chris Rubio, Jodi Naas, Megan Savage, and Michele DeSilva. Technical Writing. Open Oregon Educational Materials, n.d. https://openoregon.pressbooks.pub/technicalwriting/. Licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
McMurrey, David. Online Technical Writing. n.d. https://web.archive.org/web/20230610185120/https://www.prismnet.com/~hcexres/textbook/. Licensed under a Creative Commons Attribution 4.0 International License.
While this textbook primarily discusses technical communication skills in terms of written texts, genres, and discourses, it is also important to master these skills in oral communication. Professionals in all fields are often called upon to present information, such as giving reports to management or leadership in an organization, composing videos, teaching or training other professionals or more general audiences, or even giving presentations at professional events and conferences.
Many of the same qualities that characterize effective written technical communication, such as clarity, concision, and consideration for one’s audience, are also present in effective oral communication. Some of these qualities become even more important or manifest in different forms, such as clear transitions and repetition. This chapter will explore these concepts further in an in-depth analysis of oral communication contexts.
Public Speaking Anxiety
For many of us, speaking in front of a group is terrifying. In a written document, we have the opportunity to revise and edit until we are ready for readers. In a speech or presentation, however, we only have one chance to impress, and we do not have control over the situation. We may also feel embarrassed about things we cannot help, such as a stutter, an accent, or involuntary movements. We may have to switch from how we speak with our families and friends. We may be BIPOC (Black, Indigenous, and People of Color) facing a room of people who are not of our race or heritage. All of these factors and more lead to anxiety over public speaking.
Note
Texas A&M University Resources
There are several useful strategies for overcoming nervousness as a speaker. Texas A&M’s University Writing Center offers an excellent handout with practical tips to address common concerns of preparation, control, and conveying authority.[15] If you need or would like further support for anxiety, we recommend contacting Texas A&M’s Counseling & Psychological Services[16] and Disability Resources.[17]
While there are many helpful practices for those dealing with the nervousness that accompanies public speaking, some of us may have deeper anxieties. In these cases, it may be worthwhile to seek out counseling and other support resources. These services, along with family, friends, and instructors, can help us identify and implement coping strategies, supports, and accommodations for living with anxiety, thus putting us on an even playing field with our peers.
When you look at all the many ways you can review (look for potential problems) and then revise (fix those problems), you might think they're tedious and time-consuming. Revisions do take time, but the results are worth it. If you analyze writing in the ways outlined in this chapter, the way you write and the way you review what you write will change.
This section covers three major areas to focus on when reviewing your work: structure-level revisions, mid-level revisions and editing, and sentence-level editing.
The subsection on structure-level problems includes tips for checking these aspects of your documents:
- Informational value
- Internal organization
- Topic sentences and overviews
The subsection on mid-level problems focuses on areas where structure- and sentence-level problems overlap:
- Completion and balance
- Paragraph length
- Tone
- Definitions of key terms and concepts
The subsection on sentence-level problems includes tips for how to edit for the following common issues:
- Nominalizations
- Noun stacks
- Redundant phrasing
- Expletives
- Weak use of passive voice verbs
- Subject-verb mismatches
- Readability, sentence lengths, and sentence structures
- Commonly confused words
Structure-Level Revisions
Paying attention specifically to “big picture” items such as informational value, internal organization, and topic sentences will help ensure that your document clearly conveys your ideas and their relationships to each other. If you revise your document with these things in mind, you’ll be able to more accurately meet your audience’s expectations.
Informational Value
One of the most important ways you can review a rough draft is to check its contents for informational value. No matter how well organized it is or how many good transitions and active sentence structures are included, if your technical document doesn’t contain the appropriate information for its audience, it cannot fulfill its purpose. When reviewing a document for informational value, examine your document for the following issues:
Information is missing. For example, imagine that somebody wrote a technical report on "virtual communities" but never bothered to define what "virtual community" means. The reader would be utterly lost.
Information is there but is insufficient. Take the same example, and imagine that the writer only made a few vague statements about virtual communities. Readers (unless they are experts on virtual communities) likely need at least a paragraph on the subject, if not a comprehensive three- or four-page section.
Information is there but at the wrong level for the audience. Imagine that the report’s writer included a two-page explanation of virtual communities but focused on highly technical information and phrased it in language that only a sociologist (an “expert” academic audience) would understand, when the document was really intended for high school students. The writer failed to match the readers’ knowledge, background, and needs.
If you can get a sense of how information does or doesn't match your audience, you should be well on your way to knowing specifically what you need to do in order to revise.
Internal Organization
If you have the necessary and audience-appropriate information in a technical document, you’re on the right track to crafting a successful document. However, that information may still not be sufficiently organized. When writing and revising a document, consider these two aspects of internal organization—levels (or priority) of information and sequence (or order) of information—on both individual-paragraph and whole-document levels.
Levels of Information
Some paragraphs and sentences contain general information or broader statements about the topic being discussed. Others contain more specific information or go into greater depth. The first type forms a framework that supports the second, subordinate elements of the second type. When thinking about levels of information, envision how a paragraph’s or document’s organization would look in outline format. The broader claims and statements that shape the document would be in Level 1 and Level 2 headings, whereas the detailed evidence, reasoning, and support would appear in lower levels.
When you revise, check if the document’s framework is easy to follow. The most common and effective way to arrange general and specific information is to introduce the framework first, then follow it with specifics. This overarching pattern holds for sentences inside paragraphs and paragraphs inside longer documents, even if the paragraph or document uses a different sequence of information. Reverse outlining, or the practice of creating an outline based off of an already-written document, can also help you visualize the current structure and decide if it needs to change.
Sequence of Information
In addition to grouping information according to its levels, organization refers to the order information appears. This order or sequence is crucial to creating documents that make sense and achieve their purpose. As with a document's content, you will want to match a technical document's internal sequence of information to the document's audience, context, and purpose. Here are some examples of common informational sequences (some of these may be familiar to you from the organizational pattern tables in Chapter 6: Organization and Chapter 14: Oral Communication):
General → specific. Arrange information from general to specific. For example, listing categories of evidence is more general than defining examples of evidence specifically. This pattern is illustrated in Table 10.2.
Table 10.2. Revision with the general-to-specific organizational pattern.
Original Version | Revised Version |
---|---|
Making an argument from indirect evidence, also called circumstantial evidence, involves using evidence to make inferences, generally based upon probability, about the causes that led to a set of circumstances. Evidentiary arguments can be made from two categories of evidence, direct and indirect. | Evidentiary arguments can be made from two categories of evidence, direct and indirect. Making an argument from indirect evidence, also called circumstantial evidence, involves using evidence to make inferences, generally based upon probability, about the causes that led to a set of circumstances. |
Simple → complex. Begin with the simple and fundamental concepts, and then move on to the more complex and technical.
Thing-at-rest → thing-in-motion. Describe the thing "at rest" (as if in a photograph), then discuss its operation or process (as if in a video).
Spatial movement. Describe a pattern of physical movement; for example, top to bottom, left to right, or outside to inside.
Temporal movement. Describe events in relation to what happens first, second, and so on.
Concept → application of the concept/examples. Discuss a concept in general terms, then discuss the concept's application and/or examples of the concept.
Data → conclusions. Present data (observations, experimental data, survey results) then move on to the conclusions that can be drawn from that data. (This pattern is sometimes reversed: present the conclusion first and then the data that supports it.)
Problem/question → solution/answer. Introduce a problem or raise a question and then move on to the solution or answer.
Simplified version → detailed version. Discuss a simplified version of the thing, establish a solid understanding of it, then explain it all again, but this time providing the technical details. (This approach is especially useful for explaining technical matters to nonspecialists.)
Most important → least important. Begin with the most important, eye-catching, dramatic information and move on to information that is progressively less so. (This pattern can be reversed: you can build up to a climax, rather than start with it.)
Strongest → weakest. Start with the strongest argument for your position to get your audience’s attention, then move on to less and less strong ones. (This pattern can also be reversed: you can build up to your strongest arguments, but the weakest → strongest pattern is often less persuasive.)
The options above are some of many possibilities. Whichever sequence you choose, be consistent and avoid mixing these approaches randomly. For example, presenting some data, stating a few conclusions, and then switching back and forth between data and conclusions will confuse your reader.
Topic Sentences
A topic sentence is a sentence occurring at the beginning of a paragraph that informs the reader of the focus, purpose, and contents of that paragraph (and perhaps one or more paragraphs following). When used well, topic sentences focus the reader's attention and clarify the organizational structure of a document.
Often, when authors create technical documents, they don't consciously think about each paragraph’s contents and logic. Instead, many authors focus on getting words onto the page, and they figure out what they mean while they're writing. Sometimes the results can seem disjointed. Accordingly, authors should go back and insert topic sentences that can help readers understand where they are going, what's coming up next, where they've just been, and how what they are reading connects to the document as a whole.
Types of Topic Sentences
Different topic sentences achieve different purposes. Therefore, when drafting and revising, consider what you want each paragraph to accomplish for a reader. Use that information along with the examples below to determine which structure is ideal for a particular paragraph or section.
Keyword topic sentence. This type of topic sentence contains a keyword that hints about the content and organization of the upcoming material. Use one if your section (one or more paragraphs) discusses multiple similar things (for example, problems, solutions, causes, consequences, reasons, aspects, factors).
Example
Plagiarism can result in many unpleasant consequences. (This topic sentence indicates that the rest of the paragraph will then delineate these consequences.)
Overview topic sentence. This type of topic sentence names all the subtopics in the upcoming material. Use one if you want to specify all the subtopics you will address.
Example
Plagiarism may occur in any number of ways; however, the most prevalent forms are incorrect in-text citation of sources, failure to include quotation marks around exact wording taken from another source, and failure to include correct and complete works-cited entries for all sources used. (This topic sentence gives an overview of several common types of plagiarism. The rest of the paragraph will then describe each of these in detail and provide an example of each.)
Thesis-statement topic sentence. This type of topic sentence makes an assertion—an argument or claim—that the rest of the paragraph must support. Use one if your section proves a point and includes multiple supporting statements.
Example
Plagiarism has resulted in the demise of more than one writer’s professional credibility. (The topic sentence makes an argument that the rest of the paragraph will then develop and support.)
Topic definition. This type of topic sentence names the term being defined, identifies the class it belongs to, and describes its distinguishing characteristics. It must contain highly specific information. Use one if your section introduces an unfamiliar term.
Example
Self-plagiarism is a type of academic dishonesty that involves the reuse of a writer’s own work that was completed for another class. (This topic sentence names the term, identifies the larger category to which it belongs, and then describes it. The rest of the paragraph will go on to discuss this term and give a specific example to illustrate it.)
Topic mention. This type of topic sentence simply names or reminds the readers about the general subject at hand. It does not forecast what will be said about the subject. Use one to refocus a discussion after a digression or to pull back to the more general topic after you have narrowed the discussion to address specific details about one aspect of the topic. This type of topic sentence serves as a transition between paragraphs. It is often then followed by a second topic sentence that falls into one of the categories described above and focuses the content of the rest of the paragraph.
Example
As we’ve seen throughout this document, plagiarism is a serious concern for writers. (The rest of the paragraph would address plagiarism in some way, but not necessarily expand on it being a “serious concern.”)
No topic sentence. Sometimes (very rarely in technical and professional writing), you may not need or want a topic sentence. If your materials contain a story that leads to a point or are part of a popular science or technology writing project, a traditional topic sentence up front may be inappropriate.
In addition to clear topic sentences, another crucial way to ensure your sequence of information and your pattern of organization are clearly conveyed to your audience is to make sure you have exceptionally clear transitional sentences and phrases (see Chapter 6: Organization).
Mid-Level Revision and Editing
There is no clear border where higher-order structure-level revision ends and lower-order sentence-level editing begins, as both exist on a spectrum. As you work your way from revising to editing, you will find that recurring choices on the sentence level impact the overall content and structure of your document. While distinguishing structure-level revision and sentence-level editing is helpful, it is also helpful to recognize where they overlap in some specific concepts, rather than trying to categorize them solely into one level or another.
Paragraph Length
While there is no specific rule as to how long your paragraphs should be, in technical and professional writing you will more often rely on short, focused paragraphs as opposed to overly long ones. When determining paragraph length, consider the genre of your document, the content you are presenting, and how your reader will be interacting with any information you provide. This flexible approach will help you determine the “right” paragraph lengths for your document.
As you move from the structural level to the sentence level, check for paragraph breaks. A paragraph break is where one paragraph ends and a new one begins. Insert paragraph breaks where there is a shift in topic or subtopic, or a shift in the way a topic is being discussed.
Here are some suggestions for paragraph length:
- If your technical document needs a great deal of expository writing and will be printed in hard copy, you can probably use relatively long paragraphs. A single-spaced page full of text will probably contain one to four paragraph breaks.
- If your technical document does not require long blocks of text, consider breaking it up into very short paragraphs. Three sentences per paragraph is a widely accepted average.
- If your technical document will be posted online, use short paragraphs. People generally find it easier to read short paragraphs online than to read long paragraphs online.
When you are faced with particularly long blocks of text, think about breaking them up into smaller, distinct portions. This practice is sometimes referred to as chunking your information. Each “chunk” should include a specific and clear topic sentence, followed by 2–3 sentences that elaborate on that topic with more details and specificity. The next paragraph could take the idea into a next level of specificity, either by elaborating on one of the ideas or concepts presented in the latter part of the previous paragraph or introducing a consecutive idea at approximately the same level of specificity.
Transitions
As you transition from one paragraph to the next, you should clearly convey the relationships between the ideas in each paragraph. Just as topic sentences immediately clarify a paragraph’s subject for the reader, transitions help the reader understand how the arrangement of content reflects and/or amplifies the writer’s purpose. For the writer, transitions can also serve as a litmus test regarding the intuitiveness and fluidity of inter-paragraph transitions. In other words, the more difficult it is to articulate the relationship between two paragraphs’ content, the more likely the paragraph sequence needs to be rearranged. Ultimately, smooth transitions help writers frame content in terms of their purpose and facilitate readers’ comprehension (and even appreciation) of content.
Take Control of Your Tone
Does your writing or speech sound pleasant and agreeable, or simple and sophisticated? Conversely, does it come across as stuffy, formal, bloated, ironic, sarcastic, flowery, rude, or inconsiderate? Recognizing our own tone is not always easy, as we tend to read or listen from our own viewpoint and make allowances accordingly.
Once you have characterized your tone, you need to decide whether and how it can be improved. Figuring out how to make your voice match your intentions takes time and skill. One useful tip is to read your document out loud before you deliver it, just as you would practice a speech before you present it to an audience. Sometimes hearing your own words can reveal their tone, helping you decide whether it is correct or appropriate for the situation.
Another way you may learn to assess your own tone is to listen to or watch others’ presentations. Martin Luther King Jr. had one style, while former President Barack Obama has another. The writing in The Atlantic is more sophisticated than the simpler writing in USA Today, yet both are very successful with their respective audiences. What kind of tone is best for your intended audience?
Finally, seek out and be receptive to feedback from teachers, classmates, and coworkers. Don’t necessarily take the word of just one critic, but if several critics point to a speech as an example of pompous eloquence, and you don’t want to come across in your presentation as pompous, you may learn from that example what to avoid.
Define Your Terms
Even when you are careful to craft your message clearly and concisely, not everyone will understand every word you say or write. As an effective communicator, it is your responsibility to give your audience every advantage in understanding your meaning. However, your document or presentation would fall flat if you tried to define each and every term—you would end up sounding like a dictionary.
The solution is to be aware of any words you are using that may be unfamiliar to your audience. When you identify an unfamiliar word, your first decision is whether to use it or to substitute a more common, easily understood word. If you choose to use the unfamiliar word, then you need to decide how to convey its meaning to those in your audience who are not familiar with it. You may do this in a variety of ways. The most obvious, of course, is to state the meaning directly or to rephrase the term in different words, but you may also convey the meaning in the process of making and supporting your points. Another way is to give examples to illustrate each concept or use parallels from everyday life.
Overall, keep your audience in mind and imagine yourself in their place. This will help you to adjust your writing level and style to their needs, maximizing the likelihood that your message will be understood.
Be Results Oriented
Ultimately, the assignment has to be complete. It can be a challenge to balance the need for attention to detail with the need to arrive at the end product—and its due date. Stephen Covey suggests beginning with the end in mind as one strategy for success.[18] If you have done your preparation, know your assignment goal and desired results, have learned about your audience, and have tailored the message to the audience’s expectations, then you are well on your way to completing the task. No document or presentation is perfect, but the goal of perfection is worthy of your continued effort for improvement.
Therefore, it is crucial to know when further revision will not benefit the presentation or document. Work on knowing when to shift the focus to market testing, asking for feedback, or sharing a draft with a mentor or coworker for a quick review. Determining the balance between completion and revision while engaging in an activity that requires a high level of attention to detail can be a challenge for any communicator, but the key is to keep the end in mind.
Sentence-Level Editing
You've probably heard plenty of times that writing should be clear, direct, succinct, and active. This statement is one of those self-evident truths—why would anyone set out to write any other way? However, what does this advice really entail when we apply it? What do sentences that are not "clear” or "direct" look like? What sorts of things are wrong with them? How do you fix them?
Sentences can become redundant, wordy, unclear, indirect, passive, and just plain hard to understand while still remaining grammatically "correct." All their subjects and verbs agree, the commas are in the right places, and the words are spelled correctly. Still, these sentences are far more difficult to read than a sentence with a comma problem.
The following sections cover seven of the most common sentence-level problems and show you ways of fixing them. Knowing these seven things to watch for will enable you to spot others.
Repetitive Sentence Structures
As you read through your document, you may notice that your sentences, structurally speaking, look very similar. Perhaps you start three sentences in a row with the same word, or you are particularly fond of appositive phrases, or maybe your sentences are almost always over two lines long. While having a distinct style is not a bad thing, redundant phrasing can lead to reader fatigue or disinterest. You can address this issue by varying sentence structures. The basic sentence structure in English begins with the subject, or the primary actor of the sentence. Therefore, one way to insert sentence variety is to start sentences with something other than the subject, such as a verb, a phrase modifying the subject, or a prepositional phrase.
Another way to vary sentence structure is by using coordination by creating compound sentences. Compound sentences are made by joining two independent clauses with a comma and a coordinating conjunction such as “and.” If the two sentences are closely related, you may be able to omit the conjunction and join them with a semicolon instead.
A final way to increase sentence length is by using subordination. Where coordinating means to combine things on an equal level, subordinating means to put one item lower (or subordinate it) to another. When subordinating, use a subordinating conjunction such as “although,” “because,” “even though,” or “while.” Remember, a phrase that starts with one of these conjunctions becomes a dependent clause. This means that the clause can no longer function as a sentence on its own. It needs another independent clause to transform it into a complete sentence. If you begin a sentence with a subordinate conjunction, make sure you conclude its phrase with a comma.
Nominalizations
A nominalization is a verb that has been converted into a noun; look for -tion, -ment, -ance, and other suffixes. For example, "nominalization" is itself a nominalization; the root verb is "to nominate," with the suffix “-tion” appended. Another popular example is a gerund, or verbal noun. In English, these are made by adding “ing” to a verb and using it as a noun. Check your writing for sentences that use a nominalization as the sentence's subject and use "to be" as the main verb. The "to be" verbs are “am,” “is,” “are,” “was,” and “were.”
Sentences using nominalizations are frequently weak and indirect. Revise them by changing the nominalization into a verb and replacing the "to be" verb. Your sentences will become more active, and they will be easier for the reader to understand.
Sometimes, you can’t convert a nominalization into a main verb, or a nominalization needs to remain a sentence's subject. For example, “information” is a nominalization, but try converting “information” into a main verb. The sentence will be awkward, at best. Sometimes nominalization allows a list to retain parallelism. More often, though, you can convert a nominalization into a main verb.
The following examples in Table 10.3 demonstrate this problem and how to fix it. In each revised version, notice how a noun has been converted into the sentence's main verb and then used to replace the original "to be" main verb. This revision can occasionally slightly alter a sentence’s meaning, so be careful to make sure your new sentences accurately convey the information.
Table 10.3. Nominalizations to verbs.
Sentence with Nominalization in Bold | Revised Sentence |
---|---|
The playing of loud music early in the morning caused irritation to my neighbors. | Loud music played early in the morning irritates my neighbors. |
The permeation of the smell of onion in the kitchen was strong. | Onion smell strongly permeated the kitchen. |
At the outset, our intention was to locate algae samples. | We intended to locate five distinct algae samples. |
The project displayed an evolution from start to finish. | The project evolved over time. |
Noun Stacks
Noun stacks, as the name implies, occur when several nouns are placed in close proximity to each other. These long strings of nouns are notoriously difficult to understand.
Revise these sentences and “unstack” their long noun strings by separating them and transforming them into multiple verbs, clauses, and phrases.
The following examples in Table 10.4 demonstrate this problem and how to fix it. In each revised version, notice how a long string of nouns has been broken apart.
Table 10.4. Unstacking nouns.
Sentence with Noun Stacks | Revised Sentence |
---|---|
Recent young adult neurocognitive development research contains some exciting findings. | Recent research on the neurocognitive development of young adults contains some exciting findings. |
Position acquisition requirements are any combination of high school graduation and years of increasingly responsible secretarial experience. | To qualify for the position, you'll need to be a high school graduate and have had increasingly responsible secretarial experience. |
Rhetoric and composition theoretical frameworks and best pedagogical practices in hyflex learning environments will be analyzed. | Theoretical frameworks in rhetoric and composition will be analyzed, as well as the best pedagogical practices to apply in hyflex learning environments. |
Analysis of enthymeme application and omission of syllogism components is an effective education tool for argument composition and arrangement. | Analyzing how syllogistic components are applied and omitted in enthymemes is an effective learning tool for composing and arranging arguments. |
For more insight on the project, refer to the technical writing open electronic resource revision committee department report. | For more insight on the open electronic resource for technical writing, refer to the revision committee’s report to the department. |
Redundant Phrasing
Redundant phrasing refers to unnecessary repetition that occurs in close proximity. While some repetition can be useful, especially across paragraphs and documents, redundancies can clutter your writing. Common redundant phrases can come from these three main sources:
Wordy phrases. Look for four- to five-word phrases; you can usually chop them into a one- to two-word phrase without losing meaning. For example, “in view of the fact that” can be reduced to “since or “because.”
Obvious qualifiers. Look for a word that is implicit in the word it modifies. For example, phrases like “anticipate in advance,” “completely finish,” or “important essentials” are examples of obvious qualifiers.
Compound synonyms. Look for two or more compounded synonyms. These are two or more words that are indistinguishable in meaning and are placed close together. For example, “thoughts and ideas” (what's the difference?) or “actions and behavior” (if there is a difference between these two, does the writer mean to use it?) are common.
Table 10.5 presents some classic examples of wordy phrases and their revised versions.
Table 10.5. Revising wordy phrases.
Wordy Phrase | Revised Phrase |
---|---|
Due to the fact that | Since, because |
In view/light of the fact that | Since, because |
For the reason that | Since, because |
In my own personal opinion | I believe, in my opinion, I think |
Being of the opinion that | I/We believe |
It is recommended that | I/We recommend |
As per your request | As you requested |
In accordance with your request | As you requested |
Pursuant to your request | As you requested |
At this point in time | Now, then |
In this day and age | Now, currently |
In the near future | Soon |
During the time that | When |
Until such time as | Until |
To the fullest extent possible | Fully |
Predicated upon the fact that | Based on |
Insomuch as | Since, because |
In connection with | Related to |
Take cognizance of the fact that | Realize |
It has come to my attention that | I have learned that |
With reference to the fact that | Concerning, regarding, about |
With regard to | Concerning, regarding, about |
In close proximity to | Near, close |
In the neighborhood of | Near, close, approximately |
to the extent that | As much as |
It would be advisable to | Should, ought |
Has the ability to | Can |
That being the case | Therefore |
Four in number | Four |
Expletives
In grammar, an expletive is a word that serves a function but has no meaning. The most common expletive phrases in English are “it is/are” and “there is/are.” They are sometimes useful, but they are more often redundant and weaken a sentence's impact. If you can, delete them from technical documents.
Table 10.6 presents some examples of sentences with expletives and their revised versions without expletives.
Table 10.6. Removing expletives.
Original Sentence | Revised Sentence |
---|---|
When there are sparks emitting from the flint, you are close to making fire. | When sparks emit from the flint, you are close to making fire. |
When there is a dramatic dip in the stock market, there is a temptation for people to sell their stocks instead of buying more. | When the stock market dips dramatically, people are tempted to sell their stocks instead of buying more. |
Weak Use of Passive-Voice Verbs
One of the all-time worst offenders for creating unclear, wordy, indirect writing is the passive-voice construction. In simplified terms, the passive voice refers to a sentence construction where the direct object (rather than the actor) is the subject of the sentence. When you use this construction, you will need to use a prepositional phrase (and hence more words) to provide the main verb’s actor, if you choose to provide one at all. While this construction has its advantages, it can easily lead to ambiguity and wordiness.
To locate a sentence using the passive voice, look for a “to be” verb coupled with a past participle (a past-tense verb, often ending in -ed). Change it to an active verb, and rearrange the sentence to make grammatical sense. To review how to convert a sentence from active voice to passive voice, and back again, see Table 10.7.
Table 10.7. Passive to active voice.
Passive Voice | Active Voice |
---|---|
The study was completed in 2020 by three undergraduate students. | Three undergraduate students completed the study in 2020. |
The report was written by the student. | The student wrote the report. |
Sometimes a sentence in the passive voice conveys all the necessary information, as above in Table 10.7. However, the passive voice allows for the actor to be concealed, as Table 10.8 shows.
Table 10.8. Passive-voice concealment.
Passive Voice | What is Unclear | Active Voice |
---|---|---|
The papers will be graded according to the criteria stated in the syllabus. | Graded by whom? The instructor? An anonymous reviewer? A TA? | The teacher will grade the papers according to the criteria stated in the syllabus. |
The bill was passed last week. | Who passed the bill? | The state legislature unanimously passed the bill. |
The ability to conceal the actor or agent of the sentence makes the passive voice a favorite of people in authority—politicians, police officers, city officials, and teachers. Table 10.9 shows how the passive voice can cause wordiness, indirectness, and comprehension problems.
Table 10.9. Passive voice comprehension examples.
Passive Voice | Active Voice |
---|---|
The surveys were filled out over the course of three days. An overwhelming preference for cheaper textbooks was indicated. (Who filled out the surveys, and what does the indicating?) | Students filled out the surveys over a three-day period. Results indicate an overwhelming preference for cheaper textbooks. |
Most doctoral programs take five to seven years to complete. Between costs of living, tuition, and generally low stipends, it is difficult to avoid accumulating debt without significant financial aid. (Who completes these programs, and who is trying to avoid debt?) (Who makes the loans, and who can't pay them off?) | Most doctoral students complete their programs in five to seven years. Between costs of living, tuition, and generally low stipends, it is difficult for these students to avoid accumulating debt without significant financial aid. |
Recently, the number of cases is rising for opioid addictions in rural communities, as is indicated by recent studies in medical science. (What is rising and where, and what proves this?) | Recently, rural communities are seeing a rise in opioid addiction cases, as recent medical science studies indicate. |
Codes delineating appropriate forms of dress have long been enforced in public schools. The extent of this enforcement, however, is now called into question regarding facemasks. (Who enforces these codes, and who is now questioning them?) | Administrators have long enforced dress codes in public schools. Parents are now questioning administrators’ enforcement of facemask regulations, however. |
Once the fat from the bacon has been rendered, the chicken thighs need to be browned and the vegetables need to be added. Once the vegetables have been sautéed, cognac should be poured in and ignited. (Who is doing the browning, sautéing, pouring, etc.?) | Once you’ve rendered the bacon fat, brown the chicken thighs and add the vegetables. Once you’ve sautéed the vegetables, pour in the cognac and ignite it. |
The report for the incident was filed at 10:30pm. One suspect was apprehended, and one escaped after having fled the scene. (Who filed the report and apprehended the suspect?) (Who heated the solution, and who or what stirred it?) | Officer Oyeniyi filed the incident report at 10:30pm. He apprehended one suspect, but the other fled the scene. |
Note: All the above examples, regardless of voice, are grammatically correct sentences. Depending on the context, you may prefer to use the passive voice. Instructions and lab reports, as in the final two examples, are places where you may wish to obscure the actor in order to focus on the method.
While there are some risks to using passive construction, the passive voice is nevertheless a great option in certain circumstances. These circumstances include when
- The subject is obvious or too-often-repeated.
- The actor is unknown.
- The actor isn't important.
- You want to stress the action more than who did it.
- You need to rearrange words in a sentence for emphasis.
Subject/Verb Mismatches
In dense, highly technical writing, it’s easy to lose track of the real subject and pick a verb that does not make sense. The result is a noun physically unable to do what the verb says it is doing or an abstract thing performing a practical, real-world action.
When editing, make sure every sentence’s subject matches the main verb. Checking for a match can be difficult if the subject and main verb are far apart in the sentence. When this happens, pretend that the words between the subject and verb are gone. Does the verb still make sense with the subject? If so, your subject and verb match.
Table 10.10 provides some examples and their revisions.
Table 10.10. Subject-verb mismatch examples.
Problem Sentence | Revised Sentence |
---|---|
The reasons why you ignored the “Do Not Touch” sign got paint on your hand. | You ignored the “Do Not Touch” sign and you got paint on your hand. |
Fires tend to prefer dry weather, so it is important to take proper precautions. | Fires are more likely to happen in dry weather, so it is important to take proper precautions. |
Ultimately, hearts do much better when they regularly exercise and eat well. | Ultimately, people become heart-healthy when they regularly exercise and eat well. |
Commonly Confused Words
As with most languages, English contains many words that sound similar but that have different spellings and distinct meanings. Table 10.11 below identifies many commonly confused words and their correct usage.
Table 10.11. Commonly confused words in English.
Confused Words | Example 1 | Correct Usage for Example 1 | Example 2 | Correct Usage for Example 2 |
---|---|---|---|---|
accept or except | The office will _______ applications until 5 p.m. on the 31st. | accept (verb, meaning “to receive”) |
Attendance is required for all employees _______ supervisors. | except (preposition, used to show exemptions) |
affect or effect | To _______ the growth of plants, we can regulate the water supply. | affect (verb, meaning “to have an impact on”) | A lack of water has a predictable _______ on most plants. | effect (noun, meaning “the result of a change or impact” |
e.g. or i.e. | Please order 2,000 imprinted giveaways (_______, pens or coffee mugs). | e.g. (in Latin, exempli gratia, or “for example”; used to indicate multiple, general examples) | Charge them to my account (_______, account #98765). | i.e. (in Latin, id est, or “it/that is”; used to reference something specific) |
its or it’s | The department surpassed _______ previous sales record this quarter. | its (possessive form; shows ownership) | _______ my opinion that we reached peak oil in 2008. | it’s (contraction for “it is”) |
lay or lie | Please _______ the report on the desk. | lay (transitive verb, takes a direct object) | The doctor asked him to _______ down on the examination table. | lie (intransitive verb, does not take an object) |
pressurize or pressure | We need to _______ the liquid nitrogen tanks. | pressurize (verb, used for technology and things) | It might be possible to _______ him to resign. | pressure (verb, used for people) |
principle or principal | It’s the basic _________ of farming: no water, no food. | principle (noun, “rule guideline”) | The _______ reason for the trip is to attend the sales meeting. | principal (adjective, “first or primary”; noun, “head of a school (US)”) |
regardless or irregardless | _______ of what we do, gas prices are unlikely to go back down. | Regardless (adverb, “despite”) | _______ of your beliefs, please try to listen with an open mind. | Regardless (irregardless is not a standard word) |
than or then | This year’s losses were worse _______ last year’s. | than (conjunction or preposition, used for comparison) | If we can cut our costs, _______ it might be possible to break even. | then (adverb, used for time) |
that or which | There are several kinds of data _______ could be useful. | that (pronoun, used for essential clauses. Essential means that it could not be removed from the sentence without altering the meaning and grammar.) | Karen misplaced the report, _______ caused a delay in making a decision. | which (pronoun, used for non-essential clauses. The clause could be removed from the sentence without impacting the meaning of the noun “which” is modifying). |
there, they’re, or their | The report is _________, in the top file drawer.
__________ planning to attend the sales meeting in Pittsburgh. |
there (adverb, referring to place or position)
They’re (contraction, “they are”) |
__________ strategic advantage depends on a wide distribution network. | their (possessive plural adjective) |
to, two, or too | We went _____Tucson last week.
In fact, the _______ of you should make some customer visits together. |
to (preposition, indicates movement toward a place or thing)
Two (number, 2) |
After the sales meeting, you should visit customers in the Pittsburgh area _______, but try not to be _______ pushy with them. | too (adverb, (1) also; (2) more than advisable, as in “too fast”) |
disinterested or uninterested | He would be the best person to make a decision, since he isn’t biased and is relatively _______ in the outcome. | disinterested (adjective, impartial, does not have a stake in the matter or decision) | The sales manager tried to speak dynamically, but the sales reps were simply _______ in what he had to say. | uninterested (adjective, has not expressed interest) |
whose or who’s | __________ truck is that? | Whose (possessive pronoun, shows ownership) | __________ going to pay for the repairs? | Who’s (conjunction, “who is”) |
who or whom | __________ will go to the interview? | Who (nominative pronoun, used for subjects) | To __________ should we address the thank-you note? | whom (object pronoun; serves as the receiver of a thing or action) |
your or you’re | My office is bigger than _______ cubicle. | your (possessive pronoun, shows ownership) | _______ going to learn how to avoid making these common mistakes in English. | You’re (contraction, “you are”) |
upmost or utmost | The faculty lounge is on the ______ floor of the building. | upmost (the highest position) | This decision is of the ______ importance for our group. | utmost (most extreme or greatest) |
Readability, Sentence Lengths, and Sentence Structures
Highly technical subject matter easily lends itself to multiple long sentences with similar structures that can bore or confuse a reader. To address this common technical writing challenge, you will need to devote revision time to readability, or how easily your audience can comprehend your text. Improving readability involves careful attention to how you present your information in paragraphs and individual sentences.
Readability
The reader of a technical document needs to be able to extract information from it as easily as possible, so most technical documents are written at the U.S. 8th-grade level. The average sentence length should be about fifteen words.
When you revise, look for long sentences that contain lots of information. Break them into shorter, bite-sized chunks that contain single ideas, and run the resulting sentences through a readability checker. For example, MS Word has a built-in readability tool that will tell you the number of words per sentence and the Flesch-Kincaid model’s estimate of the text's grade level. Open your document in Microsoft Word, click File > Options > Proofing, check the “Show readability statistics” box, and run the spellchecker.
Sentence Lengths
The average sentence in a technical document should contain about 15 words, but you can use significantly longer or shorter sentences if necessary. Any sentence over 35 words most likely needs to be broken up. An occasional short sentence (say, five to ten words) can be effective, but too many of them at once can cause writing to be choppy and hard to follow.
Similarly, if the document contains a string of sentences that are close to the same length (for example, six sentences of exactly fifteen words each), the reader will fall into a rhythm and find it hard to pay attention. Break apart or combine sentences to create variety in their length. See Chapter 5: Writing Skills for more information about rhythm on the sentence level.
Sentence Structures
In English, there are four basic sentence structures:
- A simple sentence contains a single independent clause.
- A compound sentence contains two independent clauses.
- A complex sentence contains an independent clause and a dependent clause.
- A compound-complex sentence contains a compound sentence and at least one dependent clause.
Technical writing usually relies upon simple and compound sentences, and sometimes complex sentences. It very rarely uses compound-complex sentences. Look for these sentence structures and revise your technical document accordingly.
Also, as with sentence lengths, if all your sentences use the same grammatical structure, your reader will be lulled by the repetition and find it challenging to concentrate on the meaning. Break apart or combine sentences to create variety in their grammatical structure.
Table 10.12 presents some examples of overly long, complex sentences and their revised versions.
Table 10.12. Overly complex sentence examples and their readability scores.
Problem Sentence | Revised Sentence |
---|---|
Before we can begin recommending specific classroom practices that help traditional first-year students cultivate the skills they will need to produce effective academic writing, it is important to examine and synthesize recent research in young adult neurocognitive development.
Length: 38 words |
We need to start by reviewing recent research in young adult neurocognitive development. After that, we can recommend specific classroom practices that help traditional first-year students write academically.
Average Length: 14 words |
The typical young adult neurocognitive profile, which is largely characterized by an increasing awareness of environmental factors and how they shape individual perceptions and behavior, presents a particularly valuable opportunity for college composition instructors to engage their students through experiential learning and critical dialogue exercises.
Length: 45 words |
The typical young adult neurocognitive profile is largely characterized by an increasing awareness of environmental factors and how they shape individual perceptions and behavior. This awareness presents a particularly valuable opportunity for college composition instructors. Specifically, instructors can engage with their students by using experiential learning and critical dialogue exercises.
Average Length: 16.6 words |
Note: Readability scores and grade levels are those determined by Microsoft Word’s readability statistics.
This text was derived from
McMurrey, David and Jonathan Arnett, “Power-Revision Techniques,” in Reardon, Tiffani, Tamara Powell, Jonathan Arnett, Monique Logan, and Cassandra Race, with contributors David McMurrey, Steve Miller, Cherie Miller, Megan Gibbs, Jennifer Nguyen, James Monroe, and Lance Linimon. Open Technical Communication. 4th Edition. Athens, GA: Affordable Learning Georgia, n.d. https://web.archive.org/web/20220521190055/https://alg.manifoldapp.org/projects/open-tc. Licensed under a Creative Commons Attribution 4.0 International License.
University of Minnesota. Business Communication for Success. Minneapolis: University of Minnesota Libraries Publishing, 2015. https://web.archive.org/web/20240318113353/https://open.lib.umn.edu/businesscommunication/. Licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
Since revision and editing often occur at the same point in the writing process, the two terms are frequently used interchangeably. However, revision and editing are different in scale and purpose from one another. It is important to understand these differences, since they will help you develop a more efficient process for refining your drafts.
Revision refers to higher-order concerns (such as purpose, content, and structure) when making changes. For example, it is common for writers working on a first draft to arrive at their point most clearly at a paragraph's end, since the act of writing helps us to organize our thoughts. However, it is much more helpful for the reader to see the point clearly at the very beginning, so the writer might revise this paragraph by putting the last sentence first and making adjustments. The writer might also find that they need to spend more time explaining a particular point, or that a paragraph should be taken out because it is either off-topic or too similar in content to another.
Editing, by contrast, refers to lower-order concerns (such as grammar, word choice, and syntax) when making changes. The focus of editing is not to substantially alter a document but rather to make sure its presentation is more polished. Too many grammatical or syntactical errors, such as misspellings or sentence fragments, can make it harder for the reader to absorb content. They can even undermine the reader’s assessment of the writer’s expertise.
In addition to revision-based higher-order concerns and editing-based lower-order concerns, there are mid-level concerns that exist between pure revision and pure editing. Isolating these concepts from the previous two categories emphasizes how choices at the sentence level accumulate to impact a document’s overall content and structure, such as paragraph length and tone.
As you may have guessed, higher-order revision concerns usually entail much more work than the others and should come first. This is because revision is essential to ensuring that a draft is composed and structured effectively, so that it fulfills its intended purpose and caters to audiences’ expectations. There is also little point in checking for comma placement in a paragraph that might be removed from or rearranged in the final draft.
Revising to Enhance Readability
Anything that you write is designed to be read. That is its first and foremost purpose. Thus, increasing readability means increasing the functionality of your document in terms of both content and document design, thereby making it “user friendly.” If your document is difficult to read because the vocabulary, sentence structure, paragraphing, organization, or formatting is unclear, your reader will likely stop reading.
The revision checklist in Table 10.1 offers a step-by-step process for revising your document to achieve a readable style. It incorporates key information from Chapter 2: Rhetorical Situation, Chapter 6: Organization, and Chapter 7: Design. Implementing this checklist means doing several “passes” or individual reviews over your document, looking at different aspects each time. Typically, you will start with higher-order concerns and progress to smaller, more detail-oriented issues. For example, in your “first pass,” review the entire document for structural elements such as overall formatting, content requirements, organizational patterns, and coherent flow of information. Once you have addressed these concerns, your “second pass” might focus on your use of topic sentences and individual paragraph organization. The checklist below is intended as a brief overview of things to watch for, but the items in the list are not all of equal importance, and some items needing revision may become apparent during multiple steps in the process. The information in the later “Revision Techniques” section of this chapter will help you identify concepts across the spectrum of structure-level revision and sentence-level editing that you should keep in mind.
Table 10.1. Revision checklist.
Revision Checklist | |
---|---|
First Pass: Document-level review (structural-level revision) |
|
Second Pass: Paragraph-level review (mid-level revision and editing) |
|
Third Pass: Sentence-level review (sentence-level editing, part 1) |
|
Fourth Pass: Word-level review (sentence-level editing, part 2) |
|
If your document incorporates sources, you will want to do an additional “pass” to make sure that all sources are cited properly and that they all appear in your list of References or Works Cited at the end of the document. You also should make sure all sources in your list of References or Works Cited are used and appropriately cited/referenced within the body text. See Chapter 12: Avoiding Plagiarism and Citing Sources Properly for details.
This text was derived from
Last, Suzan, with contributors Candice Neveu and Monika Smith. Technical Writing Essentials: Introduction to Professional Communications in Technical Fields. Victoria, BC: University of Victoria, 2019. https://pressbooks.bccampus.ca/technicalwriting/. Licensed under a Creative Commons Attribution 4.0 International License.