Lecture Notes: Review & Revision


Video | Introduction | Professional vs. Academic Revision | Common Revision Mistakes | Revision Process | Conclusion | Sources

In “Revision in Professional Reports,” Dr. Whitney Kosters explains why professional reports get revised for structure even when nothing feels wrong, and how to read a draft the way its users will.


Introduction

Revision is the stage of writing where you take a complete draft and rework its structure, organization, and emphasis so the people using the report can find and understand what they need.

“The Writing Timeline” in the Mayfield Handbook of Technical & Scientific Writing describes it as re-seeing the writing, a larger task than correcting grammar or changing a few words. Revision changes where information sits, what each section is for, and how claims connect to evidence.

In our Tech Writing Process, revision is Step 6, Review & Revise. It comes after you have written the draft (Step 4) and integrated the tables, charts, and diagrams (Step 5), because only then can you see how the text and the data work together. A draft usually follows the order in which you worked things out, and readers need a different order. A report that skips this step can look finished and still be hard to use, since its meaning may only come through for someone who reads every page in sequence.

In practice: Reports keep circulating after they leave the writer’s hands. People summarize them, quote them, and pull them back out months later when someone questions a decision. Revision prepares the report for that second life.


Professional Revision vs. Academic Revision

Professional revision starts from a different question than academic revision.

In school, revision often means fixing mistakes once the main writing is done, and the question is whether the writing is good. At work, other people rely on the report, so revision is built into the schedule and the question is whether the report will do its job for the person using it. No one expects a first draft to be ready for use.

Answering that question means reading the draft as its user: someone looking for one answer, possibly starting partway through, with limited time. A paragraph can be well written and still fail that reader, so instead of asking “Is this paragraph well written?”, ask “Could someone who started reading here follow it?”

This is also why the work starts with structure. Sentence-level revision improves grammar, phrasing, and transitions, but it does not show whether a reader can find what matters. Section 1.9 of the Mayfield Handbook, “Revising Content,” advises revising content before editing for style, usage, grammar, and mechanics, because structural changes can undo sentences you have already polished. The revision checklist in Chapter 10 of Technical and Professional Communication (Table 10.1) follows the same logic by working in passes: document, then paragraph, then sentence, then word. The writer already knows the report’s content, which makes it hard to see where a new reader would get lost, so the big picture comes first and the sentences last.


Common Tech Writing Revision Mistakes

Revision tends to go wrong in a few recognizable ways.

  • Revising only when something feels wrong. In academic writing, writers often revise based off how the text feels. On the other hand, professional reports required detailed revision even when nothing seems broken. Revision within the technical writing process seeks to identify problems ahead of time, instead of reacting to problems after the report goes out.
  • Assuming “it’s in there somewhere” is enough. The burden of accuracy is higher with professional and technical writing than it is for academic writing. For that reason, a thorough revision process should verify that key information and data is included, rather than assuming the information has been included. This becomes even more important when reports and other products are prepared by multiple writers.
  • Rearranging content without clarifying purpose first. A good chunk of the tech writing revision process is figuring out the work each part of the text is doing. Rearranging content without first nailing down this higher level organizational scheme can make for a lengthy revision process, and may even decrease the quality of the report.

Revision Process

The revision process has four steps:

  1. Revise findings to explain patterns. Findings should work together to explain patterns and to tell a story, not just present data.
  2. Rewrite headings to communicate meaning. Headings should provide detailed info about the content of that section, not be vague or boilerplate terms which don’t help readers find what they need.
  3. Test whether the report survives skimming and partial reading. Revise so that the report works when skimmed, excerpted, or read by someone who did help put it together.
  4. Align claims, evidence, and limitations. The text is organized so evidence and limitations are presented in close proximity to claims.

1. Revise Findings to Explain Patterns

