COMPLETE REVISION

September 2009

Process Industry Practices

Process Control

PIP PCEDO001
Guidelines for Control Systems Documentation
 PURPOSE AND USE OF PROCESS INDUSTRY PRACTICES

In an effort to minimize the cost of process industry facilities, this Practice has
been prepared from the technical requirements in the existing standards of major
industrial users, contractors, or standards organizations. By harmonizing these technical
requirements into a single set of Practices, administrative, application, and engineering
costs to both the purchaser and the manufacturer should be reduced. While this Practice
is expected to incorporate the majority of requirements of most users, individual
applications may involve requirements that will be appended to and take precedence
over this Practice. Determinations concerning fitness for purpose and particular matters
or application of the Practice to particular project or engineering situations should not
be made solely on information contained in these materials. The use of trade names
from time to time should not be viewed as an expression of preference but rather
recognized as normal usage in the trade. Other brands having the same specifications
are equally correct and may be substituted for those named. All Practices or guidelines
are intended to be consistent with applicable laws and regulations including OSHA
requirements. To the extent these Practices or guidelines should conflict with OSHA or
other applicable laws or regulations, such laws or regulations must be followed.
Consult an appropriate professional before applying or acting on any material
contained in or suggested by the Practice.

This Practice is subject to revision at any time.

© Process Industry Practices (PIP), Construction Industry Institute, The

University of Texas at Austin, 3925 West Braker Lane (R4500), Austin,
Texas 78759. PIP member companies and subscribers may copy this Practice
for their internal use. Changes, overlays, addenda, or modifications of any
kind are not permitted within any PIP Practice without the express written
authorization of PIP.

PRINTING HISTORY
April 1997 Issued
September 2004 Complete Revision
September 2009 Complete Revision

Not printed with State funds


Process Industry Practices
Process Control
PIP PCEDO001
Guidelines for Control Systems Documentation
Table of Contents
1. Introduction................................. 2
1.1 Purpose ........................................... 2
1.2 Scope .............................................. 2
2. References .................................. 2
2.1 Process Industry Practices .............. 2
2.2 Industry Codes and Standards ........ 2
3. Definitions ................................... 2
4. Documentation Descriptions ..... 3
4.1 General ............................................ 3
4.2 Piping and Instrument Diagrams ..... 3
4.3 Standards and Practices ................. 3
4.4 System Block (Architect) Diagrams . 4
4.5 Master Instrument Database and
Index ................................................ 4
4.6 Narrative Specifications................... 5
4.7 Instrument Data Sheets
(Specification Forms) ...................... 5
4.8 Level Instrument Documents........... 5
4.9 Control Valve Calculations .............. 6
4.10 Flow Instrument Calculations .......... 6
4.11 System Configuration ...................... 6
4.12 Logic Documents ............................. 6
Process Industry Practices
COMPLETE REVISION
September 2009
4.13 Logic Program Documentation ........ 7
4.14 Control System Configuration
Guidelines........................................ 7
4.15 Alarm Set Point Listing .................... 7
4.16 Control Layout Drawings ................. 8
4.17 Instrument Location Drawings ......... 8
4.18 Instrument Installation Drawings ..... 8
4.19 Instrument Loop Diagrams .............. 9
4.20 Instrument Segment Diagrams........ 9
4.21 Complex Loop Descriptions .......... 10
4.22 Instrument Wiring Documents ....... 10
4.23 Grounding System Drawings—
Instrumentation Only ..................... 10
4.24 Instrument Installation Checkout
and Calibration/Configuration
Procedure ...................................... 11
4.25 Instrument Loop Folders ............... 11
4.26 Safety Instrumented System
Documentation .............................. 11
4.27 Decommissioning Documents ....... 11
Appendix A
Instrument Index Examples ................... 12
Page 1 of 12
PIP PCEDO001 COMPLETE REVISION
Guidelines for Control Systems Documentation September 2009

1. Introduction

