An analogy for technical communication

The analogy of rescuing a marooned audience

Technical/scientific communication—writing, talks, day-to-day collaboration, especially day-to-day collaboration—is a life-or-death predicament in disguise:

The communicator must

  • verbally convey an escape route
  • to a frantic and fatigued audience marooned on a treacherous island;
  • the audience has no map, only the communicator does,
  • but the communicator is separated in a control room and must guide the audience only through a walkie-talkie.

An alternative imagination (although a bit less potent as an analogy) is of the audience solving a jigsaw puzzle or reconstructing a picture while listening to instructions from a communicator. The communicator is hidden behind a screen and the audience are clueless about what the final picture looks like.

Even less potent, and in fact misleading, is the analogy of technical communication as something like guiding tourists. This suffers from multiple incorrect assumptions. The tourist-audience is in the same place as the communicator, know what the map looks like upfront and can observe the guide’s spatial gestures. The tourist-audience is whimsical, has no pressing long-term goal, is under no cognitive or emotional stress and gleefully follows the guide wherever they go. None of this is true of the challenging mission that is technical communication.

The challenges of technical communication

Verbalizing both the map and map-showing

In the analogy of the rescue mission, the rescuer’s task is to transmit through mere words a gnarly escape route (teeming with forks, loops and dead-ends) to a mapless audience reconstructing the route at their end. Disentangling and verbalizing a two-dimensional object is already challenging. But making matters worse is that the (disembodied, remote) rescuer cannot enact the physical gestures of an (embodied, in-person) tour guide, like pointing a finger in a direction, dileneating the silhouette of a fuzzy object, demonstrating where and how a piece must placed and so on.

Thus, in technical communication, the rescuer is forced to verbalize both a complex map and the many physical gestures required to spatially guide someone as they assemble and navigate the map.

Understanding the psychology of the audience and building trust

The rescuer also needs to empathize with the delicate mental state of the people stranded and starving on an unpredictable island.

  • They are distracted by the slightest of stimuli and bewildered by the tiniest of tasks;
  • they are forgetful and barely able to think;
  • they feel a constant urgency towards being liberated (“Are we there yet? How far did the trek bring us? Where on earth are we now? Weren’t we here exactly two hours ago?”);
  • they experience a severe dissonance: every instruction from the rescuer appears to those poor souls as a meaningless form of torture: climb a slippery mountain, pet a snake, read a meandering, line-breaked equation. Why is a self-proclaimed savior making them endure bizarre sufferrings? Is there not a rosier path to salvation? This friction generates caution and skepticism.

Thus, in technical communication, the rescuer needs to dispel a flurry of doubts arising from the audience, earn the audience’s trust, and persuade them into wilfully engaging in acts of suffering.

The solutions

To master these challenges, our disembodied rescuer must abide by two broad commandments.

  • One is that they must transmit the pieces of the map in a calculated order that is sequential and hierarchical.
  • Second, they must transmit all the raw information glued together with rich meta-information that explicitly verbalizes finger-pointings and makes the mission more transparent by offering promises, rationales, reassurances, reminders, red flags and so on.

We will discuss these ideas shortly.


Why an analogy?

The analogy is not just an exercise in wild imagination. It serves a few purposes.

  • One, it helps us internalize in succinct and animated terms, the tedious commandments of technical communication that we otherwise try to absorb through brute memorization and practice.
  • Second, the analogy helps develop new rules on the fly by shaping our instincts in unpredictable scenarios, like when an otherwise well-rehearsed talk is heckled by a tenured faculty member.
  • Third, the analogy is a didactic tool that helps justify feedback. I often say things like: “You’re trying to get the reader to embark on this strenuous journey, but you’ve not told them why they should do it!” or “You’ve shocked the reader abruptly with this complex discussion. Give them a warning!”. With vivid back-story, the rule is better taught and better understood.
  • Finally, the analogy gives some imagery to rules of writing that are frustratingly cryptic to a young writer (“improve flow”—what flow?, “anticipate the reader’s questions!”–what questions?).

The rest of the post will demonstrate (to great detail), how to derive and motivate some of these rules from within this analogy. The focus is not so much on the rules themselves as it is on their derivation.


Narrative ordering

