From the editorial deskJournal

An example needs to do some work

An example should make a point easier to understand. Choose the detail that explains the idea, identify invented scenarios clearly and leave out the decoration that gives a hypothetical situation the appearance of a real case.

Choosing the useful detail

Before adding an example, write down what it needs to show. Perhaps an abstract distinction needs a concrete situation. Perhaps a reader needs to see how a recommendation changes a sentence. The purpose will help you decide how much detail the example requires.

A small example often has enough room to do this. An invented company history, a named customer and an impressive result may make the paragraph feel substantial while adding nothing to the explanation. Worse, those details can make an imagined situation sound reported.

If the example is hypothetical, say so before asking the reader to learn from it. Keep the invented details proportionate to the point. A made-up service description can demonstrate an edit without needing a fictional testimonial or a claimed business outcome.

When the source material contains a real example, preserve the facts that make it useful. Do not replace an inconvenient detail with a cleaner story. If something is unclear, resolve it with the business or acknowledge the limit in the writing.

After the example, explain the connection only if the reader needs it. Repeating the entire argument can make a short illustration feel heavy. Sometimes a sentence is enough to show what the example changes in the reader's understanding.

Read the piece once with the example removed. If nothing becomes harder to understand, consider cutting it. If the argument suddenly feels vague, the example is doing its job. Keep the detail that carries that work and remove anything included merely to make the story look more convincing.

See editorial rates