You are on page 1of 2

To: Nancy Myers

From: Richard Black


Date: October 13, 2022
Subject: APLED 121- Description/Analysis Report
___________________________________________________________________________________________

CHAPTER 15
Technical Instructions
Why Write Instructions?
Almost every manufactured product requires a set of instructions detailing how to use, install,
or repair it. Making sure the user understands how to operate or install a piece of equipment
will help achieve efficiency and safety.

Criteria for Writing Instructions


• Audience Recognition – Not every reader will be skilled in the technology they are
reading into. It is purpose of an instruction manual, to explain each step clearly and
concisely, so the steps can be followed precisely without extensive prior knowledge.
• Ethical Instructions – Instruction Manuals have a requirement to state the dangers
of any process, or misuse of the product. Also providing readers with up-to-date
instructional information, improved construction, or assembly processes to avoid
time and labor waste.
• Components of Instructions
o Title Page – explain the name and topic of the object, or procedure the
instructions relate to. A Pre-Face, explaining what it is people are about to
read.
o Safety Requirements – Indicate each step that may result in injury or
damage to a machine. Give notice of the dangers a step will present prior to
showing the step. Box warning labels, use graphics, and different font sizes to
draw attention to any hazards.
o Table of Contents – complex instruction manuals are divided into many
parts. These parts or organized by the Table of Contents which allows
readers to quickly find
o Introduction
o Glossary
o Required Tools or Equipment
o Instructional Steps
o Additional Components
o Graphics
Definition of Process Analysis
Where instructions provide information of how to complete a task, Process Analysis explains
how a system works. For example: how metal detectors work, or how an email is received.

Examples of Process Analysis


To decide on what type of bridge to build for a given location, the features and capabilities of
each bridge type must be considered.
To: Nancy Myers
From: Richard Black
Date: October 13, 2022
Subject: APLED 121- Description/Analysis Report
___________________________________________________________________________________________

A team of scientists is researching a new treatment for diabetes. They require additional
funding for research. To get this funding, they must explain the treatment process they
developed to new investors.

Criteria for Writing Descriptions and Process Analysis


• Title – Preface your text with a title precisely stating the topic.
• Overall Organization – In the introduction, specify and define your topic and
explains the topics function, capabilities, or processes. You can also use a list of
components, parts, or equipment.
• Highlighting Techniques – Highlighting can bring attention to specific parts,
dimensions, or capabilities, that need to be the focus of the presentation.

The Writing Process at Work


• Prewriting – Outlining the key points of a message and how it needs to be
presented.
• Writing – Create a rough draft, following the focal points, providing the bulk or
substance of the message.
• Rewriting – Editing, formatting, and more editing. Tweaking and fixing issues in the
message. Re-reading the message back to yourself to see if it can be misinterpreted
and if so, how? Then fixing those mistakes until the final message is as clear and
concise as possible.

You might also like