Home » Writing & Publishing » Technical Writing » Fat Free Writing - Part Three

Fat Free Writing - Part Three

© John L. Hoh, Jr.

When determining an audience, the technical writer should think of themselves as a teacher and the reader a student. As such, you, the technical writer, must determine your reader's background.

You should always explain your product or procedure at the basic reader's level of understanding. You can make all the difference to a document that gets read or a document that gets tossed in the trashcan.

As a technical writer, you expect your writing to be used. However, if your document doesn't make sense to your intended audience, it won't be used.

You should be constantly asking yourself the following questions when you develop your technical writing.

Basic Questions to Determine Audience

1. Who is the audience? Who is my basic reader?

2. What is the technical level of the reader?

3. Will the audience be multi-level?

4. How much does the reader currently know of the subject?

5. What exactly does the reader need to know?

6. When should the reader know this information? When is my project due?

Three Basic Technical Levels

Once you've answered these questions you can see that readers are grouped in three basic levels of technical knowledge: High, Medium (or semi-technical), and Low or No Technical knowledge. Engineers, programmers, and others with specialized training make up your highly technical group.

Readers with some technical knowledge will want to know more about why they must perform a task rather than the actual steps. They're interested in more background information. Finally, we come to the non technical reader. These are your basic end users. They may have no specialized knowledge of the product and in most cases are first time users. They want to know exactly what they're supposed to do without any long explanations or "boring" background details.

Yes, I said, "boring." Remember, what makes sense to you, may not make sense to your reader. Always consider your audience when completing your documents.

Keeping Your Writing Lean

Remember, technical writers must be as direct and specific as possible. Stick to the subject. As a technical writer you are showing your reader as well as telling your reader about the product or procedure. It's important that you choose high information words that show exactly what you mean, rather than make the reader guess.

For example, if you want the reader to press a lever. Don't use the following sentence: "Press the red thing on the left of the machine." The reader may get confused. They may second-guess your instructions. Did you mean to have them press the red lever or the red switch, both of which are on the left side of the machine?