What to Include in Every User's Guide
Below is a hierarchical breakdown of the information that should normally be included in a User's Guide. Of course, not all products are the same. Your company may produce only software applications or it may produce equipment run by customized software. You may have a product that is simple to run, or you may have a product that requires multiple types of operators and an extensive array of operating instructions. It is not expected that every item on the list will apply to your situation or that all items will fit into a single volume. You should feel free to eliminate that which does not apply and to turn sections into volumes of their own. The point is to determine in advance what will be required to make your documentation successful.
Section 0: Front Matter
Document Controls
Manual Revision Status
Hardware Model/Version Covered
Software Release/Version Covered
Other Related Documents
Preface
Table of Contents
List of Figures
List of Tables
List of Schematics
Section 1: Introduction
What's New
About This Guide
What This Guide Covers
Who Should Read This Guide
User Prerequisites
How This Guide Is Organized
Conventions
Section 2: Getting Started
Safety, Shutdown, and Startup
Safety
Identification of Target Audience and Scope of Information
General Safety Instructions
Summary of Hazards
General System Information (including required safe operating environment requirements)
Reference User and Service Engineer Maintenance Schedules
Laser Safety
General Laser System Information
Potential Hazards
Safety Features
Safety Instructions
Electrical Safety
General Electrical System Information
Potential Hazards
Safety Features
Safety Instructions
Mechanical Safety
General Mechanical System Information
Potential Hazards
Safety Features
Safety Instructions
Fire Safety
General Fire System Information
Potential Hazards
Safety Features
Safety Instructions
Chemical Safety
General Chemical System Information
Potential Hazards
Safety Features
Safety Instructions
Seismic Safety
General Seismic System Information
Potential Hazards
Safety Features
Safety Instructions
Personal Protection (including ergonomics and proper attire)
What To Do in the Case of Accidents
Emergency Power-Off
General System Information
When To Perform Emergency Power-Off Procedures
The Emergency Power-Off Procedures
Shutdown
What You Should Know
Order of Procedures and Shutdown of System Units
Power Down Procedures of System Units
Lockout/Tagout
Startup
What You Should Know
Order of Procedures and Startup of System Units
Power Up Procedures of System Units
Basics
System Overview
Marketing Intro
Description of Subsystems
Purpose/function
Configuration
(Features supplied/options available)Functions of the System
(including an explanation of how the system works)Task/Process Overview
What an Operator Should Know
Summary of Responsibilities
Terms and Concepts
System Features
A Look at the System
Buttons, Switches, Tape Drives, Access Doors, Service Panels, etc.
GUI Features
Screens, Features, Functions
(description and basic procedures for their use)
Section 3: Operation Tasks
Task/Process Introduction
(including repeat of Task/Process Overview)
Task 1
Task 2
etc.
Section 4: Improving Performance (and Troubleshooting)
Task/Process Introduction
Task 1
Task 2
etc.
Section 5: Back Matter
Appendices
Glossary
Revision History
Index