We can think of every snippet of the map/escape route as a raw piece of technical information (a notation, a definition, a sub-routine, a claim, a hypothesis etc.,). The first two rules lay out the basic algorithm by which the rescuer must break down their private map into such digestible pieces, and the order in which they must transmit those pieces. Before discussing the rules, let us diagnose how the ordering can go wrong.

The naive rescuer’s ordering

“Why are you telling me this? What do I do with this information? Where does this fit?”, is a question that vexes the audience in a disorganized presentation. The naive rescuer, eager to enlighten his mapless audience, has impulsively dumped all pieces of the map in some reckless ordering into the audience’s head. The rescuer’s assumption is that, in a subsequent stage, the audience, with eagerness equalling that of the rescuer, will re-arrange the map into one piece to witness what the rescuer has been privy to all along. This is what happens when a second read of a paper is needed for everything to fall in place—it is rarely a delight for the audience.

The naive rescuer’s downfall lies in their own private knowledge: to them, the “dump-then-reconstruct” strategy appears so simple and thrilling because they can already picture the panoramic beauty of the complete map, and so which piece goes where. But to the audience, the naive rescuer has demanded a “memorize-everything-then-recall-everything-into-your-working-memory-and-then-unscramble” strategy. This requires the cognitive abilities of a detective and the patience of a saint, neither of which the famished audience has the luxury for.

Sequential narration for flow

The audience in despair craves for constant signs of progress: as and when a snippet of the escape route arrives in their walkie-talkie, it must snugly fit into whatever crude map they’ve partially reconstructed, allowing them to proceed a step further. If the rescuer tells them, “there’s a faraway forest we’ll later encounter, let us now pause for my monologue about the many trails and tribulations it has in store”, the audience descends into chaos. They cannot teleport, and they don’t want to hold on to a disconnected body of information, information that may evaporate from memory at any moment. (“What if I forget this arbitrary collection of hideous notations and that’s how I perish on this island?”)

The solution then is to lead the audience step-by-step into the forest, so they can develop their map through direct experience:

Technical communication must relay an escape route through a chain of step-by-step instructions. Nothing must be introduced abruptly. Every equation, theorem, algorithm and hypothesis must refer back to, and emerge out of at least one or more ideas, objects or motivations introduced before. This way, every instruction is consumed then and there rather than dangling afloat in the audience’s head like loose threads. The audience, in stitching the map out as if it were a single piece of cloth, are relieved to carry at any time only the amount of information necessary to execute the next step, not a whole scrambled map. This is what is meant by “flow” and the impatient cravings of the marooned audience justifies the need for flow.


Hierarchical narration for building a canvas

Sequential ordering alone is inadequate to soothe the audience. If the walkie-talkie blared out a well-ordered series of commands—Read these notations! Next comes Lemma 1! And then, Lemma 2! Now, the final proof!—it is as frustrating as being made to assemble the pieces of a puzzle or being made to draw a picture grid-by-grid with no clue of what is even being constructed.

That is, the audience on a terrifying island are reluctant to blind-foldedly follow a cascade of little steps. They desperately want to know the overarching plan for salvation before all else, rather than take a leap of faith. They demand this so they can first and foremost build a fuzzy canvas in their head onto which they can later piece together specific, low-level snippets of the map, thus re-assuring themselves that everything is indeed going according to plan and they will make it out alive.

Thus, the rescuer provides a helicopter pilot’s view of the island from various altitudes: they say, the exit lies at a so-and-so theorem, the shape of the island is a three-lemma proof sketch, etc., all before zooming into a particular definition. Now, even when stating the definition, the rescuer provides an high-altitude idea before specifying its ground-level details. Algorithmically, the rescuer has organized all their information into a giant tree, and they traverse this tree in a “depth-first order”, repeatedly zooming in and out to read out the information. (That’s one dizzy helicopter ride, but such is the sacrifice our rescuer has to make.)


Meta-information

In addition to transmitting raw information about the escape route, the rescuer needs to transmit meta-information, that is, information about the information—such as why the information is necessary, how it relates to everything else, how important it is etc., Meta-information is what describes how to parse and assimilate a piece of information. It is the equivalent of physical gestures sent over a walkie-talkie or messages sent to manage the apprehensive and antsy state of a marooned audience.

