GuidelineForWritingReports.ppt

User Manuals come in all types, designs and formats. This presentation is designed to show a few basic elements that will serve any user manual. Not every manual will include each of these sections, or will organize them in this order. A cover page should accomplish two things: 1. Name the product being discussed 2. Explain the purpose of the manual. Consider that the cover page might include a picture of the product featured or a company logo. Stating potential risks, alerts, and safety guidelines are key components to a hazard alert page. A hazard alert is crucial in order that employees are protected against potential danger. An effective table of contents is just as important as the content of the manual. Consider that your readers may want to go directly to a specific section, which requires a precise table of contents. The introduction is a customer or employee’s first encounter with the company’s writing. Using pronouns like “you,” “your,” and “our,” make customers or employees feel included and add a personal touch. Remember that using upbeat words like “Welcome,” “Thank You,” and “pleasure” aid in establishing a rapport with the customer or employee early. Since every company uses different jargon and abbreviations, it is imperative to define these terms early in the manual. You may want to consider defining not only abbreviations but also acronyms and symbols as well. In addition to a definition list at the onset of the manual, a glossary at the end is an option. This section gives the employee or customer a detailed description of each part of a system’s components. These descriptions aid the reader when later using instructions to assemble or fix a product. In addition, this section might contain the exact specifications of a product like: “size, shape, capacity, capability and materials of construction.” The warranty not only protects the customer but the manufacturer as well. If a product malfunctions, the warranty will inform th