You are on page 1of 2

To: Nancy Myers

From: Karen Simonyan


Date: October 18, 2022
Subject: APLED 121-Chapter 15 Summary

CHAPTER 15
INSTRUCTIONS, USER MANUALS, and STANDARD OPERATING PROCEDURES

Why Write Instructions


Instructions help users to operate, set up, change, install, assemble, or make something.
Criteria for Writing Instructions
• Audience Recognition – Provide detailed instructions on how to do something without
assuming anything, and spell it all out – clearly and thoroughly.
• Ethical instructions – Instructions should include information that warns the audience of
potential dangers and sets limits and exceptions for product guarantees.
• Title page – The instructions need to have a title page that would explain why the
instructions are being written
• Safety Requirements – To make the audience aware of possible dangers, warnings, and
cautions, you can place safety requirements anywhere.
• Table of Contents – Instructional manual could involve several sections such as
guarantees, technical specifications, and warranties.
• Introduction – To have satisfied customers, instructions often are reader-friendly, and
manuals try to reach them in a personalized way.
• Glossary – To avoid misunderstanding and missing important information in advance
define your abbreviations and technical terms.
• Required Tools or Equipment – Provide all necessary equipment and tools to do the
task completely.
• Instructional Steps – These are the vital part of your manual that requires and provides
actual actions to complete a task.
• Additional Components – These components are optional and might include
warranties, accessories, technical descriptions, frequently asked questions, and
corporate contact information.
• Graphics – P Depends on your audience you can use drawings photographs, and
graphics to make your points more visually appealing.

Collaboration to Create User Manuals


People who write user manuals need to work collaboratively to provide process effectiveness.

Instructional Videos
Videos are another way to show your steps graphically and clearly.
Standard Operating Procedures
• Reasons for Writing an SOP – Here are a few reasons to use SOPs:
a) Analyzing test data
b) Collecting lab samples
c) Calibrating and standardizing instruments
d) Troubleshooting equipment, machinery, and procedures

• Components of SOPs – These contain many of the same components as user manuals such as Title
Page, Definition of Terms, References, Equipment and Supplies, Table of Contents, and Safety
Warnings and Cautions.
• Test for Usability
a) Select a test audience
b) Ask the audience to test the instructions
c) Monitor the audience
d) Time the team members
e) Quantify the audience’s responses

• Sample Instruction – For example provide the steps on how to open the Gallery on your
smartphone, chose the photo, resize it, save and print.

The Writing Process at Work


• Prewriting – Collect data
• Writing – Make a draft with commentaries
• Rewriting – Review and save the topic or document.

You might also like