Chapter 15 Instructions, User Manuals, and Standard Operating Procedures
Why Write Instructions: Instructions help people do things the right way. Effective communication through instructions saves lives, time, and money. Criteria for Writing Instructions: You have most likely read some bad instructions before. The following will help you know how to write instructions efficiently. Audience Recognition: Consider the audience to who you are writing to. If it is a children’s toy, you should probably not use long and complicated words. Ethical Instructions: Correctly citing the sources of information will help you avoid plagiarism. Components of Instructions: Using numbered steps make instructions easier to read one at a time. Title Page: The title page is meant to look bold and stand out. It lets the reader know what they are about to read instructions about. Safety Requirements: Safety requirements are very important. You want to mention the safety concerns to help prevent consequences. Table of Contents: The Table of Contents organize your instructions. If people only want to read one step, they’ll know what page to go to. Introduction: A friendly and easy way to introduce your topic. Let the reader know what they are dealing with. Glossary: A glossary is good for difficult words. Sometimes, they will need to be in the instructions, so be sure to define what you are putting into them. Required Tools or Equipment: This provides an organized list of what the user needs to have or find. Instructional Steps: The actual actions required by the audience to complete a task. Additional Components: Extra material the customer needs to know that isn’t related to the task, such as technical descriptions, warranties, accessories, frequently asked questions, and corporate contact information. Graphics: Clarifying your points graphically, by using drawings, photographs, and screen captures. Collaboration to Create User Manuals: Having other people to help you make user manuals provides more information and critiques on what you had wrote. Instructional Videos: Videos are another way to depict the instructional steps. They are also easier to follow, as it will show on screen what to do to complete the task. Standard Operation Procedure (SOP): A set of written instructions that documents routine or repetitive technical or administrative activities followed by business and industry. Reasons for Writing an SOP: SOPs insure accurate job performance and consistent quality and integrity of the product. Components of SOPs: SOPs contain a title page, scope and applicability, summary of method, interferences, personnel qualifications/responsibilities, equipment and supplies, data and records management, quality control and quality assurance, and references. Test for Usability: Testing the SOPs and making sure they are usable and readable. Sample Instructions: How to take a photo on a cell phone is an example of instructions. The Writing Process at Work: Prewriting: Preview your ideas. Writing: Writing your paper. Rewriting: Edit and revise it.
Learn Mandarin Chinese with Paul Noble for Beginners – Complete Course: Mandarin Chinese Made Easy with Your 1 million-best-selling Personal Language Coach
Surrounded by Idiots: The Four Types of Human Behavior and How to Effectively Communicate with Each in Business (and in Life) (The Surrounded by Idiots Series) by Thomas Erikson: Key Takeaways, Summary & Analysis
Body Language: Decode Human Behaviour and How to Analyze People with Persuasion Skills, NLP, Active Listening, Manipulation, and Mind Control Techniques to Read People Like a Book.