User Manuals
User manuals are the most common type of external documentation. Typically, user manuals include:
- Instructions for using the product.
- Operational warnings and cautions about misuse.
- Troubleshooting information.
The size of user manuals generally corresponds to the complexity of the product. For straightforward products, a user guide or quick start guide of just a few pages may be sufficient, with further information available from another source (service team, web page).
Service Manuals
Service manuals give maintainers information on the regular actions required to keep equipment operating. This requires an understanding of the serviceable components and what needs to be done to them to maintain their function.
Disseminating or referencing information from your suppliers’ manuals often becomes important where they are integrated into your product and need to be serviced in the field.
Parts Manuals
Parts manuals give you details about the parts that make up the product and how they fit together. A parts manual separate from the service manual makes sense when the following conditions are true:
- There are a large number of parts.
- The product design means that parts can be replaced.
- Replacement parts are available.
Installation, Operation and Maintenance (IOM) Manuals
IOM manuals are usually combined documents of the user, service and parts manuals, but include an installation component for fixed equipment.
