Get AI summaries of any video or article — Sign up free
Dennis Dawson - Graphic Relief: Beyond Flowcharts and Screenshots thumbnail

Dennis Dawson - Graphic Relief: Beyond Flowcharts and Screenshots

Write the Docs·
6 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

Write documentation for the reader’s job, not the author’s completeness—people want “just enough” to act.

Briefing

Documentation fails most often when it’s written for the author’s convenience, not the reader’s job. Dennis Dawson’s core finding is that technical docs become usable—and measurably more effective—when they’re reorganized around navigation, “decision layers,” and modular, runnable learning paths, then validated through task-based testing rather than praise.

Dawson’s turnaround story starts with a new role at Ripple, where existing documentation was thorough but dense: long walls of text, too many links, and no clear “just enough” path for beginners. He stopped trying to read everything and instead learned by using the software with sample code and engineer support. From that experience, he built a habit of capturing what he learned in digestible form and sharing it with newcomers—then iterating based on feedback. The next hurdle was visual: users liked his drawings, but corporate style concerns threatened to erase them. Working with designers Ellen Yang and Natalya Sabari, he translated his whimsical, metaphor-driven illustrations into a reusable “neon” graphic system that still followed corporate color guidelines.

The transformations he implemented over the following year were guided by conference lessons on layered thinking (especially the missing “decision layer”), and by multimedia learning research from Richard Mayer’s book Multimedia Learning, which gave him both vocabulary and scientific justification for changing visuals. The practical changes were concrete: navigation cards on main and sectional landing pages; a new introduction that explains high-level concepts without drowning readers in detail; more whitespace and scan-friendly layouts; and consistent, metaphorical illustrations that help readers grasp concepts at a glance.

Crucially, Dawson restructured tutorials to reduce context switching. Earlier tutorials mixed conceptual explanations with development tasks, forcing readers to jump between “user hat” and “developer hat” every paragraph. He compared this to a painful interface where form design and programming logic were constantly interleaved—an experience that caused real headaches and ultimately led to a redesign. His solution borrowed from how O’Reilly-style developer books work: modular lessons that build sequentially but can be started anywhere, with isolated user interface from business logic. That modularity lets developers copy self-contained best practices and methods directly into their own applications.

For videos, he recommends demos that clarify background processes through animation and inline commentary, while avoiding “typing then running code” as a dull default. He also revises flowcharts so sections are visually self-contained—using builds (like slideshow-style stepwise reveals) so readers don’t scroll back and forth between distant explanations.

Finally, Dawson treats testing as an evidence engine. He describes three tiers: informal co-worker review, external task-based feedback, and—when possible—bringing in a testing consultant to run structured usability sessions. The goal isn’t compliments; it’s watching people struggle with real tasks without excessive hints. One participant’s failure to find a key navigation element (“spin the triangle”) pinpointed an interface problem, while other criticisms validated that the new graphics and video direction were landing.

Across the talk, Dawson’s advice is blunt: write for skimmers and doers, simplify language, justify parameter choices with rationale, avoid jargon and “fishing” for understanding, and treat documentation as never-finished—shipped, then improved. The result is documentation that looks friendlier, reads faster, and performs better under real use.

Cornell Notes

Dennis Dawson’s documentation overhaul centers on one principle: readers want “just enough” information to complete their jobs, not exhaustive walls of text. After learning the hard way at Ripple—where dense docs were hard to parse—he reorganized content around navigation cards, high-level introductions, scan-friendly whitespace, and consistent metaphorical graphics. He also redesigned tutorials to eliminate context switching by separating UI from business logic and using modular, runnable lessons that developers can copy and adapt. To prove the changes worked, he relied on task-based testing (including external reviewers and, when possible, professional usability consultants) rather than only collecting positive feedback. The approach matters because it turns documentation from a static reference into a decision-support system that improves real outcomes.

Why did Dawson treat “dense documentation” as a usability failure rather than a writing-quality issue?

He found that even thorough docs can become functionally unusable when they don’t match how people learn and act. At Ripple, the existing material was dense, link-heavy, and hard to parse—so he repeatedly asked himself why information was being presented before it was needed. His workaround—using the software with sample code and engineer support—showed that users only absorb what they need at the moment. That experience led to reorganization: clearer navigation, lighter touch, and “decision layer” content that helps readers choose what to do next without forcing them to read everything first.

What does Dawson mean by a “decision layer,” and how did he implement it in docs?

