When a machine is delivered to site, the thickest volume of the accompanying documents is usually treated as the manual for the operator. But at least four kinds of person actually open it, and the pages they care about hardly overlap. Writing for one person out of four leaves everybody awkward.
Four readers, four ways of reading
The operator cares about the normal sequence: how to start the machine, how to begin feeding oil, how to read the temperature control and the vacuum level, and when to stop. He reads it several times a day, and what he needs is a single sheet he can act on, not the principle behind it.
The maintenance technician cares about faults: from the symptom to the cause and the order of checks. He reads the fault section of the contents and nothing else.
The shift supervisor cares about state and exceptions: which readings count as normal in operation, what an alarm means, and when to call someone. He needs to find the answer in the shift room in the shortest possible time.
The storekeeper and the buyer care about consumables and spare parts: what the model number of the filter element is, how many to keep in stock, and how the wear parts are ordered. That information is usually buried deep in the manual.

| Role | The question they bring to it | The section that answers it |
|---|---|---|
| Operator | How do I run this batch of oil today | Operating sequence and normal parameters |
| Shift supervisor | Is this reading normal | Table of operating parameters and the alarm descriptions |
| Maintenance technician | Where do I start with this symptom | Fault troubleshooting table |
| Storekeeper and buyer | How do I order this part | List of wear parts and consumables |
Four sequences must not be mixed
A manual usually holds four sequences: normal operation, maintenance, fault troubleshooting, and the purchase and replacement of consumables. The four have different starting and finishing points, and written as one timeline they leave the reader to reassemble them. Divided into four parts, each standing on its own, the search at least has a clear direction.
The parameter tables belong with the sequences as well. Normal parameters belong in the operating section, not in the maintenance chapter. The working vacuum of the ZYD series is -0.08 ~ -0.0999 MPa, the filtration accuracy ≤1 μm, the cleanliness NAS 1638 class 5, and the temperature control range 45–80 °C. These figures are used every day when judging a run, and hardly ever in the maintenance chapter.
What does not need to be in the manual
- Parameter tables for models that have nothing to do with the site. The thicker the file, the harder it is to find the page you want.
- Commercial clauses that repeat the contract. The technical file and the commercial file are kept apart, and each is clear on its own.
- Long explanations of the principle. The operator needs to know how to operate, not to read the theory while operating.
- The full original factory test records. That belongs to the delivery documentation, not to the material people consult day to day.
Someone still has to maintain it after the handover
Machine parameters change and configurations change, and the manual has to change with them. The way to maintain it is to update the manual every time a parameter is changed, and to record the version and the date in the file so that the site knows which version it is reading. One parameter library and one manual are the precondition for the manual being of any use.
One more small thing is worth doing: copy the few pages each role reads most often and put them up at the corresponding working position, a photocopy is enough. The complete file stays in the cabinet, and fewer people take it out than need it.
Write the manual by reader rather than by machine. Each of the four has their own pages, and putting them together means nobody is served.
