Get AI summaries of any video or article — Sign up free
How to edit other people's content without pissing them off - Ingrid Towey thumbnail

How to edit other people's content without pissing them off - Ingrid Towey

Write the Docs·
5 min read

Based on Write the Docs's video on YouTube. If you like this content, support the original creators by watching, liking and subscribing to their content.

TL;DR

Align edits with the customer’s goals, not internal preferences, because readers scan and leave quickly when answers aren’t easy to find.

Briefing

Editing other people’s documentation without triggering defensiveness comes down to one practical shift: treat edits as customer-focused improvements made in partnership, not as corrections delivered from above. Ingrid Towey, a senior technical editor and writer at Red Hat, frames the goal as keeping writers “happy” with the outcome—because trust and diplomacy determine whether feedback lands as help or as insult.

Towey ties that approach to a long detour from her earlier career as a technical writer and usability specialist in the early 1990s. After homeschooling her children for 15 years, she found she became a better writer and editor than before—largely because teaching writing forced her to be both effective and tactful. You can’t “throw edits over the wall” and hope they work; learners need context, patience, and guidance that respects their intent. From that experience, she crystallizes four principles for editing and peer review.

First, everyone is on the same side: the customer side. Instead of debating internal preferences, editors should align with what readers need to accomplish. Towey emphasizes how modern online readers behave—often scanning rather than reading. She cites research suggesting users may have only seconds before leaving, form an opinion in about 50 milliseconds, and read roughly 28% of a page. The implication is blunt: documentation must surface answers quickly and help readers find what they need. She also illustrates how audience understanding can overturn assumptions. A diagram designer animated a systems diagram to make it engaging, and many internal stakeholders loved it—until usability testing with systems administrators showed they wanted the whole picture at once, because they think model-first.

Second, editing is not an edict. Edits should be collaborative and reversible, not a power play. Towey argues that editors don’t need to fix every comma or impose every stylistic preference; the job is to improve usefulness. She also warns against making changes that can introduce technical errors—especially when editors lack domain knowledge.

Third, explain why the edit was made. Towey recommends backing up changes with objective authorities and evidence: readability tests (like Flesch-Kincaid grade level and Flesch Reading Ease), usability testing, and established writing standards. She walks through a real example where a dense, technical paragraph scored at a grade level around 24.7 and was rewritten into bullet-based, shorter sentences, improving readability to a grade-level score around 9.3.

Fourth, get help. Editing doesn’t have to be a solo act; peer review groups, co-op support, and structured meetings can distribute expertise and reduce blind spots. Towey offers meeting guidelines: focus on a few high-impact areas (like headings and customer focus), agree on writing principles in advance, use kind feedback (often framed as “positive feedback first”), appoint a meeting leader to prevent domination, and ensure quieter participants are heard. Ultimately, the edits that stick are the ones built on relationships—writers trust editors who show care, competence, and positive intent, and that trust makes feedback easier to accept and act on.

Cornell Notes

In technical editing, the fastest path to “edits that don’t piss people off” is to treat feedback as customer-centered collaboration. Ingrid Towey’s four principles are: (1) align with the customer side, (2) make edits instead of issuing commands, (3) explain the rationale behind changes using evidence like readability tests and usability testing, and (4) get help through peer review and structured group editing. She supports the customer-first approach with online-reading research showing users scan quickly and may leave within seconds. She also demonstrates how rewriting for clarity and structure can dramatically improve readability scores. The practical takeaway: trust, transparency, and measurable usefulness turn editing into a shared effort rather than a confrontation.

How does “customer side” change what an editor should prioritize during peer review?

It shifts the focus from internal preferences to reader outcomes. Towey argues that editors should assume readers are trying to complete tasks, not absorb documentation for its own sake. She cites online behavior research: users may have only seconds before leaving, form an opinion extremely quickly (about 50 milliseconds), and read only a fraction of a page (around 28%). That means headings, structure, and answer-finding matter more than polishing every detail. Her example: an animated systems diagram delighted many internal stakeholders, but systems administrators hated it because they wanted the whole picture at once—model-based thinkers need global context, not step-by-step animation.

What does “edit not edict” look like in practice, beyond tone?