A golden rule then is to provide meta-information in advance of the information itself. This pre-emptively wards off any anxieties that a piece of information may trigger, and has the audience (psychologically and cognitively) primed to handle an incoming piece of information. If not, they are forced to store the raw information first, and then be told how to handle it, which by the same logic we discussed under “sequential narration”, would demand much patience and memory from the fatigued audience than is needed.

The next few sections derive the different types of meta-information needed using the analogy of the rescue mission. But let us make clear how essential this is, because we often sideline meta-information as the dull and dead afterthought of communication, the However’s, and the “in this section, we will”s peppered in between information that we deem interesting1. This is a gross misconception. Meta-information includes substantive thoughts, insights and facts about the information. It is what breathes life and form to what would otherwise be a clumsy Frankenstein of a presentation. Meta-information should therefore by treated on an equal footing to information itself!2

Relationships between information

Before transmitting a piece of information, the rescuer must explicitly handhold and motivate the audience by specifying how the piece relates to the audience’s partially reconstructed map and the promised hazy canvas of the map.

Connections to the past for handholding

The audience has no patience to try and deduce how and where a piece fits with their partially-reconstructed map. So, as if virtually holding their hand to place the piece, the rescuer must be descriptive about how an information delivers on an earlier promise or how it supplements or complements or builds out of other pieces of information. At the level of ideas this could be saying “In the next theorem, I’ll prove a gap between the two quantities described in the previous two slides. This is stronger than the warm-up theorem we saw earlier.” before describing Theorem 1 (observe that the italicized connection to past is not boring fluff but meaty technical content about technical content!). Similarly, on the surface of the text, the rescuer would ensure that the first few words of sentence directly relate to, or literally overlap with a recent sentence, as if the text has been manifestly hemmed together.

Connections to the future to motivate suffering

The audience cannot be lured into following a sequence of actions, just because one follows smoothly from all previous actions. “Grab this giant rock before we trek up this mountain” and the audience stares incredulously. A particular sequence of worries will run through their mind: “(1) Do I really need something that will weigh me down during the climb? (2) But what if this is useful later? (3) Perhaps I can find rocks like this later, so I dont need to worry about this instruction right now! (4) But what if I skip it and I don’t find these rocks again?”

So, before making the audience endure an act so painful and so loathsome, the rescuer must motivate why that suffering is both sufficient and necessary for the eternal salvation promised at the start of the treacherous academic presentation. This means rather than describing a theorem to excruciating detail followed by a dramatic reveal of its purpose, the rescuer begins with a spoiler about how it satisfies a previously-mentioned overarching plan: “Since we want to show that this algorithm fails, it means that this quantity from the previous slide must be large than the quantity in this slide. This gap is what this theorem establishes.”

Signposts

The marooned are traversing not just the island, but also a tree of instructions, an imaginary tree which needs visible punctuations like, “Having crossed the first hurdle of the river, for the second of the three hurdles, we have to get you up this steep and misery-inducing proof sketch.” Thus, after covering a sub-tree, the rescuer reminds the audience of a summary of what they have accomplished; as they backtrack and zoom into a different branch, they announce that they’re pivoting, and provide a summary of what the new sub-tree promises.3

Shaping attention, or verbal gesturing

Since the rescuer and the audience are not co-located, the rescuer needs to explicitly and verbally finger-point to steer the audience’s attention. What makes this more challenging is that, the audience, surrounded by wilderness, is over-stimulated and hyper-sensitive, and so the rescuer needs to predict the audience’s “saccades” and bridle them, all through a walkie-talkie.

Abstractions and distinctions

Abstractions: To point fingers at things, there must be things, things that exist inside the heads of both the interacting parties. But given that the audience is stuck elsewhere, this shared vocabulary of things must be deliberately developed and shared. This is however hard, especially in the initial stages of research, when interesting formations begin to appear on the landscape but only as fuzzy silhouettes in the distance. What the rescuer does then is to routinely and loudly segment and re-segment the horizon: as and when these formations become even mildly discernible, they are quick to announce names for them (“Hypothesis ABC”, “Phenomenon XYZ”) so that the audience’s attention can later be conveniently redirected to a collection of related and recurring ideas. This is accompanied with rich definitions, explicitly noting that it is only tentative, and will become more comprehensible as the audience trudge closer towards those formations in the horizon. (This practice of repeated abstracting and christening is particularly important in day-to-day collaborations and at the beginning of a research project.)