1.1 Purpose
This Practice provides control systems design personnel with guidelines for
providing control systems documentation.

1.2 Scope
This Practice describes the general guidelines for control systems documentation for
design, supply, installation, checkout or commissioning, and maintenance of
instrumentation and control systems.

2. References
Applicable parts of the following Practices, industry codes and standards, and references shall
be considered an integral part of this Practice. The edition in effect on the date of contract
award shall be used, except as otherwise noted. Short titles are used herein where appropriate.

2.1 Process Industry Practices (PIP)

− PIP PCCCV001 - Selection of Control Valves
− PIP PCECV001 - Guidelines for Application of Control Valves
− PIP PCCGN001 - General Instrumentation Design Basis
− PIP PIC001 - Piping and Instrument Diagram Documentation Criteria
2.2 Industry Codes and Standards

• The International Systems and Automation Society (ISA)

– ISA 5.2 - Binary Logic Diagrams for Process Operations
– ISA 5.4 - Instrument Loop Diagrams
– ISA 20 - Specification Forms for Process Measurement and Control
Instruments, Primary Elements and Control Valves
– ANSI/ISA-S84.00.01- 2004 - Application of Safety Instrumented Systems for
the Process Industries
– ISA 91.00.01 - Identification of Emergency Shutdown Systems and Controls
That Are Critical to Maintaining Safety in Process Industries
• International Electrotechnical Commission (IEC)
– IEC 61511 - Functional Safety - Safety Instrumented Systems for the Process
Industry Sector

3. Definitions
owner: The party who owns the facility wherein the control system will be used

supplier: The party responsible for the design of the control system

Page 2 of 12 Process Industry Practices

COMPLETE REVISION PIP PCEDO001
September 2009 Guidelines for Control Systems Documentation

4. Documentation Descriptions

4.1 General
4.1.1 Before project initiation, the owner should provide an example of the
owner’s standard documentation package including the requirements for
revision controls.
Comment: It is recommended that the owner complete the data forms
contained in PIP PCCGN001, with input from the supplier as
required.
4.1.2 Before project initiation, the owner should furnish in writing all necessary
changes and/or modifications to this Practice.
4.1.3 The owner may permit the use of supplier’s standard documentation as an
alternate.
4.1.4 For retrofit projects, it is recommended that changes be made to existing
drawings or documents in lieu of generating new drawings or documents in
order to avoid duplication of equipment or controls between documents.
4.1.5 Basic criteria for each type document are described in the following sections
of this Practice. The owner should specify which documents are required for
the project.
Comment: It is recommended that a system of databases and/or drawing
tools, tied electronically to the Piping and Instrument
Diagrams, be used to generate instrument indexes, instrument
data sheets, instrument loop diagrams, installation details, and
other associated documents.

4.2 Piping and Instrument Diagrams

4.2.1 A Piping and Instrument Diagram (P&ID) is a schematic representation of
the piping, process control, and instrumentation for a specific process or
system, showing the functional relationship among the various components.
4.2.2 P&IDs should be prepared in accordance with PIP PIC001.

4.3 Standards and Practices

4.3.1 The standards that establish the basic design criteria for the project should be
identified at the beginning of the project and documented using the data
forms in PIP PCCGN001.
4.3.2 PIP Practices should be used as appropriate to provide control systems
requirements.
4.3.3 Standard symbologies, layering, and revision control for computer-aided
drafting (CAD) drawings to be developed for the project should be agreed
with owner.

Process Industry Practices Page 3 of 12

PIP PCEDO001 COMPLETE REVISION
Guidelines for Control Systems Documentation September 2009

4.4 System Block (Architect) Diagrams

4.4.1 System block (architect) diagrams should show, in a block diagram format,
the following items:
a. All major control systems components
b. Interfaces to plant local area networks
c. Resource management systems
d. Overall cable and wiring connection philosophy
4.4.2 Communication hiways, single line routing, and connection diagrams are
additional documents that can be used to further detail the system
architecture.

