Control System Documentation Requirements
Complete and accurate documentation is essential for building automation system operation, maintenance, and future modifications. This guide covers the documentation that should be developed during design, construction, and commissioning phases.
Why Documentation Matters
Operational Impact
- Troubleshooting efficiency: Good docs reduce diagnostic time
- Staff turnover: New personnel can understand systems
- Maintenance planning: Know what to check and when
- Energy management: Understand how systems should operate
- Code compliance: Demonstrate proper installation
Common Documentation Problems
- Missing or incomplete documents
- Documents don't match as-built conditions
- Scattered across multiple locations
- No update process for changes
- Wrong format (uneditable PDFs, lost source files)
Design Phase Documentation
Basis of Design (BOD)
Documents the design intent:
- Design conditions (indoor/outdoor)
- Load calculations summary
- System selection rationale
- Energy efficiency measures
- Code compliance approach
Sequence of Operations (SOO)
The "contract" for how controls work:
- Narrative descriptions of each sequence
- Setpoints and adjustable parameters
- Operating modes (occupied, unoccupied, etc.)
- Safety interlocks and alarms
- Failure modes and fallback operation
Good SOO Characteristics:
- Specific and measurable criteria
- Covers all operating conditions
- References specific equipment
- Written for control contractor to implement
- Matches energy code requirements
Control Drawings
Points Schedule
- All hardware I/O points
- Point names and descriptions
- Signal types (AI, AO, DI, DO)
- Ranges and engineering units
- Network points (virtual)
System Diagrams
- Control system architecture
- Network topology
- Device locations
- Communication paths
Wiring Diagrams
- Terminal connections
- Wire sizes and types
- Conduit routing
- Panel layouts
Flow Diagrams
- Mechanical system schematics
- Sensor/actuator locations
- Control valve arrangements
- Damper configurations
Construction Phase Documentation
Submittal Requirements
Hardware Submittals
- Controller specifications
- Sensor cut sheets
- Actuator specifications
- Network equipment
- Panel drawings
Software Submittals
- Programming standards
- Naming conventions
- Graphics standards
- Alarm definitions
- User interface design
Installation Documentation
- Panel photographs (before/after wiring)
- Device installation photos
- Cable testing results
- Network configuration records
- IP address assignments
Commissioning Documentation
Pre-Functional Checklists
Document completion of:
- Equipment installation verification
- Wiring continuity checks
- Power verification
- Controller startup
- Communication verification
Point-to-Point Records
For each point document:
- Point identification
- Expected vs. measured values
- Calibration adjustments
- Pass/fail status
- Technician sign-off
Functional Test Reports
- Test procedures used
- Test conditions
- Results vs. expected
- Deficiencies found
- Corrective actions
Trend Data
- Baseline trend logs
- Test period trends
- Seasonal verification data
O&M Manual Requirements
System Overview
- System description and purpose
- Equipment schedules
- Design conditions
- Major components
Operating Procedures
- Normal startup/shutdown
- Seasonal changeover
- Emergency procedures
- Occupied/unoccupied operation
Maintenance Procedures
- Preventive maintenance schedules
- Calibration procedures
- Filter change intervals
- Sensor cleaning requirements
Troubleshooting Guides
- Common problems and solutions
- Alarm descriptions and responses
- Diagnostic procedures
- Contact information for support
As-Built Drawings
- Accurate final configurations
- All field changes documented
- Current network topology
- Final points list
Software Documentation
- Programming logic (commented)
- Setpoint schedules
- Trend configurations
- Alarm setups
- User account information (sanitized)
BAS-Specific Documentation
Network Documentation
- IP address scheme
- VLAN assignments
- Port configurations
- Router/firewall rules
- VPN access procedures
Points Database
Exportable list including:
- Point names
- Addresses
- Descriptions
- Alarm limits
- Trend configurations
Graphics Package
- Screen hierarchy map
- Navigation guide
- Symbol legend
- Color conventions
Software Backup
- Controller programs
- Database backups
- Graphics exports
- Configuration files
- License information
Documentation Standards
Naming Conventions
Establish consistent naming for:
- Equipment (AHU-1, VAV-2-01)
- Points (AHU1.SAT, VAV201.ZNT)
- Graphics screens
- Alarm categories
- Trend logs
File Organization
Version Control
- Date all documents
- Track revision history
- Maintain superseded versions
- Document who made changes
Format Requirements
- Provide editable source files (not just PDFs)
- Use standard formats (DWG, DOC, XLS)
- Include software versions used
- Ensure files can be opened without proprietary software
Handover Process
Documentation Turnover
- Compile all documents: Gather from all parties
- Verify completeness: Check against requirements list
- Validate accuracy: Spot-check against field conditions
- Organize logically: Follow standard structure
- Deliver appropriate formats: Paper, electronic, or both
Training Documentation
- Training session agendas
- Attendance records
- Training materials provided
- Competency verification
Warranty Information
- Equipment warranties
- Software licenses
- Support contracts
- Contact information
Ongoing Documentation
Change Management
When systems are modified:
- Update as-built drawings
- Revise sequences if changed
- Update points database
- Modify graphics as needed
- Document change rationale
Regular Reviews
- Annual documentation audit
- Update contact information
- Verify backup procedures
- Check license renewals
Common Deficiencies
What's Often Missing
- Complete as-built drawings
- Editable source files
- Network documentation
- Software backup procedures
- Alarm descriptions
How to Prevent
- Include documentation requirements in specifications
- Review documentation during commissioning
- Withhold final payment until complete
- Assign responsibility for updates
References
- ASHRAE Guideline 1.5: The Commissioning Process for Smoke Control Systems
- ASHRAE Guideline 4: Preparation of Operating and Maintenance Documentation
- CSI MasterFormat (Division 25)
- NIST Handbook 135: Life-Cycle Costing Manual
Good documentation is an investment that pays dividends throughout the building's life. Take time to get it right during construction—you'll never have a better opportunity.