Techcommunicators.com | WRM Home | Writing Styleguide | Dictionary of Plain English | Feedback | Glossary | Index
 

4   Standard Contents

Introduction

Most manuals include an introduction at the front. When readers pick up the manual for the first time, they will know:

  • the purpose of the manual and why it was written
  • who wrote it
  • who the manual is for
  • how it’s structured and organized
  • how to find information
  • what information it contains (chapter by chapter)
  • typographic conventions used
  • how to update the manual when revised modules are issued
  • how to get additional copies of the manual

The introduction may also acknowledge contributors to the manual, or others who aided in its completion, or this may be done under a separate heading.