1 / 9

Parts of a User Manual

Parts of a User Manual. Criteria for writing a user manual User manual components. Criteria for Writing a User Manual. Requires more detail than you can fit into one instruction Focus may vary: installation, operation, maintenance, software use, etc. Size may vary depending on topic

choelscher
Download Presentation

Parts of a User Manual

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Parts of a User Manual Criteria for writing a user manual User manual components

  2. Criteria for Writing a User Manual • Requires more detail than you can fit into one instruction • Focus may vary: installation, operation, maintenance, software use, etc. • Size may vary depending on topic • Includes instructions plus additional components

  3. Criteria for Writing a User Manual • Long User’s Manuals include all of the topics already discussed: • Graphics • Hazards • Required tools • Detailed information geared toward the audience • An appropriate style (numbered steps, articles, verbs, personalization, etc.)

  4. User Manual Components • Cover page • Topic – names product or service • Function (purpose) • Graphic • Table of contents • List of Figures • List of Tables

  5. User Manual Components • Introduction / Overview / About this Manual • What do you need to know to make the best use of this manual? • Personalized, positive tone • Emphasizes the value and importance of the manual • How this manual is organized • How to use this manual • Special icons or symbols used in manual

  6. User Manual Components • Glossary—define acronyms, abbreviations, and high-tech terms • May be separate section or part of overview • Alerts and special considerations • Warnings, hazards, dangers • Technical description (hardware) • Parts lists/accessories

  7. User Manual Components • Instructions listed as tasks • Other possible sections: • Warranties/guarantees • FAQs • Troubleshooting • Corporate Contact information • Index

  8. Components – Index • Might be in addition to the general end matter • Helps readers locate specific information within a manual • Generally lists words and concepts alphabetically • Identifies where readers can reference information in the manual

  9. Usability Testing • Usability Testing—another approach to Revision: • Choose a test audience. • Ask the audience to test the instructions. • Monitor the audience. What challenges do the instructions seem to present? • Time the team members as they attempt to perform the tasks. • Quantify the audience’s responses. What problems did they encountered. • Revise the instruction to improve its usability.

More Related