1. Documenting Your PLC System
Chapter 15
Documenting Your PLC System

2. Objectives (1 of 2)
Explain what is contained in a system documentation package.
Describe why a system documentation package should be developed.
State when the documentation package is usually developed.
List what documentation features the typical PLC software development package offers.
Explain the value of documentation during troubleshooting.

3. Objectives (2 of 2)
Describe the value of documentation if you have to expand the present system.
Explain a rung description.
Describe a rung symbol and the advantage of using symbols.
State the value of documentation during system start-up.
Explain the value of documentation during an outside service person’s service call.

4. PLC System Documentation
A documentation package is an orderly collection of information concerning the configuration and operation of your system.
It is typically put together as the system is designed.

5. PLC System Documentation Usage
Installation
Debugging
Start-up
Maintenance
Modification
System duplication

6. Why Add Documentation to User Program?
Assists installers to install and start up system
Helps maintenance individuals troubleshoot and maintain system
Provides information to operators who must understand how system works
Assists in answering system upgrade questions
Enables outside service people understand system for maintenance, servicing, or upgrade
Allows easy reproduction of system

7. What Should Be Included in Documentation Package?
System overview
Diagram of system configuration
I/O address assignments
Internal coil address assignments
Data table assignments
Program printout
Control program backup
Wiring diagrams

8. Sample Diagram of System Configuration

9. Typical Wiring for a 120 VAC Input Module

10. Typical Wiring for a 120 VAC Output Module

11. Diagram of System Configuration

12. Seven-Slot Chassis with I/O Modules Assigned

13. Internal Bit Allocation Table

14. Timer Address Allocation Table

15. Integer File Allocation Table

16. Documentation and Software Packages
PLC program development software provides readily available documentation features.
Hard copy print out of all data and ladder files
Cross-reference reports
Hard copy of ladder rungs
Memory usage
Processor configuration data

17. Software Ladder Rung Documentation
Software packages provide ladder rung documentation as program is developed.
Rung documentation can be added later or modified by maintenance individuals.
Software packages ladder rung documentation
Page titles
Rung comments
Instruction symbols
Instruction descriptions
Instruction comments

18. RSLogix 500 Ladder Documentation