Distinctions: Another extremely important tool for developing a shared segmentation of the landscape is contrasting how one formation is different from another, especially when they seem to overlap. Noting “Theorem 2, unlike Theorem 1, no longer needs Assumption 1” or “What I’m saying now is different from what I said five minutes ago in this sense” crystallizes how exactly the map has advanced.

Distractions

A common pitfall in guessing games like pictionary is that the communicator, intent on painting a rich picture, over-communicates while the guesser, intent on finding patterns, fixates on a stray detail, which then cascades into a grave misunderstanding, derailing the communication game.

To avoid this pitfall, there are two rules to be observed.

Specifying importance

The rescuer assesses the relevance of each instruction to the escape, and announces that assessment in words before announcing the instruction. Saying “What I’m about to say is just a sidenote” or warning the audience “I’m about to divulge the major step we should focus on” can graciously let the audience time their naps. But back-and-forth, collaborative settings demand more adaptive strategies since the communicator must constantly detect and shepherd the collaborators whenever they pull the conversation down a rabbit hole.

Avoiding emergent distractions with disclaimers

Some stray details emerge not from the rescuer’s mouth, but in the eyes of the audience as an inadvertent second-order effect:

  • some statements may seem counter to the audience’s intuition or to the audience’s knowledge of literature or to what they thought the rescuer said earlier;
  • some key terms may seem overloaded within the presentation or may mean something else in some pockets of literature;
  • some ideas may sound similar or related to each other when they are not;
  • some analogy may be easy to superimpose and over-apply in an unintended orientation;
  • some claims ambiguous, some things easy to misunderstand.

These distractions may or may not be visible to the audience. Either way, they are insidious: if the distraction sticks out as a giant, bizarre contraption, it can eternally haunt the audience, given their skittishness; if well-camouflaged, it can unwittingly lure them down the wrong route!

A vigilant rescuer infers the locations of these traps (which are highly camouflaged in the rescuer’s vision) and then addresses their presence promptly, which can be done in one of three ways:

  • “You may have spotted a gigantic ticking apparatus by your side, here’s how to defuse it!” or
  • “Do not worry about that trap now, we will defuse it later!” or
  • “That ticking sound is just a red herring placed by this diabolical island. We shall ignore it forever as it does not lie on the way to salvation!”

The last two solutions rest on the fact that the rescuer needs to always say what they are not claiming. The mere disclaimer that something should seem nonsensical and unresolved for now, and is best ignored for now, builds trust with an anxious audience that is otherwise over-guessing missing details.4

Descriptions of the information

Before transmitting a piece of information, the rescuer must describe the various traits of the information. Richer the description, smoother the rescue. Some examples below.

  • Type: Like the myriads of symbols on a map, a techincal statement could be an assertion, a promise, a question, a concern, an observation, a conclusion, an assumption, a definition or a guess. Confusions arise when what the communicator regards as an assumption, is what the listener processes as a conclusion—at least until the discrepancy surfaces itself. Thus, the type of the information must be announced before the information itself. (Once again, this habit comes naturally while writing, but is easy to miss in day-to-day collaborations.)

  • Quality: Occasionally, the rescuer may think it is best not to communicate the next piece of the map with precision. If the audience senses something imprecise, it induces anxiety, which is avoided, if in advance, they’re told of an upcoming instruction being intentionally “handwavy” or “informal” or “rough”. Once again, this is the rule of saying what is not being said (here, the intricate details).

  • Difficulty: Demanding the marooned to climb a mountain that becomes abruptly steep is a rude shock. The empathic rescuer prepares the marooned psychologically: “Now, this is going to be a hard trek up” or “This is going to be frustratingly precise, but we need that precision here”. Funnily, even if something is too straightforward, the audience second-guesses themselves: “Did I miss something here? It cannot be that easy?” The empathic communicator would have started with “What I’m about to say is straightforward.”

Other rules

