1. WHAT IS TECHNICAL COMMUNICATION?
It is common knowledge in the workplace that no one really wants to read what you write, and even if they want to or have to read it, they will likely not read all of it. So how do you get your reader to understand what you need quickly and efficiently? Start by doing a detailed Task and Audience Analysis — make sure you understand the “rhetorical situation.” Before you begin drafting a document, determine the needs of your rhetorical situation (See Figure 1.3.1).
The “rhetorical situation” is a term used to describe the components of any situation in which you may want to communicate, whether in written or oral form. To define a “rhetorical situation,” ask yourself this question: “who is talking to whom about what, how, and why?” There are five main components:
PURPOSE refers to the why you are writing. Determining your purpose requires that you engage in Task Analysis — that is, determine what you hope to accomplish by writing this document. Ask yourself what you hope the reader(s) will do/think/decide/ or how they will behave as a result of reading the text. There are three general purposes for communication in the workplace: 1) to create a record, 2) to give or request information, and 3) to persuade.
Within those general purposes, you will find a myriad of specific purposes. For example, your purpose may be to propose an innovative solution to a specific problem. In this case, you want the reader to agree to explore the idea further, or approve funding for further research and development, which would fall under the general purpose of writing to persuade.
WRITER refers to you, the writer/creator/designer of the communication. It is important to examine your own motivation for writing and any biases, past experiences, and knowledge you bring to the writing situation. These elements will influence how you craft the message, whether positively or negatively. This examination should also include your role within the organization, as well as your position relative to your target audience.
AUDIENCE refers to your readers/listeners/viewers/users. Audience Analysis is possibly the most critical part of understanding the rhetorical situation. Consider Figure 1.3.2 below. Is your audience internal (within your company) or external (such as clients, suppliers, customers, other stakeholders)? Are they lateral to you (at the same position or level), upstream from you (management), or downstream from you (employees, subordinates)? Who is the primary audience? Who are the secondary audiences? These questions, and others, help you to create an understanding of your audience that will help you craft a message that is designed to effectively communicate specifically to them.
Keep in mind that your different audiences will also have a specific purpose in reading your document. Consider what their various purposes might be, and how you can best help them achieve their purpose. Considering what they are expected to do with the information you provide will help you craft your message effectively. Consider also that technical writing often has a long “life-span” – a document you write today could be filed away and reviewed months or even years down the road. Consider the needs of that audience as well.
|Audience||Purpose for Reading
|Supervising Experts/Managers||Advise decision makers; direct subordinates|
|Technical Experts/Co-workers||Implement decisions; advise|
|Lay People/Public/Clients||Become informed; choose options; make decisions|
Some companies develop audience profiles to help guide their communications. This is a good exercise whenever you have something to communicate, especially if the information is complex. Here are some questions to consider as part of the audience profile:
Developing an Audience Profile
- Who are your primary readers? (specific names and titles, or general roles)
- Are they above you in the organizational hierarchy? Lateral, subordinate? Outside of your organization?
- Who else might read this document? (secondary readers)
- Do you know what their attitude towards the topic is?
- How might cultural differences affect their expectations and interpretations?
- How much technical background do the readers have?
- How much do they already know about the topic?
- What situation gave rise to this document?
MESSAGE refers to what information you want to communicate. This is the content of your document. It should be aligned to your purpose and targeted to your audience. While it is important to carefully choose what content your audience needs, it is equally critical to cut out content that your audience does not need or want. “Time is money” may be a tired old cliché, but it is important to avoid wasting your audience’s time with information that is unnecessary or irrelevant to them. Your message should be professional, and expressed in an appropriate tone for the audience, purpose, and context. We will discuss aspects of using a professional style and tone in crafting your message more in Chapter 2.
CONTEXT refers to the situation that creates the need for the writing. In other words, what has happened or needs to happen that creates the need for communication? The context is influenced by timing, location, current events, and culture, which can be organizational or social. Ignoring the context for your communication could result in awkward situations, or possibly offensive ones. It will almost certainly impact your ability to clearly convey your message to your audience.
Consider the subtle (and not so subtle) similarities and differences in the rhetorical situation when you offer feedback on Course Experience Surveys vs when you evaluate an instructor on Ratemyprofessor.com.
|Course Evaluation Survey||Ratemyprofessor.com|
The table below contains a collection of details about a research project you have just completed on rising sea levels. Imagine that you’re writing documents for each of the 5 following audiences:
- Your supervisor/boss
- The general public
- High school students
What information about rising sea levels might each audience be interested in? As you go down the list, write in the blank spaces in front of each detail the letter that corresponds to the audiences that you think would find this detail most relevant.
Consider what kind of document might contain that information for that audience.
|Interested Audience||Categories of Information on Sea Level Rise|
|The dollar damage caused by sea level increases each year.|
|A literature review of previous research on rising sea levels.|
|Descriptions of calibration procedures for your instruments.|
|Some basic physics of how tides and currents work.|
|How much your project costs.|
|A log of all your measurements during the whole project.|
|A list of people who worked on the project.|
|Specifications of a new instrument to measure water conditions.|
|A new result showing a connection between sea level and coastal developments.|
|Procedures you used to avoid statistical biases in your data.|
|Your plans for further measurements.|
|Your recommendations for future research.|