4.5 Master Instrument Database and Index

4.5.1 Database
4.5.1.1 The master instrument database contains information for all the
controls and instruments in the project.
4.5.1.2 The database is useful for determining current work completion
status and for ascertaining that required work has been performed
and documents have been issued.
4.5.2 Index
4.5.2.1 The master instrument index should be the key reference document
for the control systems work.
4.5.2.2 The index is generated from the master instrument database.
4.5.2.3 The index should contain a record for every instrument tag number
used in the project.
4.5.2.4 The master instrument index should have the following fields:
a. Instrument tag number
Comment: The instrument tag number may be divided into
multiple fields (e.g., unit (or plant, train) number,
function identifier, equipment (or P&ID) number,
and loop sequence number).
b. Service description
c. Reference drawing number (e.g., P&ID number, mechanical
flowsheet number)
d. Instrument type
e. Signal type
f. Instrument location (e.g., field, local panel, control room, etc.)
g. Equipment/Line number (typically for in-line devices)
h. Pipe specification (may be combined with line number)

Page 4 of 12 Process Industry Practices

COMPLETE REVISION PIP PCEDO001
September 2009 Guidelines for Control Systems Documentation

i. Data sheet number

j. Criticality status as defined by the owner (i.e., criticality of
shutdown systems, high priority alarms, or logic systems)
k. Material requisition or purchase order number
l. Status (e.g., new, existing, supplied by owner, supplied by
package vendor)
m. Requirement for external power (e.g., 120/24v, etc.)
n. Design drawings (e.g., location plans, loop diagrams, installation
details, logic diagrams, electrical wire diagrams or schedules,
vendor prints)
o. Comments
4.5.2.5 Other fields may be added to the index in accordance with project
specific requirements.
4.5.2.6 See Appendix A for instrument index examples.

4.6 Narrative Specifications

Narrative specifications are used in conjunction with P&IDs to describe the control
system philosophy, logic, and special functions.

4.7 Instrument Data Sheets (Specification Forms)

4.7.1 Instrument data sheets should provide the basic information for an instrument
requisition. An instrument data sheet should define an instrument in
sufficient detail to enable an instrumentation provider to provide the
specified instrument.
4.7.2 Instrument data sheets should provide a readily accessible, concise summary
of information about the installed instrumentation.
4.7.3 Instrument data sheets may be generated from a database containing index,
specification, and process information.
Comment: The database system should be able to produce a document for
a single instrument.
4.7.4 The specification forms provided in ISA 20 or equivalent should be used for
preparing instrument data sheets.

4.8 Level Instrument Documents

4.8.1 Level instrument documents should depict level instrument connection
requirements, standpipe requirements, and level operating ranges and set
points.
4.8.2 Beginning in preliminary form, the level instrument documents should
provide the level instrument connection requirements to vessel and piping
groups, and assist a control systems engineer in selecting the types and
ranges of level instruments, including providing data for the range
calculations.

Process Industry Practices Page 5 of 12

PIP PCEDO001 COMPLETE REVISION
Guidelines for Control Systems Documentation September 2009

4.9 Control Valve Calculations

Control valve calculations should be defined and documented in accordance with PIP
PCECV001 and PIP PCCCV001.

4.10 Flow Instrument Calculations

4.10.1 The sources (i.e., owner, supplier, or instrumentation provider) for all flow-
sizing calculation methods should be identified at the beginning of the
project.
4.10.2 Each flow instrument calculation sheet should show, as a minimum, the
instrument tag, sizing data, and calculation results.

4.11 System Configuration

4.11.1 For all computing devices, the bases for all calculations should be provided,
including the following:
a. Final calculations including determination of constants
b. Limitations of the computing device constants
c. Instrument ranges, ratios, spans, alarm set points, alarm deadband,
controller action, and other variables required for final configuration and
commissioning
4.11.2 For Basic Process Control Systems (BPCS) and other digital systems, a
configuration block is typically self-documented in the system.
Comment: The instrument provider’s standard calculation/calibration form
should satisfy this documentation requirement.

