Explainer
Building O&M Manuals: What Goes in Them
The Short Answer
The Record That Outlives the Project
An operation and maintenance (O&M) manual is the set of documents handed to a building owner at turnover so that facility staff can operate, maintain, and repair what was built. It is a close cousin of the technical manual for a product, with one difference: it describes a one-off assembly of many products, installed by many trades, in one place.
Contracts define it in different ways. The federal example this piece uses is UFGS 01 78 23, Operation and Maintenance Data (May 2023, Change 4 dated 08/26), a guide specification from USACE, NAVFAC, and AFCEC that project teams edit into a contract. It is one reading of the genre, not the only one.
Contents
What Goes in the Manual
- Equipment data
- Manufacturer cutsheets and literature for what was actually installed, an inventory of installed equipment (model, serial number, capacity, location by room, supplier), and the approved submittals and shop drawings behind it.
- Operating procedures
- Safety precautions, prestart, startup and shutdown, normal and emergency operation, operator service tasks, environmental limits, and operating logs, plus control sequences and as-built control diagrams for automated systems.
- Maintenance schedules
- The preventive maintenance plan: inspections, adjustments, lubrication, calibration, retest intervals, and the labor hours each takes.
- Repair information
- Troubleshooting guides, wiring and control diagrams, and removal and replacement steps with the special tools they need.
- Warranties
- What each warranty covers, when it starts and ends, who to call, and which maintenance must be done to keep it in force.
- As-built and record drawings
- Drawings that show what was built rather than what was designed, including utility systems with isolation points marked.
- Spare parts and supplier contacts
- Lists of spares and supplies, with long-lead items flagged, and who installed and who services each system.
- Commissioning, training and permits
- Commissioning and test-and-balance reports, training plans and records, and the regulatory documents and permits for the facility.
UFGS 01 78 23 organizes these into nine parts following ASHRAE Guideline 1.4-2019, Preparing Systems Manuals for Facilities: an executive summary, design and construction information, system and assembly data, facility operations, training, the commissioning and test-and-balance reports, regulatory requirements, permits, and the approval record. The systems part is bookmarked by ASTM E2166 Uniformat II classification, so a user can go from a building system down to one component's data.
Who Writes It
A Contractor Submittal Built From Vendor Data
Almost nobody writes an O&M manual from scratch. The contractor gathers each piece of equipment's data from the manufacturer and the installing subcontractor, adds the project's own approved submittals, record drawings, and test results, and submits the whole as a closeout deliverable. The owner and designer review it.
UFGS 01 78 23 scales the effort to the equipment. Its five data packages run from a simple architectural item (safety, cleaning, repair, warranty) to complex electrical equipment that needs wiring and control diagrams, and each technical section names the package it requires. The section also asks for an editable equipment spreadsheet to start a preventive maintenance program, and for the manual in stages: a progress submittal at about 50 percent complete, a prefinal ahead of occupancy, and a final at the Beneficial Occupancy Date. Read the text of your own contract for the actual dates.
Why It Fails
Why Turnover Documentation Falls Short
- It arrives late
- Closeout documents are collected in the last weeks of a project, when the team is already moving on. The owner takes over a building before anyone can look something up in the manual.
- It is a scanned binder
- Photographed pages of vendor literature cannot be searched. A technician hunting for one torque value or one part number pages through a PDF with no text layer.
- It has no structure
- Documents are filed in the order they were collected, not by system, so the same chiller shows up in three places, or in none. Nothing ties an item in the manual to the item in the maintenance system.
- It covers the catalog, not the building
- A manufacturer file for a whole product line says nothing about which model, options and settings were installed on this project.
- Nobody owns the update
- The first equipment swap or controls change makes the manual wrong, and there is no process to revise it.
Owners and specifiers have noticed. UFGS 01 78 23 states that the whole prefinal submittal is returned if any portion is incomplete or inaccurate, calls for text-searchable files from the manufacturer, and says not to provide scanned copies of hardcopy documents. Those requirements target the same problems.
Structured Delivery
How Searchable, Structured Delivery Helps
Facility teams use a manual in short, urgent bursts: an alarm, a failed pump, a warranty question. What helps is to find the right procedure and the right part number in under a minute. That calls for a consistent structure by system and component, a text layer on every page, bookmarks or links that follow the building's own classification, and warranty and spare-parts data that can be sorted rather than read.
The National Institute of Building Sciences' COBie specification takes the data half of that idea further. It defines a standard organization of the data used to manage and maintain facility assets, drawn from the as-built, O&M, and commissioning information captured during construction, so the owner can load a maintenance system from the handover instead of retyping it. Procedures still need a manual; the same discipline that makes a PDF usable applies. See PDFs Are Like Cockroaches for the limits of the format, and what structured authoring is for how content is written once to a schema. The same logic shapes interactive electronic manuals for defense equipment.
Regulation points the same way for machinery: the EU rule on digital instructions is covered in EU Machinery Rule: Digital Instructions.
Our Work
Writing and Assembling the Manual
Shakewell writes and assembles operation and maintenance manuals for buildings and facilities.
FAQ
Questions We Hear
What is an O&M manual for a building?
It is the set of documents that lets an owner's staff operate and maintain a facility after construction: equipment data, operating procedures, maintenance schedules, repair information, warranties, as-built drawings, and spare parts lists, organized by building system.
Who writes the O&M manual?
Usually the construction contractor assembles it, collecting data from subcontractors and equipment suppliers, and the owner or designer of record reviews it. The contract decides who is responsible, so read the closeout and O&M data sections of yours.
What is the difference between an O&M manual and a systems manual?
A systems manual, as ASHRAE Guideline 1.4 frames it, is broader: it draws on planning, commissioning, design, construction, testing, and training information to support operations, maintenance, and upgrades. UFGS 01 78 23 uses that guideline to organize the O&M manual into parts, so on a federal project the two overlap. Check which term your contract uses and what it lists.
What is COBie?
Construction to Operations Building information exchange, a specification from the National Institute of Building Sciences for delivering data on a facility's maintainable assets in a standard digital format. It is a data deliverable that sits next to the manual, not a replacement for the operating and repair procedures in it.
Are scanned PDFs acceptable for an O&M manual?
It depends on the contract. UFGS 01 78 23 asks for bookmarked, text-searchable files taken from the manufacturer's electronic documentation and says not to provide scanned copies of hardcopy documents. Other owners may accept less, but a file without a text layer is hard to use whatever the contract allows.
When is the O&M manual due?
Under UFGS 01 78 23, a progress submittal at about 50 percent construction complete, a prefinal submittal a set number of days before the Beneficial Occupancy Date (the section offers 90 or 60), and the final at that date. Other contracts set their own schedule.
Get In Touch
Hand Over a Manual Your Team Can Use
Tell us about the facility and what the contract requires. We will say what goes in the manual and how we would organize it.