How not to Sacrifice Clarity to Simplicity in Technical Writing

Table of Contents

Introduction

Simplicity in technical writing is a mantra frequently repeated by trainers and writing instructors.

You’ve heard it many times and in general, it’s true: “Write simply. Eliminate all unnecessary words and facts from your technical writing.”

Plain language is of course what we all like. But there are always exceptions in life, including this worthy principle.

It does not make sense to write in simple sentences if such simplicity leaves your audience scratching their heads and wondering what’s going on.

The way you write should not only convey what you want to say in a direct manner but also convey ALL you want to say, without dropping any significant pieces of information in the name of simplicity.

Role of Statistics

Statistics are often used by those who are trying to write simply and back up arguments. However, they can also be used to deceive. Not everyone who quotes numbers is talking clearly. Here are the following 4 ways you can spot a statistical lie detector test:

1) The sample size is too small

A sample size of less than 50 people is not statistically significant enough to make any claims. This means that in order for the data to be accurate, it would need to be at least 50 people in the study.

2) The sampling is biased.

Was the sample selected randomly?

3) There is no control group.

If the results of the subject group are not compared with those of the randomly selected control group, then the results don’t have any statistical significance.

4) There are no clear definitions of what constitutes an event or outcome.

If you do not define beforehand what will count as an “event” or an “observation,” then the outcome can be fudged according to changing definitions of an “event” or an “observation.”

What to Include?

What kind of information should you include, even if that leads to longer sentences or paragraphs?

Anything that would place your information in a larger CONTEXT and make the SIGNIFICANCE of the information clear. Include anything that would help your audience understand what the information really MEANS and if they should do anything about it.

For example:

“Average American factory worker earned $43,000 last year.”

Yes, but WHAT exactly does this mean? What’s the PURPOSE in sharing this information, expressed in a beautiful short sentence?
Compare that sentence to this paragraph:

“Average American factory worker earned $43,000 last year in contrast to ten years ago when the same figure stood at $45,000. Adjusted for the average annual inflation rate of 2.5%, that amounts to a net loss of $1,300 a year which reflects the hardships the manufacturing sector went through during the last decade due to stiff competition from China and EU countries.”

Isn’t it clearer now what that $43,000 figure represents and means?