4.12 Logic Documents

4.12.1 Logic Narratives (Functional Specifications)
Logic narratives in plain language may be used to define the logic functions.
4.12.2 Logic Diagrams
4.12.2.1 ISA 5.2 may be used as a guide to develop logic diagrams. ISA 5.2
is intended to symbolize the binary operating functions of a system
in a manner that can be applied to any class of hardware.
4.12.2.2 Logic diagrams are typically used to transfer operational
information from the owner to the party responsible for generating
the application program.
4.12.3 Cause-and-Effect Diagrams
Cause-and-effect diagrams should show the initiating events and required
results for the logic functions.
4.12.4 Batch Sequence Diagrams
Batch sequence diagrams should identify the required batch sequence
operations.

Page 6 of 12 Process Industry Practices

COMPLETE REVISION PIP PCEDO001
September 2009 Guidelines for Control Systems Documentation

4.13 Logic Program Documentation

4.13.1 Logic programming may be performed using a variety of methods.
4.13.2 The party implementing programmable logic controller (PLC)-based logic
systems should be required to provide diagrams that satisfy the requirements
of the logic diagrams and/or logic narratives.
4.13.3 Program documentation should be generated by the program development
workstation software tools.
4.13.4 Program documentation should be transmitted to the owner in hard copy and
editable native media.
4.13.5 Register listing and necessary annotation for programming should be
provided.

4.14 Control System Configuration Guidelines

4.14.1 Before the control system configuration is developed, a control system
hardware and software design guide should be developed.
4.14.2 Typical issues that should be defined in the guide are as follows:
a. Nametag convention
b. Alarm presentation philosophy
c. Input/output segregation philosophy
d. Redundancy/system security philosophy
e. Configuration guidelines
f. Graphics development guidelines
g. Interface guidelines (i.e., interface with third party devices, e.g.,
computer, PLC, analyzer system, tank-gauging system, etc.)
h. Spare capacity guidelines. See information furnished on owner’s
PIP PCCGN001 data forms.
4.14.3 The control system documentation should include the I/O listings for the
various types of signals.
4.14.4 Typically, the control system configuration that is installed is self-
documented by the selected control system.
4.14.5 If the configuration software does not provide self-documentation, some
other means of documentation (e.g., documenting the configuration data on a
database) should be provided.
4.14.6 A backup electronic file for the configuration database should be provided.

4.15 Alarm Set Point Listing

4.15.1 Alarm set point listings for both soft and hardwired alarms should be
provided to identify shutdown alarm and pre-shutdown or critical set points.
4.15.2 Alarm settings should include the process value and the signal value.

Process Industry Practices Page 7 of 12

PIP PCEDO001 COMPLETE REVISION
Guidelines for Control Systems Documentation September 2009

4.15.3 The format of the documentation for the alarm settings information should be
agreed with owner at the beginning of the project. Format options include,
but are not limited to, loop folders or master instrument indexes.

4.16 Control Layout Drawings

4.16.1 Control Room
Control room layout drawings should show in plan view the location of
consoles, panels, control racks, computer racks and peripherals, logic racks,
barrier cubicles, termination racks, and boxes.
4.16.2 Control Panel
Control panel layout drawings should show the position of panel-mounted
instruments, panel dimensions, method of support, filler plates, and major
construction details.
4.16.3 Control Console
Control console layout drawings should show the console bay arrangements
with function identification for each process area video system.
4.16.4 Remote Enclosures
Non-occupied remote enclosure (e.g., satellite enclosure, analyzer house,
etc.) layout drawings should show the position of each item of major
equipment.
4.16.5 System Cabinet
System cabinet layout drawings should show the location of all pieces of
equipment, cabinet dimensions, terminal boxes, filler plates, and major
construction details.

4.17 Instrument Location Drawings

