📘 Lecture 28 — Progress Reports
📖 Overview: This lecture explains how to write effective progress reports that communicate project status to various stakeholders. It covers the purpose and structure of progress reports, the key questions readers want answered, and how to organize information to help readers make future decisions about the project.
🗂️ Topics Covered
The lecture covers progress reports, typical writing situations for progress reports (single project vs. multiple projects), readers' concern with the future, the seven key questions readers ask most often, and the superstructure for progress reports including introduction, facts and discussion, answering readers' questions, organizing the discussion, emphasizing important findings and problems, conclusions, and recommendations.
📝 Lecture Summary
Progress Report
A progress report states the progress made towards the goal during the reporting period, discusses significant costs and scheduling issues, and lists future objectives to be carried out. Project monitoring and accountability are the main objectives of a progress report.
Typical Writing Situations
Progress reports are prepared in two types of situations.
In the first situation, you tell your readers about your progress on one particular project. For example, Lee, a geologist employed by an engineering consulting firm, studies a site for a civic center and office building. Every two weeks he submits a progress report to his supervisor and to the city engineer. His supervisor uses the report to ensure the study is conducted rapidly and technically soundly. The city engineer uses it to see if the study is on schedule and to look for preliminary indications about the likely outcome.
In the second situation, you prepare progress reports that tell about your work on all your projects. These are often called periodic reports. For example, Jacqueline manages a department improving laundry detergent formulas. Her staff works on ten to twenty different projects at any one time. She writes a report every two weeks summarizing progress on each project. Her readers include immediate superiors, people in other divisions who may use discoveries in their products, and corporate planners who anticipate formula changes requiring production line alterations.
As the examples indicate, progress reports vary: they may cover one project or many, be addressed to people inside or outside the writer's organization, and be used by people with various reasons for reading them, such as learning what they need to know to manage and make decisions.
Readers' Concern with the Future
Despite their diversity, almost all progress reports have this in common: their readers are primarily concerned with the future. Even though most progress reports talk primarily about what has happened in the past, readers usually want that information so they can plan for and act in the future. Readers use the report to learn what they need to know to manage your project — for instance, what they should do to keep the project going smoothly or get it back on track. Some people also use the report to learn things needed to manage other projects, because almost all projects in an organization are interdependent.
For example, other departments may need the results of your project to work on their own projects. If your project is late, their schedules must be adjusted. If your project costs more, resources must be taken from other activities. Because of these interdependencies, readers need information about past accomplishments and problems so they can make plans for the future. Readers will also be interested in learning preliminary results of your work. If you complete one part of a research project before others, your audience may use that result immediately.
💡 Why this matters: Understanding that readers care about future implications helps you focus your progress report on information that enables decision-making, not just past activities.
The Questions Readers Ask Most Often
Readers' concern with the implications of your progress for their future work leads them to want answers to the following questions. If your report describes more than one project, readers will ask these questions about each project.
What work does your report cover? Readers must know what project or projects and what time period the report covers.
What is the purpose of the work? Readers need to know the purpose to see how your work relates to their responsibilities and to other present and future work of the organization.
Is your work progressing as planned or expected? Readers want to determine if adjustments are required in the schedule, budget, or the number of people assigned to the project.
What results did you produce? Results from one reporting period may influence work in future periods. Even in the midst of a project, readers want to know about results they can use in other projects.
What progress do you expect during the next reporting period? Readers focus on management concerns such as schedule and budget and on the kinds of results they can expect.
How do things stand overall? This question arises especially in long reports. Readers want to know the overall status of your work, which they may not be able to determine from all the details you provide.
What do you think we should do? If you are experiencing or expecting problems, readers will want your recommendations about what should be done.
Superstructure for Progress Reports
To answer your readers' questions, you can use the conventional superstructure for writing progress reports, which has the following elements:
- Introduction
- Facts
- Discussion
- Conclusions
- Recommendations
Introduction
In the introduction to a progress report, you should answer two questions:
- "What work does your report cover?"
- "What is the purpose of the work?"
You can usually answer the first question by opening with a sentence that tells what project or projects your report concerns and what time period it covers.
Sometimes you do not need to answer the second question because all readers are familiar with the work's purpose. At other times, it is crucial to tell your work's purpose because readers may include people who don't know or have forgotten it. This is especially likely when your written report will be widely circulated in your own organization or when you are writing to another organization that has hired your employer.
You can usually explain purpose most helpfully by describing the problem that your project will help readers solve.
📌 Example: "This report covers the work done on the Focus Project from July 1 through September 1. Sponsored by the U.S. Department of Energy, the aim of the Focus Project is to overcome the technical difficulties encountered in manufacturing photovoltaic cells that can be used to generate commercial amounts of electricity."
Facts and Discussion
In the discussion section of your progress report, you should answer three questions:
- "Is your work progressing as planned or expected?"
- "What results did you produce?"
- "What progress do you expect during the next reporting period?"
Answering Your Readers' Questions
In many situations, the work for each reporting period is planned in advance. In such cases, you can easily tell about your progress by comparing what happened with what was planned. Where there are significant discrepancies between the two, your readers will want to know the reason. The information you provide about the causes of problems will help readers decide how to remedy them and will help you explain any recommendations you make later.
When you are discussing preliminary results that readers might use, be sure to explain them in terms that allow readers to see their significance. In research projects, preliminary results are often tentative. If this is the case, let your readers know how certain or uncertain the results are. This information will help readers decide how to use the results.
When preparing progress reports, people often wonder how much information to include. Generally, progress reports are brief because readers want them that way. While you need to provide specific information about your work, don't include details except when the details will help readers decide how to manage your project or when you believe readers can make some immediate use of them.
In many projects, you will learn lots of little things and have lots of little setbacks and triumphs along the way. Avoid talking about these matters. No matter how interesting they may be to you, they are of little interest to those who need to manage your project or base their own decisions on the information you provide. Instead, focus on the important developments: tasks completed or not completed, discoveries or findings, and changes in schedule or budget.
Emphasizing Important Findings and Problems
Readers need to see the significance of the facts you present. For example, instead of just saying you completed a task, explain what that completion means for the project timeline or budget. When you encounter problems, explain their causes and potential impacts. This helps readers understand why certain actions may be necessary.
Conclusions
Your conclusions should provide an overall assessment of the project's status. This answers the question "How do things stand overall?" Readers want to know the big picture, not just a collection of details. If the project is on track, say so. If there are concerns about schedule, budget, or quality, state them clearly.
Recommendations
In the recommendations section, you answer the question "What do you think we should do?" If you are experiencing or expecting problems, your recommendations should suggest solutions. If you have ideas about how the project could be improved, they will probably be welcomed. Your recommendations should be based on the facts and discussion presented earlier in the report and should be realistic and actionable.
⭐ Key Takeaways
The most critical point to remember is that progress reports are fundamentally future-oriented — readers use information about past progress to make decisions about future actions, schedules, and resources. The seven key questions readers ask provide a complete framework for what every progress report must address: what work is covered, its purpose, whether work is on track, results produced, expected future progress, overall status, and recommendations. The conventional superstructure of introduction, facts, discussion, conclusions, and recommendations provides a reliable template for organizing content. When writing the discussion section, compare actual progress against planned progress and explain significant discrepancies, but keep the report brief by including only details that help readers manage the project or make immediate decisions. Finally, always emphasize the significance of findings and problems rather than just listing activities, because readers need to understand implications, not just facts.
🧠 Quick Revision Questions
- What are the two main objectives of a progress report?
- Why are progress report readers primarily concerned with the future rather than the past?
- Name the seven questions that readers ask most often when reading a progress report.
- What is the conventional superstructure for writing progress reports?
- When should you include details in a progress report, and when should you avoid them?
📘 Lecture 29 — Proposals
📖 Overview: This lecture introduces the proposal as a special type of analytical report designed to get products, plans, or projects accepted. It explains the variety of situations in which proposals are written, the mindset of readers as cautious investors, and the conventional superstructure that guides persuasive proposal writing across different lengths and formats.
🗂️ Topics Covered
This lecture covers the definition of a proposal and its role as an analytical report for gaining acceptance of ideas or projects. It explores the variety of proposal writing situations, including internal vs. external audiences, solicited vs. unsolicited proposals, and competitive vs. non-competitive contexts. The lecture frames proposal readers as investors who ask specific questions about problem, solution, costs, and capability. It details the conventional superstructure for proposals, which includes up to ten key sections: Introduction, Problem, Objectives, Product, Method, Resources, Schedule, Qualification, Management, and Costs. Finally, it discusses how the length of a proposal varies based on the readers' needs and the complexity of the project.
📝 Lecture Summary
Proposal
A proposal is a special type of analytical report designed to get products, plans, or projects accepted by outside business or government clients.
🔑 Definition — Proposal: A special type of analytical report designed to get products, plans, or projects accepted by outside business or government clients.
The Variety of Proposal Writing Situations
You may write proposals in a wide variety of situations. Your readers may be employed in your organization, or they may be employed in other organizations. Your readers may have asked you to submit a proposal, or you may submit it to them on your own initiative. Your proposal may be in competition against others, or it may be considered on its own merits alone. Your proposal may need to be approved by various people in your organization before you submit it to your readers, or you may submit it directly yourself. You may have to follow regulations concerning the content, structure and format of your proposal, or you may be free to write your proposal entirely as you think. Once you have delivered the proposal to your readers, they may follow any of the wide variety of methods for evaluating it.
Example — Situation 1: Helen wanted permission to undertake a special project to develop a computer system for reserving conference rooms. She wrote a proposal to her boss and her boss's boss. Because her employers had no specific guidelines, she could use any format, structure, and content. Her proposal was considered on its own merits and did not face competition from other departments, but it had to be persuasive enough to convince her readers that the project was worth her time.
Example — Situation 2: Three writers (a producer, a scriptwriter, and a business manager) sought funds from a non-profit organization and the federal government to produce television programs about the environment. They obtained copies of "requests for proposals" (RFPs) from the Government. Their proposal was evaluated by experts across the country, whose reviews were then studied by the Government staff. Before mailing the proposal, they had to obtain approval from several administrators at their station, as the accepted proposal would become a binding contract.
Proposal Readers are Investors
The proposals written by Helen and the three writers illustrate some of the differences between different proposal writing situations. Despite these differences, however, almost all proposal writing situations have two important features in common:
- In your proposals, you ask decision-makers to invest some resources, such as time and money, so that the thing you propose can be done.
- Your readers will make their investment decisions cautiously. They will be accurately aware that their resources are limited, that if they decide to invest in the purchase of projects you propose, those resources will not be available for other uses.
The Questions Readers Ask Most Often
As cautious investors, proposal readers ask many questions about purchases, projects, and other things proposed to them. But from situation to situation, the questions remain basically the same.
- Problem: Your readers will want to know why you are making the proposal and why they should be interested in it. What problems, need, or goal does your proposal address – and why is that problem, need, or goal important to them?
- Solution: Your readers exactly want to know what you propose to do and how it relates to the problem you described. They will examine carefully your responses, trying to determine whether it is likely that your overall strategy and your specific plan will work.
- Costs: What will your proposed product or activity cost your readers and is it worth the cost to them?
- Capability: If your readers pay or authorize you to perform this work, how do they know they can depend on you to deliver what you expected?
Strategy of the Conventional Superstructure for Proposals
The conventional superstructure for proposals is a framework for answering those questions, one that has been found successful in repeated use. When you follow this superstructure, you provide information on up to ten topics. Even in the briefest proposals, you will probably need to treat the following four topics: Introduction, Problem, Solution, and Costs.
When you provide information on these topics, you should do much more than provide data. You should also try to make persuasive points. Think of the ten topics as a sequence that leads your readers through a progression of thoughts:
- The readers learn generally what you want to do (Introduction).
- The readers are persuaded that there is a problem, need, or goal that is important to them (Problem).
- The readers are persuaded that the proposed action plan will be effective in solving the problem, meeting the need, or achieving the goal (Objectives).
- The readers are persuaded that you are capable of planning and managing the proposed solution (Method, Resources, Schedule, Qualifications, and Management).
- The readers are persuaded that the cost of the proposed action is reasonable in light of the benefits it will bring (Costs).
Consider how readers approach long proposals. Each volume of your proposal is evaluated by a different set of experts, specializing in their own domains. You can write keeping in mind a tightly focused proposal in which all the parts support one another effectively.
Various Lengths of Proposals
Some proposals are several volumes long, running into hundreds or even thousands of pages. On the other hand, some proposals are less than a page. How do you know how long your proposals should be? Sometimes you can be brief and still very persuasive. Often you need to touch upon only a few of the ten items.
For instance, Helen's proposal involved only one person and didn't need a management plan because her readers were already aware of her abilities. She only needed to justify her proposed schedule. In other situations, such as writing to NASA, you need to write lengthy proposals that fully address all ten topics. To decide how long a proposal should be, you must think about your readers, anticipating their questions and their reactions.
Superstructure of Proposals
The conventional superstructure represents only a general plan. You must use your imagination and creativity to adapt it effectively to your particular situation. The ten topics identify the kinds of information you need to provide, not necessarily the titles of sections you will include. In brief proposals, several topics are often grouped together under a single heading. The superstructure may be used with three common formats: letters, memos, and books.
Introduction
At the beginning of a proposal, you tell your readers what you are writing about by announcing what you are proposing. The introductory announcements vary considerably in length but are almost always very brief. By custom, writers reserve the full discussion of what they propose until later, after they have discussed the problem. You may be able to introduce your proposal in a single sentence, as Helen did: "I request a permission to spend two weeks writing, testing and implementing a program for scheduling conference rooms."
Problem
Once you have announced what you are proposing, you must persuade your readers that your proposed action will address a problem significant to them. Your description of the problem is crucial to the success of the proposal. You must not only define the problem but also make the problem seem relevant to the readers. When the readers define the problem for you (e.g., via an RFP), your primary purpose is to show you thoroughly understand what they want. When preparing a proposal on your own initiative, you need to devote research and creativity to find out what sort of problem your readers will consider important.
Product
When you describe the product your proposal will produce, you explain your plan for achieving the objectives. To describe your product persuasively, you need to do the following three things:
- Tell your readers how you reach your objectives.
- Provide enough details to satisfy your reader.
- Explain the desirability of the product of your project.
Method
Sometimes decision makers need to be assured that you can, in fact, produce the results you promise. This happens especially when you are offering something that takes special expertise – something to be customized or created only if your proposal is approved.
Resources
By discussing the facilities, equipment, and other resources to be used for your project, you assure your readers that the required equipment will be used properly. If part of your proposal is to request the equipment, tell your readers what you need to acquire and why.
Schedule
[This section was listed in the outline but not further detailed in the provided lecture text.]
Qualification
[This section was listed in the outline but not further detailed in the provided lecture text.]
Management
[This section was listed in the outline but not further detailed in the provided lecture text.]
Costs
[This section was listed in the outline but not further detailed in the provided lecture text.]
⭐ Key Takeaways
The most critical concept from this lecture is understanding that a proposal is an analytical report designed to persuade decision-makers to invest resources, and these readers act as cautious investors. The conventional superstructure, featuring up to ten topics (Introduction, Problem, Objectives, Product, Method, Resources, Schedule, Qualifications, Management, and Costs), is the proven framework for answering the readers' key questions about the problem, solution, costs, and capability. You must adapt this structure to your specific situation, remembering that the topics indicate the information needed, not necessarily the section titles, and they can be grouped together in brief proposals. Finally, the length of a proposal is determined by the complexity of the project and the depth of information your readers need to be convinced.
🧠 Quick Revision Questions
- What is the fundamental purpose of a proposal as described in the lecture?
- What are the two key features common to almost all proposal writing situations?
- What are the four questions readers, acting as investors, most often ask about a proposal?
- Even in the briefest proposals, which four topics from the superstructure must you almost always include?
- In what ways can proposal writing situations vary, according to the lecture?
📘 Lecture 30 — Instructions
📖 Overview: This lecture explores the craft of writing effective instructions, from simple one-line commands to complex multi-volume manuals. It emphasizes that instructions must do more than convey steps—they must shape reader attitudes, feature excellent visual design, and undergo rigorous testing. The lecture also presents the conventional superstructure that organizes instructions for maximum clarity and usability.
🗂️ Topics Covered
The lecture begins by examining the wide variety of instructions, from a single sentence for a license plate sticker to thousands of pages for aircraft engine maintenance. It then establishes three crucial points: instructions shape reader attitudes, good visual design is essential, and testing of instructions is often indispensable. The lecture explains how reader attitudes toward instructions directly affect compliance, why page design and visual aids are critical for usability, and why testing reveals hidden gaps in the writer’s knowledge. Finally, it details the conventional superstructure for instructions, covering the introduction elements (subject, aim, intended readers, scope, organization, usage, motivation, background) and the directions themselves.
📝 Lecture Summary
The Variety of Instructions
If you were to look at a sampling of the various kinds of instructions written at work, you would see that instructions vary greatly in length and complexity. The simplest and the shortest are only a few sentences long. Consider, for example, the instructions that the state of Ohio prints on the back of the 1 x 1-inch registrations stickers that Ohio citizens must buy and affix to their automobile license plates each year: "Position sticker on clean, dry surface in lower right-hand corner of rear plate (truck tractor front plate). If the plate has a previous sticker, you should place new sticker to cover old sticker. Rub edges down firmly." Other instructions are hundreds—or even thousands of pages long. Examples of these long and highly complex instructions are those written by General Electric, Rolls Royce, and McDonnell Douglas for servicing the airplane engines they manufacture. Other examples are the manuals that IBM, Control Data, and NCR write to accompany their large mainframe computers.
This chapter describes the superstructure for instructions in a way that will enable you to use the patterns for any instructions you write at work, whether long or short.
Three Important Points to Remember
While writing instructions, you should keep in mind the following three points:
- Instructions shape attitudes of the readers.
- Good visual design is essential.
- Testing of the instructions is often indispensable.
Each of these points is discussed briefly in the following paragraphs.
Instructions Shape Attitudes of the Readers
All the communications you write at work have a double aim: to help your readers perform some task and to affect your reader’s attitudes in some way. However, many writers of instructions focus their attention so sharply on the task they want to help their readers perform that they forget about their readers’ attitudes.
To write effective instructions, you must not commit this oversight. The most important attitude with which you should concern yourself is that of your reader’s toward the instructions themselves. Most readers dislike using instructions. When faced with the work of reading, interpreting, and following a set of instructions, they are often tempted to toss the instructions aside and try to do the job using common sense.
However, you and your employer will often have good reasons for wanting people to use the instructions you write. Maybe the job you are describing is dangerous if it isn’t done a certain way, or maybe the product or equipment involved can be damaged. Maybe you know that failure to follow instructions will lead many readers to an unsatisfactory outcome, which they might then blame on your employer.
For these reasons, it is often very important for you to persuade your readers that they should use your instructions. In addition, as an instructional writer, you may want to shape your readers’ attitudes toward your company and its products. If your readers feel that the product is reliable and that the company thoroughly backs it with complete support (including good instructions), they will be more likely to buy other products from your employer and to recommend those products to other people.
💡 Why this matters: Instructions are not just neutral guides—they are persuasive documents that can build trust in a company, prevent dangerous errors, and protect equipment and people.
Good Visual Design is Essential
To create instructions that help your readers and also shape their attitudes in the way you want, you must pay special attention to instructions. These include visual design, including both page design and the design of the visual aids such as drawings, charts, flow diagrams, etc.
Page Design: In instructions, you need to have a good page design for several important reasons. First, readers almost invariably use instructions by alternating between reading and acting. They read a step and then do the step, read the next step and do that step.
By designing your pages effectively, you can help your readers easily find the instructions for the next step each time they turn their eyes back to the page. This may seem a trivial concern, but readers quickly become frustrated if they have to search through a page or paragraph to find their required step. When readers are frustrated by a set of instructions, they may quit trying to use them.
Through good page design you can help your readers grasp quickly the connections between related blocks of material in your instructions, such as the connection between an instruction and a drawing or other visual aid that accompanies it. It is also important to remember that the appearance of instructions influences the readers to use or not to use them. If the instructions appear dense and difficult to follow or if they appear unclear and unattractive, readers may decide not even to use them.
Visual Aids: You can increase the effectiveness of most instructions by including visual aids. Well-designed visual aids are much more economical than words in showing readers where the parts of the machine are located or what the result of a procedure should look like. On the other hand, visual aids that are poorly planned and prepared can be just as confusing and frustrating for readers as poorly written prose.
Testing of the Instructions is Often Indispensable
It may seem that instructions are among the easiest of all communications to write and, therefore, among those that need to be tested. After all, when you write instructions, you usually describe a procedure you know very well. Your objective is to tell the reader as clearly and directly as possible what to do. Actually, instructions present a considerable challenge to the writer. You will find that it is often difficult to find the words that will tell your readers what to do in a way that they will understand quickly and clearly. Also, because you know the procedure so well, it will be easy for you to accidentally leave out some critical information because you don’t realize that your readers may need to be told it.
The consequences of even relatively small slips in writing even only a few directions in a set of instructions can be very great. Every step contributes to the successful completion of the task, and the difficulties the readers have with any step can prevent them from completing the task satisfactorily. Even if the readers eventually figure out how to perform all the steps, their initial confusion with one or two can greatly increase the time it takes them to complete the procedure. Furthermore, in steps that are potentially dangerous, one little mistake can create tremendous problems.
For these reasons, it is often absolutely necessary to determine for certain whether your instructions will work for your intended audience. And the only way to find this out for sure is to give a draft to representatives of your audience and ask them to try the instructions. Gather information without interfering with the readers’ activity.
Conventional Superstructure for Instructions
The conventional superstructure for instructions contains five elements:
- Introduction
- Description of the equipment (if the instructions are for running a piece of equipment)
- Theory of operations
- Lists of material and equipment
- Guide to trouble shooting
The simplest instructions contain only directions. The most complex instructions contain some or all of the other five elements, the selection depending upon the aims of the writer and the needs of the readers. Many instructions also contain elements found in longer communications such as reports and proposals.
Among these elements are cover, title page, table of contents, appendixes, list of references, glossary, list of symbols, and index. Because these elements are not particular to instructions, they will not be discussed here in this lecture.
As we discussed earlier, some instructions contain only directions and no introduction. However, readers often find an introduction to be helpful—or even necessary.
In the following example, you will see how to apply that general advice when you are writing instructions. The conventional superstructure for instructions tells some or all of the following things about instructions:
- Subject
- Aim
- Intended reader
- Scope
- Organization
- Usage
- Motivation
- Background
- Directions
Subject: Writers usually announce the subject of their instructions in the first sentence. Here is the first sentence from the operating manual of a ten-ton machine used at the ends of assembly lines that make automobile and truck tires. This manual tells you how to operate the "Tire Uniformity Optimizer." Here is the second sentence from the owner’s manual for a small, lightweight, personal computer: "This manual introduces you to the Apple Macintosh Computer." These sentences are intentionally kept simple for the sake of understanding.
Aim: From the beginning, readers want to know the answer to the question: "What can we achieve by doing the things this communication instructs us to do?" With some instructions you write, the purpose or outcome of the procedure described will be obvious. For example, most people who buy computers know many of the things which can be done with them. For that reason, a statement about what computers can do would be unnecessary in the Macintosh instructions, which in fact contain none. However, other instructions do have to answer readers’ questions about the aim of instructions.
In operating instructions for pieces of equipment, for example, writers often answer the reader’s questions about what the procedure will achieve by telling capabilities of the equipment. Depending upon your options to use the machine, it may do any or all of the following jobs:
- Test tires
- Find irregularities in tires
- Grind to correct the irregularities, if possible
- Grade tires
- Mark tires according to grade
- Sort tires by grade
Intended Readers: Many readers will ask themselves: "Are these instructions written for us or for people who differ from us in interests, responsibilities, level of knowledge, and so on?" Often readers will know the answer to that question without being told explicitly. In contrast, people who pick up computer manuals often wonder whether the manual will assume that they know more (or less) about computers than they do. In such situations, it is most appropriate for you to answer the question. You don’t need to know anything about the Macintosh or any other computer.
Scope: Information about the scope of the instructions answers the reader’s question: "What kinds of things will we learn to do in these instructions—and what things won’t we learn?" For example, the writers of a Tire Uniformity Manual would answer that question in their third or fourth sentence. The writers of the Macintosh manual answer the same question in this way: "This manual tells you how to use the mouse and keyboard to control your Macintosh."
Organization: By describing the organization of the instructions, writers answer the readers’ question: "How is the information given here put together?" Your readers may want to know the answer so they can look for specific pieces of information. They may want to know about the overall organization simply because they can then understand the instructions more rapidly and thoroughly than they could without the instructions. The writers of the Macintosh Manual announce its organization at the same time they tell the manual’s scope.
Usage: As they begin to use the set of instructions, readers often ask themselves: "How can we get the information we need as quickly as possible?" Sometimes the obvious answer is to simply follow the instructions sequentially.
⭐ Key Takeaways
A successful set of instructions must accomplish three critical goals: shape positive reader attitudes toward both the instructions and the company, integrate excellent visual design through effective page layout and clear visual aids, and be thoroughly tested with representative users to uncover hidden gaps or confusing steps. The conventional superstructure provides a reliable framework that typically includes an introduction (covering subject, aim, intended readers, scope, organization, usage, and motivation), a description of equipment, the theory of operations, a list of materials, and troubleshooting guidance. Writers must never assume their familiarity with a procedure translates into clear directions for others—testing is often indispensable. Finally, because readers frequently dislike using instructions, persuasion and clarity are not optional; they are essential for compliance, safety, and customer satisfaction.
🧠 Quick Revision Questions
- What are the three important points to remember when writing instructions, and why is each one critical for success?
- Why do most readers dislike using instructions, and what strategies can a writer employ to overcome this resistance?
- How does the alternating pattern of reading and acting influence the page design requirements for instructions?
- What is the conventional superstructure for instructions, and what are the five main elements it can contain?
- Why is testing of instructions often indispensable, and what is the recommended method for conducting such tests?
📘 Lecture 31 — Using Visual Aids
📖 Overview: This lecture explores how to effectively use visual aids in technical and business communication. It covers the definition, purpose, and guidelines for creating visual aids that clarify data, support arguments, and enhance reader comprehension.
🗂️ Topics Covered
The lecture begins by defining visual aids and explaining their role beyond mere decoration. It then discusses the role of computers in creating visual aids and provides comprehensive guidelines for their effective use, including clarifying numerical relationships, supporting arguments, considering reader tasks and attitudes, and integrating visuals with prose.
📝 Lecture Summary
Visual Aids
Visual aids can be defined as instructional aids such as posters, scale models, graphs, tables, diagrams, flow charts or videotapes, that present information visually. Visual aids can be a great way of enhancing a presentation visually when they are used sensibly and with a clear purpose. Visual aids can add a new dimension to presentations.
More than Just Visual Aids
In some situations, visual aids can carry the entire message. For instance, if you’ve ever flown, you may recall reaching the pocket on the back of the seat ahead of you to pull out a sheet of instructions for leaving the plane in an emergency. Many airlines use sheets that are wordless.
💡 Why this matters: This demonstrates that visual aids can be so effective that they completely replace text, making instructions universally understandable across language barriers.
Computers and Visual Aids
For instance, if you are using a program to make a line graph, you will still have to decide which variable to place on the horizontal axis and which on the vertical axis. You will still have to decide what intervals to use for your variables, and what your labels should say. Even with software, the human decisions about design and clarity are essential.
Guidelines
The first step in using visual aids effectively is to search actively for places where they can help you achieve your communication objectives.
Clarify the Relationships Among Numerical Data
On the job, you may need to describe the relationships among various pieces of data, which may be from laboratory research, surveys, etc. Visual aids can help you make those relationships immediately clear to your readers using graphs and other visual techniques.
Support Your Arguments
You can also use visual aids to present information in support of your persuasive points. For example, the manufacturer of a plastic insulating material can use visual aids like graphs to persuade greenhouse owners of the comparable effects of different kinds of plastics.
Make Detailed Information Easy to Find
For many tasks, visual aids are much easier than prose for readers to use. For example, a manufacturer of photographic film wants to inform trainees about the time period they should leave the film in the developer solution. Since the time depends on several factors like tank size, and temperature, the information can be conveyed effectively using a simple table.
Consider Your Readers’ Tasks
Different visual aids are suitable for different reading tasks; often the same information can be presented in many different ways. For instance, Ben has collected information on the starting salaries of people who graduated from three different departments. Which visual aid should he use? The choice depends on what the reader needs to do with the information.
Consider Your Readers' Attitudes
In addition to thinking about your readers’ tasks, you should also look to pick the type of visual aid that most quickly and dramatically communicates the evidence that supports your persuasive point. For instance, showing the effect of a decrease in revenue in a line graph is much more suitable than a tabular form which requires the readers to do a lot of subtracting to appreciate the extent of the decrease. Although they are very informative to people who understand the symbols and conventions used, they will only baffle others. Be especially careful to avoid making the mistake of assuming your potential readers know how to read specialized figures.
Make Your Visual Aids Simple
Avoid the temptations of cramming too much information into your visual aids. Sometimes, two or three visual aids can communicate the same information more effectively than one. Simplifying visual aids also means removing unnecessary details.
Label the Important Content Clearly
(This section title appears in the outline but is not elaborated in the provided lecture text. The principle implies that every important element in a visual aid must be clearly labeled to avoid confusion.)
Provide Informative Titles
(This section title appears in the outline but is not elaborated in the provided lecture text. The principle implies that every visual aid should have a title that tells the reader exactly what it contains.)
Fully Integrate Your Visual Aids With Your Prose
(This section title appears in the outline but is not elaborated in the provided lecture text. The outline lists three sub-points for this section:)
- Introduce Your Visual Aids in Your Prose: Refer to the visual aid before the reader sees it.
- State the Conclusions You Want Your Readers to Draw: Tell the reader what to look for.
- Make Your Visual Aids Easy to Find: Place them near the relevant text.
⭐ Key Takeaways
Visual aids are powerful communication tools that can carry entire messages, as seen in wordless airline safety cards. Their effective use requires careful planning: you must choose the right type of visual for your readers' tasks and attitudes, with line graphs being more dramatic than tables for showing trends. Visual aids must be kept simple and clearly labeled to avoid overwhelming the reader. Finally, all visual aids must be fully integrated with your prose—introduced, explained, and placed near the relevant text—to guide the reader's understanding.
🧠 Quick Revision Questions
- What are three examples of visual aids mentioned in the lecture?
- Why does the airline emergency instruction sheet serve as an example of "more than just visual aids"?
- When deciding between a table and a line graph to show a decrease in revenue, which visual aid is more suitable and why?
- What is the first step in using visual aids effectively, according to the lecture?
- How should you "fully integrate" your visual aids with your written text?