How to Explain Technical Topics to Non-Technical Readers

Leslie O’Flahavan, E-WRITE@LeslieOFirst AmericanSeptember 17, 2014

Thanks for the opportunity to present this webinar!

© E-WRITE 2014 2

Webinar overview1. How an expert technical reader differs

from a non-expert non-technical reader

2. What to do when you can’t meet technical and non-technical readers’ needs in the same document

3. Four techniques for helping non-technical readers: headings, analogies, paraphrasing, and definitions

© E-WRITE 2014 3

What is technical writing, anyway?

Is this technical writing?Black Truffle and Bone Marrow Sauce

INGREDIENTS:

1 tablespoon diced raw bacon fat

2 tablespoons minced shallots

½ teaspoon minced garlic

1 teaspoon chopped fresh thyme

½ cup diced winter black truffle

1 tablespoon butter

1 cup chicken stock

¼ cup veal demi glace

1 cup diced raw bone marrow, soaked in milk for 24 hours

6 grams Texturas Xantana

¼ teaspoon squid ink

½ teaspoon truffle oil

METHOD:

Heat the butter in a sauté pan over medium heat. Sweat the bacon fat, shallots, garlic, thyme, and truffles until the shallots are soft. Add the chicken stock and veal demi glace and bring to a simmer. Add the bone marrow and simmer for 1 minute, or just until the bone marrow is heated through, but not yet rendering its fat. Immediately transfer the liquid to a blender. Blend on high and sprinkle in the Xantana a pinch at a time. Incorporate the squid ink and truffle oil.

© E-WRITE 2014 5

I’m Chef Jason Wilson

The Society for Technical Communication defines technical writing as any form of communication that:

• communicates about technical or specialized topics

• communicates through technology

• provides instructions about how to do something

© E-WRITE 2014 6

Part 1: How an expert technical reader differs from a non-expert non-technical reader

A tale of two readers

Nathan the non-expert Ellen the expert

© E-WRITE 2014 8

How do tech and non-tech readers differ?

1. How motivated is this person to read?

2. How much reading endurance does this person have?

3. How large is this person’s technical vocabulary?

4. How large is this person’s appetite for data?

© E-WRITE 2014 9

Part 2: What to do when you can’t meet technical and non-technical readers’ needs in the same document

Different versions for different readers

© E-WRITE 2014 11

For the non-technical reader

© E-WRITE 2014 12

© E-WRITE 2014 13

For one type of technical reader

© E-WRITE 2014 14

For another type of technical reader

In one document: Different versions for different readers

© E-WRITE 2014 15

Part 3: Techniques for helping non-technical readers: headings, analogies, paraphrasing, and definitions

Headings help non-technical readers

© E-WRITE 2014 17

Who are the intended readers of this Guide? Technical or non-technical?

© E-WRITE 2014 18

Headings help non-technical readers

© E-WRITE 2014 19

Headings help non-technical readers

© E-WRITE 2014 20

Use analogies, paraphrasing, and definitions

The Remrak CoefficientIn the production of powdered detergents, spray drying is the technique used to evaporate the solvent from the liquid reaction mixture and physically form the finished powder product. In spray drying, the liquid is sprayed into the top of a tall tower and allowed to fall freely to the bottom of the tower, where it is removed as a dry powder. The solvent evaporates during the course of the fall. Particles dried in this fashion have an unusual shape, like that of a saddle or a Pringle's potato chip, and consequently fall through the air in an unusual manner. Rather than falling in a vertical path, the particles fall in a helical path. The shape of the helical (spiral) path is described by the Remrak coefficient, which is the ratio of the diameter of the helix to the height required for one passage of the particle around the perimeter of the helix. The coefficient, which is a function of drying conditions, is sought to be maximized, so that the length of flight of the particle is made much greater than the actual height of the spray-drying tower.

© E-WRITE 2014 21

Use analogies, paraphrasing, and definitions

The Remrak CoefficientIn the production of powdered detergents, spray drying is the technique used to evaporate the solvent from the liquid reaction mixture and physically form the finished powder product. In spray drying, the liquid is sprayed into the top of a tall tower and allowed to fall freely to the bottom of the tower, where it is removed as a dry powder. The solvent evaporates during the course of the fall. Particles dried in this fashion have an unusual shape, like that of a saddle or a Pringle's potato chip, and consequently fall through the air in an unusual manner. Rather than falling in a vertical path, the particles fall in a helical path. The shape of the helical (spiral) path is described by the Remrak coefficient, which is the ratio of the diameter of the helix to the height required for one passage of the particle around the perimeter of the helix. The coefficient, which is a function of drying conditions, is sought to be maximized, so that the length of flight of the particle is made much greater than the actual height of the spray-drying tower.

© E-WRITE 2014 22

Give an example

© E-WRITE 2014 23

© E-WRITE 2014 24

Writing for technical and non-technical readers? Consider the layer cake…

© E-WRITE 2014 25

A technical writing case study

© E-WRITE 2014 26

Plain language resources at CFPB

27

Questions? Comments?

© E-WRITE 2014 28

Let’s stay in touch…

Leslie O’Flahavan, E-WRITE

Leslie@ewriteonline.com

301-989-9583

www.ewriteonline.com

@LeslieO

© E-WRITE 2014 29