A technician completes a 3-hour repair on a critical heat exchanger. He closes the work order in the CMMS with the note: "Fixed leak." That is the entire record. No mention of which tube leaked, what caused it, what parts were used, what the root cause was, or what should be checked next time.
Six months later, the same heat exchanger leaks again. A different technician gets the call. She pulls up the work order history and finds "Fixed leak." She has no idea where the previous leak was, whether this is the same location, what was done last time, or whether this is a recurring pattern that points to a deeper problem. She starts from scratch.
This happens every day in maintenance departments everywhere. The work gets done, but the documentation is so thin that the organization learns nothing from it. Each repair is treated as an isolated event instead of a data point in a pattern. The result is repeated failures, wasted diagnostic time, and a maintenance team that never gets smarter about its own equipment.
Good documentation is not about bureaucracy. It is about giving the next person enough information to make better decisions faster. This guide covers what to document, the minimum data fields for each document type, naming conventions, and the compliance requirements that apply to maintenance records.
What to Document
Maintenance generates five primary document types. Each serves a different purpose, and each requires different information to be useful.
1. Equipment Master Records
This is the foundation. Every piece of equipment in your plant should have a master record that contains its identity, specifications, and history. If this layer is inaccurate, everything built on top of it (work orders, inspections, failure analysis) is compromised.
Minimum data fields for an equipment master record:
- Asset tag / equipment ID. Your internal identifier. Must be unique and match the physical tag on the equipment.
- Manufacturer, model, serial number. These three fields uniquely identify the equipment for parts ordering, OEM support, and recall notices.
- Location. Building, floor, area, and specific position. "Plant 2, Building A, Level 1, Bay 12, Position 3." Not just "somewhere in Building A."
- Installation date and commissioning date. These are often different. The equipment may sit for weeks between delivery and startup.
- Criticality rating. How important is this equipment to production? A simple 1-5 scale works. This drives PM frequency and spare parts stocking decisions.
- Linked documents. OEM manual, electrical drawings, P&ID references, spare parts list, and related SOPs.
2. Work Orders
Work orders are the daily record of maintenance activity. They are also the most poorly documented item in most plants. The "Fixed leak" example at the top of this article is not an exaggeration. Studies of CMMS data consistently show that 40-60% of work order closeout notes contain insufficient information for future reference.
Minimum data fields for a completed work order:
| Field | Example | Why It Matters |
|---|---|---|
| Equipment ID | HX-204 | Links to equipment history |
| Problem description | Leak at tube sheet, shell side, lower quadrant | Tells next person where to look |
| Root cause | Tube #14 erosion from particulate in cooling water | Enables pattern detection |
| Work performed | Plugged tube #14, pressure tested at 150 PSI for 30 min, no leaks | Records what was actually done |
| Parts used | Tube plug P/N TP-075-SS (qty: 1) | Inventory accuracy, cost tracking |
| Labor hours | 3.5 hours (2 technicians) | Cost analysis, planning future jobs |
| Follow-up required | Schedule full tube inspection within 60 days | Prevents missed follow-ups |
| Failure code | EROSION-EXTERNAL | Enables failure mode analysis across fleet |
The difference between "Fixed leak" and the example above is the difference between a dead record and useful intelligence. The detailed record tells the next technician: the leak was on the shell side lower quadrant, caused by erosion on tube #14, and there is a follow-up inspection needed. That is actionable information.
3. Inspection Reports
Inspections are your early warning system. A well-documented inspection tells you what condition the equipment is in right now and whether it is getting better or worse over time.
Minimum fields for an inspection report:
- Equipment ID and location
- Inspection type (visual, vibration, thermographic, ultrasonic, oil analysis)
- Date, time, and inspector name
- Measured values with units (vibration: 2.1 mm/s at bearing DE, horizontal)
- Acceptance criteria (what is normal for this measurement point)
- Condition assessment (good / acceptable / watch / action required)
- Photos or data files attached
- Recommended actions with priority and timeline
The most critical part of an inspection report is the trend. A single vibration reading of 4.5 mm/s means nothing without context. If the last three readings were 2.0, 3.2, and 4.5, that is a clear upward trend that requires immediate attention. If the readings have been 4.3-4.7 for the past two years, the equipment runs at that level and it is probably fine. Documentation that captures measurements over time enables this kind of analysis. For more on turning inspection data into maintenance decisions, see our guide on understanding OEE.
4. Failure Records
When equipment fails, the repair is urgent. The documentation is not. That is the problem. By the time the line is back up, the details of what failed and why are already fading. Technicians move on to the next job and the failure record gets a two-line summary that helps nobody.
Build failure documentation into the repair process, not after it. The minimum fields are:
- Equipment ID and failure date/time
- Failure mode (how did it fail? Leak, fracture, seizure, electrical fault, etc.)
- Failure cause (why did it fail? Fatigue, corrosion, overload, contamination, etc.)
- Failure effect (what was the production impact? Line down for 4 hours, reduced output by 30%, etc.)
- Photos of the failed component before repair
- Corrective action taken
- Preventive recommendation (what would prevent recurrence)
Failure records feed directly into root cause analysis. Without consistent failure documentation, RCA teams spend their first two hours reconstructing what happened instead of analyzing why.
5. Repair and Service Records
Repairs that involve external contractors, OEM service, or major overhauls need additional documentation beyond the standard work order. This includes contractor reports, warranty claims, certifications, and before/after measurements.
Keep these records linked to the equipment master record and the triggering work order. A contractor's service report that is saved in someone's email inbox is not documentation. It is a lost document waiting to happen.
Naming Conventions
A consistent naming convention is one of those things that seems trivial until you try to find a document in a system that does not have one. If your work orders are titled "pump repair," "Pump Issue," "PUMP-FIX," and "fixed the pump thing," you cannot search effectively and you cannot sort or filter by equipment.
Use a structured naming format for all maintenance documents:
Work orders: [Equipment ID]-[Type]-[Sequential Number]
Example: HX-204-CM-00347 (Heat exchanger 204, corrective maintenance, work order #347)
Inspection reports: [Equipment ID]-[Inspection Type]-[Date]
Example: P-105-VIB-20260315 (Pump 105, vibration analysis, March 15 2026)
Failure reports: [Equipment ID]-FAIL-[Date]-[Sequential]
Example: COMP-301-FAIL-20260212-01 (Compressor 301, failure, February 12 2026, first incident that day)
SOPs: SOP-[Area]-[Sequential Number]-v[Version]
Example: SOP-HVAC-015-v2.1
The key principle: anyone should be able to look at a document name and know what it is, what equipment it relates to, and roughly when it was created. For guidance on writing effective SOPs that fit this naming system, see our SOP writing guide.
Photo and Video Documentation
Text descriptions of equipment conditions and failures are limited. "Corrosion on the flange face" could mean a light surface rust or a deeply pitted surface that is about to fail. A photo removes the ambiguity in half a second.
Rules for useful photo documentation:
- Include a reference for scale. A ruler, a coin, or even a finger next to the defect. Without scale, a photo of a crack could be 2mm or 20mm. That distinction matters.
- Take a wide shot and a close-up. The wide shot shows context (where on the equipment the issue is located). The close-up shows detail (the nature and severity of the issue).
- Label the photo. Equipment ID, date, and what the photo shows. "HX-204 tube sheet, shell side, lower quadrant. Erosion pattern around tube #14. March 15, 2026." If your photos end up in a folder of 500 unlabeled images, they are useless.
- Clean the area first if possible. A photo of a dirty component covered in oil and grime tells you very little. A photo of a cleaned component with a visible crack or wear pattern is diagnostic gold.
- Before and after. Always photograph the condition before repair and after repair. This proves the work was done and provides a baseline for future inspections.
Video adds another dimension, especially for failures where motion, sound, or vibration patterns are relevant. A 30-second video of a bearing making an abnormal sound is more diagnostic than any written description. For more on using video in maintenance, see our guide on creating equipment walkthrough videos.
Compliance Requirements
Depending on your industry, maintenance documentation may be subject to regulatory requirements. These are not optional, and auditors will check.
FDA (pharmaceutical, food and beverage). CFR 21 Part 211 and Part 820 require documented maintenance procedures, calibration records, and equipment qualification records. Maintenance logs must be retained and available for inspection. Electronic records must comply with 21 CFR Part 11 (electronic signatures, audit trails).
OSHA (all industries). Requires documentation of lockout/tagout procedures (29 CFR 1910.147), periodic inspection records, and training records for hazardous energy control. If your LOTO procedures are not documented and your annual inspections are not recorded, you are out of compliance.
EPA (environmental). Facilities with regulated equipment (boilers, refrigeration systems, emission control devices) must maintain records of inspections, maintenance, and any emissions-related repairs. Retention periods vary by regulation but are typically 3-5 years minimum.
ISO 55001 (asset management). Requires a documented asset management system with records of maintenance activities, condition assessments, risk evaluations, and performance metrics. If you are pursuing or maintaining ISO certification, your documentation standards need to meet these requirements explicitly.
Insurance requirements. Your equipment insurance policy likely requires proof of regular maintenance. If a major piece of equipment fails and you file a claim, the insurer will ask for maintenance records. If you cannot produce them, the claim may be denied. This alone justifies good documentation practices.
Regardless of your specific regulatory environment, there is a baseline: every maintenance action on every piece of equipment should be documented with enough detail that a competent person could understand what was done, why, and by whom. That standard satisfies most regulatory requirements and, more importantly, makes your maintenance organization smarter over time.
Building the Documentation Habit
The hardest part of documentation is not the system. It is the habit. Technicians resist documentation for understandable reasons: they are busy, the system is clunky, and nobody seems to read what they write.
Here is how plants that have successfully built strong documentation cultures did it:
- Make it fast. If closing a work order takes 15 minutes of typing, compliance will be low. If it takes 3 minutes with dropdown menus, standard failure codes, and a phone camera for photos, compliance goes up dramatically. Reduce the friction.
- Show the value. When a technician's documentation helps another technician solve a problem faster, tell them. "Your notes on the HX-204 repair last month saved the night shift 2 hours of diagnostic time." That feedback loop is the strongest motivator.
- Audit regularly. Review a sample of closed work orders every week. Score them against your minimum data requirements. Share the scores with the team, not as punishment, but as a quality metric that the team owns. Set a target (e.g., 90% of work orders meet all minimum fields) and track progress.
- Start with the supervisors. If supervisors close work orders with "Fixed it," technicians will do the same. If supervisors consistently document thoroughly, technicians follow. Documentation culture starts at the top of the maintenance organization.
- Tie it to planning. When planners use past work order data to estimate jobs, the value of good documentation becomes obvious. "Last time this job took 4 hours and required these specific parts." That level of planning accuracy is only possible when the previous work order was documented properly.
Good documentation is a compounding asset. Every well-documented work order, inspection, and failure record adds to your organization's collective intelligence. After a year of consistent documentation, you will have enough data to identify failure patterns, optimize PM frequencies, and predict spare parts needs. After two years, your maintenance team will make decisions based on evidence instead of guesswork.
Start with the work order closeout checklist above. Print it, post it, and hold every work order to that standard. The rest follows from there.
For more on connecting documentation to your knowledge management strategy, see our articles on capturing tribal knowledge and building a maintenance knowledge base.