User Manuals & SOPs (1)

You might also like

Download as pptx, pdf, or txt
Download as pptx, pdf, or txt
You are on page 1of 31

Instructions, User Manuals and Standard

Operating Procedures (SOPs)

Prepared By:
Sumayyah Malik
Why & when write an Instruction?
Introductory Lines

Introducing
Instructions s

Instructions

Concluding Lines
When should you include instructions or user manuals?

Operate a Collect lab Install Use an Manufacture


mechanism specimens equipment autoclave a product

Service Package a Troubleshoot Perform lab Use


equipment product a system experiments software

Test Set up a Maintain Implement a Clean a


components product equipment procedure product

Assemble a Repair a
product system
Criteria for Writing Clear Instructions
Audience Ethical
Recognition Instructions

Components of Instructional
Instructions Steps

Additional
Graphics
Components
Audience Recognition
To overhaul the manual starter, proceed as follows:
Remove the engine’s top cover. Untie the starter rope
at the anchor and allow the starter rope to slowly wind
onto the pulley. Tie a knot on the end of the starter
rope to prevent it from being pulled into the housing.
Remove the pivot bolt and lift the manual starter
assembly from the power head.
Ethical Instructions

Legalities in User
Manuals

Practicalities in User
Manuals
Components of Instructions
How will you the title of the User Manual
of iPod?
Safety
Requirements
Introduction
Positive Vocabulary

Personal Pronouns
Glossary
Abbreviations

Definitions
Required Tools or Equipment
Instructional Steps

Organize Number Use Limit


• the Steps • your Steps • Highlighting • the Information
Chronologically Techniques within Each
Step

Develop Use Begin


• your Points • Short Words, • your Steps with • Do not Omit
Thoroughly Sentences and Verbs Articles
Paragraphs
Highlighting
Techniques
Chronological Order
& Numbering Use Short Word and
Sentence

Do not Omit Articles

Begin your Steps with


Verbs
Additional Components
Additional Warranties
Components
Accessories

Frequently Asked
Questions

Corporate Contact
Information
Graphics
Standard Operating Procedures (SOP)

• An SOP is a set of written instructions


that documents routine or repetitive
technical or administrative activities
followed by business and industry
Why are SOPs important?
• Calibrate and standardize instruments
• Collect lab samples
• Handle and preserve food
• Analyze test data
• Troubleshoot equipment, machinery, and procedures
• List mathematical steps to follow for acquiring data
and making calculations
• Assess hardware and software analytical data
Key Components
Topic
Purpose
Date

Routing List

Title Page
Scope & Applicability
Summary of Method

Title of Sequence of Sequence of


Their Roles
People Their Activities
and Duties
Involved Involvement Performed
Interferences

Humidity Temperature Depth Altitude

Weather Cleanliness Carelessness Sample Size

Contamination
Personnel Qualifications/Responsibilities

Required
experience and Years of
certifications of experience
the individuals

Continuing
Courses taken education hours
completed
Equipment &
Supplies
Data & Records Management
• Calculations to be performed during the procedure
• Forms for the reports
• Required reports
• Reporting intervals
• Report recipients
• Process to follow for recording and storing data and
information generated by the SOPs
Quality Control & Quality
Assurance
References
• Cite the documents or procedures used
• Include documentation of additional SOPs referenced
• Literature used for research
• Any additional instruction manuals used for reference
• Attach copies of the documents if they are not readily
available to your potential audience.
Class Task

You might also like