Scribd Logo
Upload

Welcome to Scribd!

  • 55 views

    Chapter 15 Summary

    Uploaded by

    api-550234793
    This document provides guidance on writing effective instructions, manuals, and standard operating procedures (SOPs). It outlines key criteria such as considering your audience, including safety requirements, using a table of contents and numbering steps. It also discusses using graphics for clarity and collaboration when creating manuals. Videos can clarify steps. SOPs document routine tasks to ensure consistent performance and quality. The writing process involves prewriting topics, writing details between topics, and rewriting to proofread.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd

    Chapter 15 Summary

    Uploaded by

    api-550234793
    55 views3 pages
    This document provides guidance on writing effective instructions, manuals, and standard operating procedures (SOPs). It outlines key criteria such as considering your audience, including safety requirements, using a table of contents and numbering steps. It also discusses using graphics for clarity and collaboration when creating manuals. Videos can clarify steps. SOPs document routine tasks to ensure consistent performance and quality. The writing process involves prewriting topics, writing details between topics, and rewriting to proofread.

    Original Title

    chapter 15 summary

    Copyright

    © © All Rights Reserved

    Available Formats

    PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    This document provides guidance on writing effective instructions, manuals, and standard operating procedures (SOPs). It outlines key criteria such as considering your audience, including safety requirements, using a table of contents and numbering steps. It also discusses using graphics for clarity and collaboration when creating manuals. Videos can clarify steps. SOPs document routine tasks to ensure consistent performance and quality. The writing process involves prewriting topics, writing details between topics, and rewriting to proofread.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Download as pdf or txt
    55 views3 pages

    Chapter 15 Summary

    Uploaded by

    api-550234793
    This document provides guidance on writing effective instructions, manuals, and standard operating procedures (SOPs). It outlines key criteria such as considering your audience, including safety requirements, using a table of contents and numbering steps. It also discusses using graphics for clarity and collaboration when creating manuals. Videos can clarify steps. SOPs document routine tasks to ensure consistent performance and quality. The writing process involves prewriting topics, writing details between topics, and rewriting to proofread.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Download as pdf or txt
    You are on page 1of 3

    To: Nancy Myers

    From: Jeff Johns


    Date: April 28, 2021
    Subject: APLED 121- Chapter 15 Summary
    Chapter 15 Summary
    Instructions, user manuals, and standard operating procedures

    Why write instructions?


    Instructions help people with a wide variety of tasks, for instance:
    • Operate a mechanism
    • Install equipment
    • Manufacture a product
    • Test components
    • Service equipment
    • Assemble a product
    Criteria for writing instructions
    Follow these criteria for writing instructions to be successfully understood.
    • Audience recognition
    As the writer, you should provide readers with the clarity and thoroughness required to
    complete the task. It is important to write for a lay person as well as a high-tech audience.
    • Ethical instructions
    Clearly and correctly citing sources will help avoid plagiarism.
    • Components of instructions
    Not every set of instructions will contain the same components.
    • Title page
    Title pages should consist of: the topic, it’s purpose, and a graphic for visualization.
    • Safety requirements
    To avoid liability issues, correctly use hazard notifications before the hazardous step. Hazard
    notifications should consider access, (make them obvious), definitions, (example: what does
    caution mean), colors, (helps it be noticed), text (to clarify terminology), and icons (to help
    everyone understand the danger).
    • Table of contents
    Allows readers quick and easy access to the needed information.
    • Introduction
    Should include pronouns (you and your) and positive words (thank you and pleasure) to create a
    positive interface with the customer.
    • Glossary
    Define abbreviations and technical terms for added clarity.
    • Required tools or equipment
    Provide a list or graphic of needed tools to complete the project.
    • Instructional steps
    ➢ Organize the steps chronologically
    ➢ Number the steps
    ➢ Use highlighting techniques
    ➢ Limit information of each step to avoid overload
    ➢ Develop your points thoroughly
    ➢ Use short words, sentences, and paragraphs
    ➢ Begin your steps with verbs
    ➢ Do not omit articles
    • Additional components
    Additional components can be technical descriptions, warranties, accessories, frequently asked
    questions, and corporate contact information.
    • Graphics
    Graphics make instructions visually appealing and provide clarity
    Collaboration to create user manuals
    User manuals are often complex, by utilizing team members with different job functions the
    manual can be more well rounded.
    Instructional videos
    A video can be more informative than text, including clarifying hazard alerts and can help the
    user perform a step more successfully.
    Standard operating procedures (SOP)
    Standard operating procedures are a set of written instructions that document routine technical
    or administrative tasks followed by industry.
    Reasons for writing an SOP?
    SOP’s help to ensure accurate and consistent job performance resulting in consistent quality of
    the end product.
    • Components of SOP’s
    ▪ Title page- the topic you are writing about
    ▪ Table of contents
    ▪ Scope and applicability- provide an overview for the audience
    ▪ Summary of method- brief summary of the procedure
    ▪ Definition of terms
    ▪ Safety warnings and cautions
    ▪ Interferences- parts of the procedure that may interfere with the accuracy of
    the final product
    ▪ Personnel qualifications/responsibilities- the required certifications and
    experience of whoever is performing the SOP
    ▪ Equipment and supplies- tools and equipment needed
    ▪ Procedures
    ▪ Data and records management- required forms, tools and equipment
    ▪ References- helps avoid plagiarism
    Test for usability
    Select a test audience to ensure the document is understood.
    Sample instructions
    The writing process at work
    • Prewriting
    Include needed information to ensure all points get covered, gives you a starting point.
    • Writing
    Fill in the details between the prewritten topics, adding the necessary clarity.
    • Rewriting
    Go back over what you have written, proof read and finalize your document.

    You might also like