Many other miscellaneous rules of technical communication can be derived from our premise of remotely guiding an audience trapped in a wild island.

  • For instance, the empathic rescuer compensates for the lossy memory of the barely-surviving audience by reminding them of landmarks and experience they have come across as and when these get referenced. Such reminders are most needed in day-to-day research collaborations where the lead who has intimate and fresh knowledge of the island, has to communicate with the advisors who are simultaneously escaping (or pretending to escape) multiple wild islands.
  • The rescuer also provides ways for the disoriented audience to periodically “triangulate” their location, especially at complex situations, for example, through base-cases or simple examples right after a theorem, or through multiple rephrasings or perspectives of the same fact.
  • The rescuer also breaks up instructions into the littlest pieces possible, rather than rambling on and on about one piece, and in situations where they can hear back from the audience, they give long pauses for the audience to overcome their (undue) embarrassment and speak up about a given piece.

The derivation of other rules are left as an exercise for the reader.

Another exercise is to experience and monitor a few technical presentations through the lens of the rescue mission. What things has the rescuer done right and done wrong, and how does the analogy explain those? Did you feel the canvas being built in your head and pieces being easy to put in place? What moments caused “distress”? What could the rescuer have done better? What meta-information could they have provided, in hindsight?

Technical communication vs. story-telling

In many ways, story-telling is anti-thetical to technical communication, a contrast that when appreciated illuminates what is unique about technical communication. The story-telling audience has deliberately marooned themselves on an island; they seek an adventure and are excited by the ignorance of what is around the corner; they do not want instructions to make immediate sense; they don’t want to be handheld!

As a consequence, the story-teller transgresses each of the commandments discussed above. The story-teller constructs a deliberately and artfully disordered presentation of information, non-sequential, non-hierarchical and ever unpredictable. Everything clicks only at the end, only with a second read or only after an enthusiastic unscrambling by a brave audience, because that fate is pre-meditated by the story-teller. The story-teller must “show, not tell”, which means meta-information is taboo. The pleasure of a story is derived from filling in missing details, from constantly making conjectures abour how something relates to the past or to the future, from anticipating what the undisclosed future resolution would be, or from overlooking a critical plot device as a mere distraction and so on. In many ways, what is suffering for a technical audience is pleasure for a creative audience, and vice versa.5


Disclaimers

  • It may seem as though this essay views technical communication as a form of torture and condescension towards the audience. But the suggestion here is to only temporarily role-play a certain default mental makeup while designing a talk or paper. It is still important to know what the audience knows and respect their knowledge.

  • Not all technical presentations that require a second read or a second watch are due to the communicator’s naivety. Some ideas are inherently complex and possess higher-order beauty that demands revisits.

  • Some of the rules may make it seem like scientific communication must consitute a lot of dry and rigid scaffolding devoid of any thrills or suspense. However, with experience, a technical writer can find little ways to inject freshness into their writing while being subject to the rules:

    • One solution is to play with the surface of the text: avoid cliched phrases and syntax (both in the meta-information and the information), or use novel metaphors and phrases while communicating the information.
    • But we can also pursue a technically-deeper kind of creativity in other ways, like in how intuitions are developed and illustrated, in how the introductory paragraph of the paper develops the motivation, in how ideas are related and contrasted, or in cleanly explaining (and pausing before) the key “aha” step in a proof.

Footnotes:
  1. Those generic markers, the “However,”, “Additionally, etc., are referred to as meta-discourse. [[more]] But guide-books usually over-emphasize these markers themselves rather than the interesting, non-trivial content that accompany these markers, which is why I prefer to label it distinctly as meta-information. For more on metadiscourse, see these references [1, 2, 3]. 

  2. Meta-information tends to come more naturally in structured and editable media (e.g., in written form), but is most easy to miss in live presentations and even more so in day-to-day collaborations. Ironically, [[more]] the live audience are most in need of meta-information since they do not have a structured medium to stare at and think through! So, the live communicator must be doubly attentive in parting with meta-information to a live audience. 

  3. I admit that signposts tend to be the most boring type of meta-information. It is best to keep it short and sweet. 

  4. The trick of acknowledging the nonsensical is handy in many situations. For example, it can be handy when the rescuer relays an out-of-sequence instruction that can only make sense later—this may happen either because the concept is impossible to sequentialize or because the rescuer accidentally went out of order (thanks, heckler). 

  5. A similar series of contrasts can be drawn between a painting and a technical diagram. 

« Can a text-only model ever understand things the way we see?