4.17.1 Instrument location drawings should show the location coordinates and
elevation of each electronic field instrument and field termination box.
4.17.2 The instrument location drawing should be a plot plan with buildings,
vessels, and other major equipment shown in outline.
4.17.3 The instrument location drawings may show routings for tubing bundles,
cables, cable tray, air supplies, or electrical power and signals if appropriate.
4.17.4 For a 3-D model environment, the location plan background should be a view
cut from the model (i.e., not individually drawn). Sections 4.17.1 through
4.17.3 should still be applied.

4.18 Instrument Installation Drawings

4.18.1 Instrument installation drawings should show the required method of
installation of the instruments and should list the needed piping, tubing, and
fitting materials.
4.18.2 Instrument installation details should be in accordance with appropriate
PIP installation details if available.

Page 8 of 12 Process Industry Practices

COMPLETE REVISION PIP PCEDO001
September 2009 Guidelines for Control Systems Documentation

4.19 Instrument Loop Diagrams

4.19.1 Generally, ISA 5.4 should be used to develop instrument loop diagrams.
Comment: Typically, instrument tag number is used as the loop diagram
number or title.
4.19.2 Instrument loop diagrams may include the following information:
a. Devices or items with clear labeling and identification, including
instrument tag numbers
b. Pictorial representation of wiring to instrument terminals should be
provided, if available.
c. Junction boxes, terminal strips, bulkheads, ports, grounding connections,
etc., and identifying numbers for equipment, electrical cables, cable core
pairs, terminal blocks, and pneumatic tubes
d. Utility and energy sources (i.e., electrical power, air supply, and
hydraulic fluid supply). Source of power, voltage, pressure, and other
applicable requirements should be provided.
e. References to supplemental records and drawings (e.g., P&ID number,
etc.)
f. Location of devices with respect to associated piping line numbers,
associated field equipment numbers, panel front, panel rear, marshaling
panel, auxiliary rack, termination cabinet, and control systems I/O
cabinets
g. For the following items the information shown should be provided:
(1) Control valves - Fail positions
(2) Controller - Action as direct or reverse
(3) Solenoids - De-energized or de-pressured positions with an
arrow, and port designations
(4) Relays - Function (e.g., square root, low select, etc.), port
terminal designations, shelf positions, and trip connections
h. If applicable, the BPCS tag, communication link (data highway) address,
and algorithm type

4.20 Instrument Segment Diagrams

4.20.1 Instrument segment diagrams should be provided in lieu of loop diagrams to
document a fieldbus system.
4.20.2 A fieldbus system may be installed in a variety of ways (e.g., star, multi-
drop, etc.) depending on the design philosophy of fieldbus system.
4.20.3 Segment diagrams should include information shown in Section 4.19.2.

Process Industry Practices Page 9 of 12

PIP PCEDO001 COMPLETE REVISION
Guidelines for Control Systems Documentation September 2009

4.21 Complex Loop Descriptions

4.21.1 A complex loop is typically defined as a system that contains any of the
following characteristics:
a. Three or more interconnected loops
b. Calculations
c. Configuration description
d. Procedural steps involving control loops
e. Not readily definable on the P&ID
Comment: Examples of complex control loops are combustion
controls for fired heaters or sequential operations.
4.21.2 A complex loop description should contain all the documentation necessary
to properly describe the operational requirements, instrument components,
calculations, logic procedures, and detailed configuration and/or
programming.

4.22 Instrument Wiring Documents

4.22.1 Junction/Terminal Box Drawings or Lists
4.22.1.1 Junction/terminal box drawings or lists should show the terminal
strips with terminal numbers for junction boxes, field control
panels, marshaling cabinets, and instrument cabinets and/or racks,
with the appropriate identification.
4.22.1.2 Junction/terminal box drawings or lists should also show the
connections of instrument multicore (multipair) cables to the
terminals, with identification by cable number and core (pair)
number.
4.22.1.3 Reference drawings for continuation of wiring should be included
as a minimum.
4.22.2 Conduit/Tray Layout and Cable Routing Drawing or List
Conduit/tray layout and cable routing drawings or lists should show the
general conduit/tray layouts and the following cable/conduit data:
a. Identification number
b. Approximate length
c. Type elevation and routing

