User Manual
A user manual is the document containing the product's wiring diagram, adjustment steps, operating limits and maintenance information, and is part of the delivery. It is an output delivered just as much as the product itself: a connection or adjustment not defined in the manual means it has been left to guesswork in the field.
The sections a manual is expected to carry on an industrial product are as follows:
- Technical data: supply range, current values, ambient temperature and operating limits.
- Wiring diagram: connector pin definitions, cable colour or number correspondences, fuse and earthing point.
- Installation steps: mechanical mounting, wiring order and first start-up checks.
- Settings and parameters: the meaning, range and factory value of each parameter.
- Fault table: symptom, possible cause and the check to be carried out.
- Maintenance: periodic checks and replaceable parts.
The manual is updated together with the board revision and the software version; which version it belongs to is written on it. In custom development projects, the scope of the documentation to be delivered is determined from the outset as an item of the technical specification; this way the manual stops being a job remembered after production is finished.
The context in which this term is used: Our Services