It means treating edits as reversible improvements rather than commands. Towey emphasizes that editors don’t need to fix every comma or impose every stylistic preference; the goal is usefulness for the reader. She also warns against making changes that can break technical accuracy—especially when the editor lacks domain knowledge. Her broader point is that editing should be a collaborative conversation, not a tennis match between writers and editors.

Why does explaining the “why” matter, and what kinds of evidence can support it?

Explaining the rationale prevents edits from feeling arbitrary and helps writers learn the underlying decision logic. Towey recommends using objective authorities: readability tests (Flesch-Kincaid grade level and Flesch Reading Ease), usability testing, and established writing standards. She gives a concrete before/after: a dense paragraph scored around a grade level of 24.7, then was rewritten into clearer, bullet-based sentences with a readability grade level around 9.3 and a much better ease score. The evidence makes the edit defensible rather than personal.

What’s the role of usability testing when editing documentation?

Usability testing validates whether content structure matches how real readers think and work. Towey’s diagram example shows how testing can overturn “obvious” improvements: animation may feel modern and engaging, but if the audience needs to load the full model at once, animation can slow comprehension. She also suggests simple testing approaches—having someone try to follow instructions while reading—then using results to guide edits.

How can peer review meetings be structured so they improve writing without derailing into nitpicks?

Towey recommends scheduling group editing with clear rules: agree in advance on a small set of focus areas (e.g., headings and customer focus), set writing principles before the meeting, and avoid getting sidetracked by low-impact details like comma-level issues. Use kind feedback (positive feedback first, then negatives, then positives) to keep writers receptive. Appoint a meeting leader to manage time and prevent domination, and make sure quieter participants are invited in—sometimes the best insight comes from the least vocal person.

What’s the relationship between trust and edit acceptance?

Trust determines whether writers experience edits as help. Towey argues that writers need to believe the editor cares about them, has something useful to contribute, and understands the material. She connects this to her homeschooling experience: relationships were the foundation for learning and feedback. In professional editing, the same dynamic holds—assume positive intent, care about the person, and feedback becomes easier to absorb and act on.

Review Questions

  1. Which reader behaviors (speed, scanning, partial-page reading) should influence your editing priorities, and how would you change headings or structure accordingly?
  2. Pick one edit you’ve made recently. What objective evidence (readability test, usability observation, or style standard) could you cite to explain the “why” to the writer?
  3. How would you design a peer review meeting agenda that focuses on high-impact issues while preventing comma-level nitpicking and dominance by a single participant?

Key Points

  1. 1

    Align edits with the customer’s goals, not internal preferences, because readers scan and leave quickly when answers aren’t easy to find.

  2. 2

    Treat editing as collaboration: make changes reversible and avoid fixing everything just because a preference is available.

  3. 3

    Explain the rationale behind edits using objective evidence such as readability tests (Flesch-Kincaid, Flesch Reading Ease) and usability testing results.

  4. 4

    Use audience understanding to validate design choices; features that delight some stakeholders can fail with the actual end users.

  5. 5

    Get help through peer review groups and structured meetings rather than editing in isolation, especially when domain knowledge varies.

  6. 6

    Run peer review with clear focus areas, agreed writing principles, kind feedback, and a meeting leader to keep discussion productive.

  7. 7

    Build trust by demonstrating competence, care, and positive intent—writers accept feedback more readily when relationships are strong.

Highlights

Online readers may leave within seconds, form opinions in about 50 milliseconds, and read only a portion of a page—so documentation must be structured for scanning and fast answer-finding.
A diagram animation that impressed many internal teams still failed usability testing with systems administrators, showing that audience thinking patterns can outweigh “cool” design ideas.
Readability scoring can quantify the impact of rewriting: Towey’s example improved a dense paragraph from a grade-level score around 24.7 to about 9.3 by restructuring and using bullets.
Editing works best when it’s reversible, evidence-backed, and delivered with explanation—turning feedback from personal preference into shared problem-solving.
Peer review meetings should focus on a few high-impact areas (like headings and customer focus), use kind feedback, and include quieter voices to surface the best insights.

Topics

  • Technical Editing
  • Customer Focus
  • Peer Review
  • Readability Testing
  • Usability Testing

Mentioned

  • Ingrid Towey
  • UX
  • VM
  • API
  • OpenShift
  • OpenStack
  • Flesch-Kincaid