The “decision layer” is the part that helps readers decide which path to take and what level of detail they should pursue. Dawson credits conference guidance (Ryan Young’s layered thinking) for crystallizing what was missing. In practice, he added use cases that describe practical steps to implement features, and he placed a “do you want to know more” link at the end of every paragraph. The text provides the gist so readers can decide whether to go deeper, instead of burying decisions inside long explanations.

How did Dawson redesign tutorials to reduce context switching, and what problem was he trying to prevent?

Earlier tutorials mixed conceptual descriptions with development tasks, forcing readers to alternate constantly between “user hat” and “developer hat.” Dawson compared this to a real product experience at Claris (Smart Form Designer) where form design and programming logic were constantly interleaved, causing headaches and leading to a redesign. His tutorial redesign separates concerns: modular lessons build on each other but can be started anywhere, and the UI is isolated from business logic. Developers can copy self-contained best-practice methods directly into their own applications without needing to rewrite or untangle intertwined steps.

What’s Dawson’s approach to graphics and flowcharts so they don’t require long, scrolling explanations?

He treats graphics as scan-first tools that should communicate at a glance. Even when flowcharts are accurate, they can fail if each section requires a long paragraph elsewhere. Dawson revised topics by building charts one section at a time, keeping text close to the relevant part of the diagram. He also uses builds (slideshow-like stepwise reveals) so readers can follow the structure without jumping between distant explanations. His illustration system is metaphorical and consistent, helping readers build familiarity as they progress.

How does Dawson recommend testing documentation, and what makes task-based testing different from collecting feedback?

He outlines three levels: informal reviews by co-workers, sharing with people outside the organization, and—when budget allows—bringing in a testing consultant. The key difference is that testers must perform real tasks, not just read. Dawson warns against leading questions and against rescuing participants when they get stuck. In his experience, this approach produces objective evidence: for example, a participant’s failure to find a prominent navigation element (“spin the triangle”) revealed a concrete UI problem, not just a vague impression.

What tools and production workflow does Dawson describe for creating docs, graphics, and videos?

For drafting graphs, he starts in Google Docs for easy collaboration and comments with engineers and product managers, then converts to markdown for review via GitHub pull requests. For design collaboration, he uses Figma with a graphics library tailored to the docs, allowing reuse and modification of existing assets. For image cleanup and manipulation, he favors an easy, free program (he mentions colorizing black-and-white drawings). For screen capture he uses Snagit, and for editing he uses Wondershare Filmora. He argues that high-end video tools aren’t required if the goal is clarity and speed of iteration.

Review Questions

  1. What specific doc changes did Dawson make to support the “decision layer,” and how do those changes reduce reader effort?
  2. How does modular tutorial design (UI isolated from business logic) help developers reuse code, and why does it prevent context switching?
  3. What are the differences between co-worker feedback, external task-based testing, and hiring a testing consultant in Dawson’s framework?

Key Points

  1. 1

    Write documentation for the reader’s job, not the author’s completeness—people want “just enough” to act.

  2. 2

    Add navigation and high-level framing so readers can choose the right depth without reading everything first.

  3. 3

    Use a “decision layer” (e.g., use cases plus end-of-paragraph “go deeper” links) to help readers decide what to do next.

  4. 4

    Reduce context switching by separating UI from business logic and using modular, runnable tutorial lessons developers can copy.

  5. 5

    Treat graphics as meaning-carrying, scan-first tools; revise flowcharts so explanations stay close to the relevant parts (including stepwise builds).

  6. 6

    Validate changes with task-based testing; watch people struggle with real tasks rather than relying on compliments.

  7. 7

    Keep production practical: collaborate in Google Docs/Figma, convert to markdown with GitHub review, and use lightweight tools for screen capture and editing.

Highlights

Dawson’s biggest usability shift was reorganizing docs around navigation and a “decision layer,” so readers can pick the right path without committing to full reading.
Tutorials improved when they stopped forcing constant switching between “user” and “developer” modes; modular lessons made code reuse straightforward.
Task-based testing exposed real UI problems—like a key navigation element being missed—more reliably than positive feedback ever could.

Topics

Mentioned

  • Dennis Dawson
  • Ellen Yang
  • Natalya Sabari
  • Richard Mayer
  • Ryan Young
  • Caitlyn Davey
  • Bill Campbell
  • Mike Rorie
  • Mark Kistler
  • ED Emberly