4.23 Grounding System Drawings—Instrumentation Only

Grounding system drawings should show the following information:
a. Grounding connections to the appropriate power supply systems
b. Earth grounding locations for all instrument power systems
c. Wiring system shield grounding

Page 10 of 12 Process Industry Practices

COMPLETE REVISION PIP PCEDO001
September 2009 Guidelines for Control Systems Documentation

d. BPCS grounding
e. Other appropriate instrumentation and control systems

4.24 Instrument Installation Checkout and Calibration/Configuration

Procedure
4.24.1 A detailed procedure should be prepared to define the responsibility for
instrument installation, including complete calibration (or configuration for
smart transmitters, etc.) and operational checks of all instrument loops,
sequencing and interlock systems, annunciators, and shutdown systems.
4.24.2 Instrument calibration should be recorded for future reference. A checkout
form should be used to record loop check sign-off and approval. Sign-off and
calibration may be recorded on a single form.

4.25 Instrument Loop Folders

A file should be created and maintained for all instruments. The file should be
identified by loop number and should contain the following documents:
a. Data sheets for each device in the loop
b. Loop diagrams or segment diagrams
c. Configuration data for smart devices
d. Forms for checkout of initial installation and calibration information, in
accordance with Section 4.24.2

4.26 Safety Instrumented System Documentation

Safety System documentation should contain information as required by ANSI/ISA-
84.00.01-2004, IEC 61511.

4.27 Decommissioning Documents

For a revamp project, decommissioning documents should show the instrumentation
to be decommissioned.

Process Industry Practices Page 11 of 12

 PIP PCEDO001 COMPLETE REVISION
Guidelines for Control Systems Documentation September 2009

Appendix A: Instrument Index Examples

An instrument index provides an organized method of tabulating information for each instrument for
use by engineering, construction, and maintenance personnel. Typically, an index is a computer
database that may be generated from a variety of software packages. Customized reports can be
generated from the database in accordance with project specific requirements. The information on the
report is limited only by the font size required to fit the information to the page. The instrument index
should be one common database from which a variety of reports are generated. Maintaining multiple
databases for the various reports is not recommended.
A typical reporting method is to generate a report of the installation drawings needed by the
construction personnel and a separate report showing the data sheet, purchase order, etc. The
following are examples of instrument index reports based on this reporting method. The required
format should be agreed with the owner at the onset of the project.

Figure A-1. Design Index

Figure A-1 is an example instrument index report that provides an organized method for listing the
installation drawings for each instrument.
Tag Process Process Option Mounting Mounting. Signal Location Loop J-Box
Number Installation Installation Dwg Dwg
PT-201 PCIPR001/IP-14P PCIOP001-4/IP-14P PCFGN101 PCIGN101 PCIEL300 101 P201 IJB320
PT-202 PCIPR002/IP-12P --- PCFGN105 PCIGN101 PCIEL300 113 P202 IJB310
PT-203 PCIPR001/IP-03P PCIOP001-3/IP-03P W/PT-202 W/PT-202 PCIEL300 105 P203 IJB320

Figure A-2. Engineering Index

Figure A-2 is an example instrument index report that provides an organized method for listing the
specification and procurement documents for each instrument.
Tag Inst. Sig. Inst. Line/Equip Service P&ID Data Sheet Purchase Order Critical
Number Type Type Loc. No. No.
PT-201 PT E F 105-C1 V-101 Stripper 101 3.01 7-0001 Y
Overhead
PV-201 CV P F 202-A5 V-101 Stripper 110 9.02 7-0010 N
Overhead to Vent
PT-202 PT E F 105-A2 P-202 Bottoms 201 3.10 7-0001 N
Pump Discharge

Page 12 of 12 Process Industry Practices