536
SECTION
3
PLC
Programming
Industrial Text & Video Company 1-800-752-8398
www.industrialtext.com
CHAPTER
12
PLC System
Documentation
While proper PLC programming is important for a well-run application
program, all of that work is lost without adequate system documentation.
Without documentation, system activities, such as changes, installation,
and maintenance, are difficult to accomplish. In this chapter, we will explain
how to document all aspects of a PLC—from system configuration to
register assignments. We will also explore some different documentation
methods. After that, you will be ready to learn how to implement a PLC
process control system.
Documentation is an orderly collection of recorded information about both
the operation of a machine or process and the hardware and software
components of its control system. These records are a valuable reference
during system design, installation, start-up, debugging, and maintenance.
To the system designer, documentation should be a working tool that is used
throughout the design phase. If the various documentation components are
created and kept current during system design, they will provide the following
benefits:
• They will provide an easy way to communicate accurate information
to all those involved with the system.
• They will serve as a reference to the designer during and after the
design phase.
• They will help the designer, or someone else, answer questions,
diagnose possible problems, and modify the program if require-
ments change.
• They will serve as training material both for the operators who will
interface with the system and for the maintenance personnel who will
maintain it.
• They will allow the system to be reproduced or altered to serve other
purposes.
Proper documentation comes from the compilation of hardware, as well as
software, information. The engineering or electrical group that designs the
system usually provides this information to the end user. Although docu-
mentation is often thought of as extraneous, it is actually a vital system
component and a good engineering practice. In this chapter, we will explain
the requirements of a good PLC documentation package, which will
facilitate the understanding of the control system. Table 12-1 lists the
components of a thorough documentation package.
CHAPTER
HIGHLIGHTS
12-1 INTRODUCTION TO DOCUMENTATION