A finding states what the information shows, not only the information itself. Take a draft that reports “14 incidents at the north dock, 3 at the east dock, and 2 at the south dock.” Revising it means opening with the pattern, as in “Incidents are concentrated at the north dock, which accounts for 14 of 19,” and following with the evidence. The numbers are the same, but the reader no longer has to add them up. Section II of the University of Utah ECE’s CLEAR “Conclusions” handout recommends the same move: state the most important finding first, then explain each finding in more detail. Overlapping findings get combined and minor observations get cut, so the main finding is not competing with them for attention. Readers turn to the findings to learn what is happening, and a quick test is whether someone who reads only the findings still understands the situation.

The same thinking applies to the report’s sections. Write one sentence for each section that says what it explains: where incidents occur most often, how the pattern changed over time, what limits the conclusions. If you cannot write that sentence, the section does not yet have a clear job. The “additional general comments” in Michigan Tech’s “A Brief Introduction to the Technical Memo Report” say topic sentences should form an outline of the report, so the sentences you write can be checked against the topic sentences already in the draft.

In practice: Cutting minor findings can feel like losing work. When someone reopens a report months later to check one decision, though, they go to the section they expect to hold the answer, and that section needs to cover it.

2. Rewrite Headings to Communicate Meaning

A heading can name a topic or state what its section establishes. A topic-only heading leaves the reader to guess the section’s conclusion, so revising means rewriting headings to state the point: “Incident Locations” becomes “Most Incidents Occur at the North Loading Dock.” Read together, the headings then show the report’s logic to someone who is only scanning. Section 4.4 of Open Technical Communication, “Headings,” makes a similar case by recommending specific headings such as “Physics of Fiber Optics” over generic ones such as “Technical Information.” The “Types of headings” section of plainlanguage.gov’s “Add Useful Headings” adds that headings like “General,” “Application,” and “Scope” are vague enough to confuse readers. Readers use headings to decide where to go next, so a heading that holds back the point slows down anyone who is scanning.

Headings can be written as statements or as questions, and the guidance differs. “Most Incidents Occur at the North Loading Dock” is a statement heading, and the “Front-load headings” section of the UK Readability Guidelines prefers this form, with the key information at the start. “Where Do Most Incidents Occur?” is a question heading, which plainlanguage.gov’s “Add Useful Headings” ranks above statement headings because it mirrors what the reader is asking. Try both on your own headings and choose the one that works best for your readers and your report.

In practice: Many professional readers decide whether to read a section from its heading alone. Someone scanning a report for the cause of a delay will skip a section titled “Analysis” and stop at one titled “Supplier Delays Caused Most Missed Deadlines.”

3. Test Whether the Report Survives Skimming and Partial Reading

Readers do not take in a report the way the writer wrote it. They skim, jump to one section, paste a paragraph into an email, or see a single chart on a slide. Revising for this means checking the report in the same pieces it will be used in, and then confirming the result with people who did not write it. The writer controls only the first reading, and every reading after that happens without the writer there to explain.

Start with the skim. Read only the executive summary, the headings and subheadings, the visuals, and the first sentence of each major section. If those pieces do not show what the report is about and what it establishes, the structure needs revision. This is a realistic test: the “Conclusions” section of the University of Sheffield’s “The Anatomy of a Technical Report” notes that readers of technical reports often skip straight to the conclusion, and Chapter 1 of Ginny Redish’s Letting Go of the Words (“Web users skim and scan”) reports that readers skim and scan before they read. Mark Baker’s Every Page is Page One takes the idea a step further, arguing that each topic should establish its own context because readers may arrive from anywhere (see “EPPO Topics” in the TechWhirl LavaCon summary).

Next, pull out single sections and visuals and ask whether each one still makes sense alone. A section that opens “As discussed above, this rate is concerning” falls apart when excerpted, so the revised opening restates the rate and why it is a concern. The same applies to the executive summary, which many readers will treat as the whole report.

