Short answer
Your manuals work in a breakdown if, at three in the morning, a technician can find within minutes the current version, in a language they understand, with legible schematics, the commercial part number and the meaning of the error code. Score each of the seven criteria in this guide from 0 to 2 on a real machine and you will see where the gap is.
Having the manuals “somewhere in a folder” is not the same as being able to use them while the machine is down. This guide is not based on any study or statistic: it is a method to audit your own documentation, machine by machine, using one hour of work and a recent breakdown as the test case.
1. Checklist: seven criteria to know whether your manuals are usable
Pick one critical machine and check each point against the actual manual, not against what you believe is there.
- Language: is the manual in the language of whoever does the work? A manual only in the manufacturer's language forces translation mid-diagnosis, and nuance is lost in safety warnings.
- Current version: does it match your machine's serial number and revision, including later modifications? A manual for another revision may show wiring or parts that no longer exist.
- Legible electrical and hydraulic schematics: can you read symbols, terminal numbers and cross-references when you zoom in or print? A blurry scan is, in practice, a missing schematic.
- Spare-parts list with commercial part numbers: does each part carry the manufacturer's number and also the standard one (seal, bearing, belt, contactor)? Without it you depend on calling the manufacturer's service desk.
- Documented error codes: are all alarm codes listed with probable cause and action? If the manual only lists the code, the knowledge lives in one technician's head.
- Indexing and search: can you find a term or a code without opening a several-hundred-page PDF and flicking through it? Try a real code and time it.
- Access from the shop floor: can the technician open it at the machine, with or without a signal, without asking another department for a password?
2. How to score your own documentation
Score each criterion per machine: 0 if it is not met, 1 if partly met (it exists but is hard to use) and 2 if a technician can resolve it in a few minutes. Maximum: 14 points. The scale is our own rule of thumb, not a standard: use it to compare your machines with each other and track progress.
| Points | Reading | What to do first |
|---|---|---|
| 12 to 14 | Documentation usable in a breakdown | Keep it current whenever the machine changes |
| 8 to 11 | Usable, but gaps lengthen diagnosis | Fix the criteria scored 0 or 1 on that machine |
| 0 to 7 | Does not help you today when the machine is down | Prioritise this machine and start with schematics and spare parts |
Illustrative example with assumed figures
A press scores: language 2, version 1, schematics 0, spare parts 1, error codes 1, search 0, access 2. Total 7 points: diagnosis depends on finding the schematic, not on the technician's skill. These figures come from no study or real machine: replace them with your own.
3. What to do about what is missing
- Version or language: ask the manufacturer for the current documentation by serial number and record the date received in the file itself.
- Illegible schematics: request the vector original or rescan at higher resolution; meanwhile note on the machine record which schematics are doubtful.
- Spare parts without commercial numbers: build an equivalence table each time you replace a part. There is a method in spare-parts identification with exploded views.
- Unexplained error codes: record the real cause and fix when you close each breakdown. More in troubleshooting error codes across manuals.
- No indexing or access: gather everything in one repository with consistent names and shop-floor access. Details in the maintenance documentation management guide.
Start with the machines whose downtime is most expensive and repeat the scoring each time you close a breakdown: that way the improvement shows in your own plant, without relying on someone else's numbers.
Next step
If you want to query your manuals by question or error code instead of flicking through PDFs, take a look at IgeraIndustria. Audit your documentation with the checklist first: it will tell you what needs organising, with or without a tool.
Frequently asked questions
How often should I audit technical documentation?
When a machine is installed, after any major modification and after every significant breakdown. For the rest, an annual review of critical machines is usually enough.
Which machines should I audit first?
The ones whose downtime costs most: those that stop the whole line, have no spare at hand or depend on a single technician. Score those before the rest.
What if the manufacturer no longer exists or won't provide documentation?
Rebuild the essentials from the machine itself: photograph nameplates and schematics, record part numbers when you replace parts and log every intervention. It is slow, but each breakdown leaves the record more complete.
Does an AI tool help if my documentation is poor?
A search tool only finds what exists. If the schematic is illegible or the part is missing, it will not invent it. That is why you should audit first and fix the criteria scored 0.