Finally, give the draft to real readers, which is the feedback half of Step 6. Watch where they misread or get stuck, revise those spots, and test again. Writers cannot fully read their own work as a stranger would, and outside readers find the gaps that the writer’s knowledge fills in without notice. Section 1.11 of the Mayfield Handbook, “Reviewing a Document,” lists the reviews most technical documents go through: peer, technical, editorial, and managerial. For how to run the test, plainlanguage.gov’s “Test” guideline recommends paraphrase testing for short documents, where readers explain the document in their own words, and usability testing for longer ones, where readers try to find and use information, with at least two rounds planned.

In practice: A report can contain everything it needs and still fail, because the only reader who would find it all is one who reads every page in order.

4. Align Claims, Evidence, and Limitations

A claim is useful to the extent that the reader can find the evidence and limits that go with it. This step revises the report so each claim sits near its support and near whatever qualifies it. Step 1 shapes the findings themselves; this step connects the report’s claims and limitations to those findings. Three adjustments do the work: reorder the report so the claim comes before the work that led to it, check that each visual is current and explained, and move each limitation next to the claim it affects.

Drafts tend to follow the order in which the writer found things out, so a draft may walk through the work step by step and save the conclusion for the end. The revision states the conclusion first and uses the work as support. George Mason University’s “Writing Business Memos” recommends this under “Present the main point first,” placing supporting details after the main point. Chapter 2 of Wolfe and Reineke’s Writing with Focus, Clarity, and Precision (Bedford, 2025; paywalled), “Emphasizing the Bottom Line,” also covers when not to put the bottom line first.

Visuals count as evidence, and they often get added during drafting and not looked at again. For each one, ask what question it answers, what pattern the reader should notice, whether the nearby text explains that pattern, and whether it still matches the revised report. A chart of incidents by month may have no sentence saying incidents rose after the shift change, so the revision adds that sentence just before the chart. A chart built from an early draft may still show 21 incidents after the data was cleaned to 19, so the revision updates it to match the text. Memorial University’s “Using Figures and Tables” (“Guidelines for referring to visuals within the text”) supports the first fix by saying the introducing text should describe what readers are meant to notice, and that a figure should not appear before the text that refers to it. UT Austin Chemical Engineering’s “How do I create figures and tables?” adds that each illustration belongs as close as possible to its explanation.

Limitations need the same attention. Check whether the wording or placement of a claim could lead readers to more confidence than the evidence supports, and revise so the stated certainty matches the evidence. “The new procedure reduced errors” becomes “The new procedure reduced errors during the two-week pilot; results for full-year operation are not yet available.” The “Structure” section of the Tec de Monterrey Writing Center’s “Technical Report” guide says to declare limitations before making suggestions or proposals. Section 12.10 of the Engineering LibreTexts orientation text, “Communicating Uncertainty and Limitations,” goes further and calls leaving out a known limitation misleading communication, and the discussion-section guidance in Illinois Physics’ “How to Write a Technical Report” asks writers to state assumptions explicitly and discuss limitations honestly.

In practice: Charts get dropped into slide decks and emails, and a chart whose meaning lives in a paragraph three pages away loses that meaning when it is shared. Readers also act on the confidence a report projects. If confident claims come early and limits come late, some readers will not reach the limits. A report can be accurate in every sentence and still mislead through the order it presents things in, which makes the placement of limitations an ethical question as well as an organizational one.


Conclusion

Professional revision prepares a report for use.

It starts by reading the draft as the people who will rely on it, and it works on structure before sentences. The four steps address situations the report will meet: findings that explain what the data shows, headings that carry meaning for a reader who is scanning, a structure that holds up when skimmed or excerpted, and claims that stay connected to their evidence and limitations. Revision comes at Step 6 of our process, after you have analyzed, researched, structured, written, and integrated data and graphics, so it is also where you check the draft against the audience and purpose you identified at the start and collect feedback from readers. A report leaves the writer’s hands and gets used by people who may never speak with the writer, and revision is how the writer takes responsibility for what those readers will find. Revision is not about perfection; it is about accountability for what the report says.


Sources & Further Reading

Everything referenced above, if you want to go to the originals.