Pip Adg001

8/13/2019 Pip Adg001

1/19

TECHNICAL REVISIONMay 2002

Process Industry Practices

Work Processes

PIP ADG001Specification for Authors

Developing Process Industry Practices

8/13/2019 Pip Adg001

2/19

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 specificationsare 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 by the responsible Function Team and will

be reviewed every 5 years. This Practice will be revised, reaffirmed, or withdrawn.

Information on whether this Practice has been revised may be found at www.pip.org.

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.

PIP will not consider requests for interpretations (inquiries) for this Practice.

PRINTING HISTORY

May 1994 Issued May, 2002 Technical Revision

August 2001 Complete Revision

Not printed with State funds

8/13/2019 Pip Adg001

3/19

TECHNICAL REVISIONMay 2002

Process Industry Practices Page 1 of 17


Work Processes



Table of Contents

1. Introduction..................................21.1 Purpose .............................................21.2 Scope................................................. 2

2. References....................................2

2.1 Process Industry Practices................2

3. Definitions ....................................3

4. Requirements ...............................34.1 Resources ......................................... 34.2 Planning............................................. 44.3 Organization of a Practice.................6

8/13/2019 Pip Adg001

4/19

PIP ADG001 TECHNICAL REVISIONSpecification for Authors Developing Process Industry Practices May 2002

Page 2 of 17 Process Industry Practices

1. Introduction

1.1 Purpose

This Practice provides information on planning and organizing Process Industry Practices(Practices) for the Process Industry Practices (PIP) initiative.

This Practice is primarily written for authors. Technical writers and PIP editors who work

with the authors also need to know the information contained in this Practice. Following

the recommendations in this Practice ensures that each Practice addresses the intended

audience, is written in the appropriate Practice style, and follows the recommended

Practice organization. Adherence to the requirements of this Practice decreases

maintenance costs for the Practices and increases readability.

1.2 Scope

This Practice describes the major planning decisions that an author makes before writing

a Practice and provides an overview of the organization used for the Practice.

This document supplements and shall be used in conjunction withPIP ADG002,

Specification for Technical Writers Developing Process Industry Practices.

In addition, the technical writer and lead author may want to learn the PIP formatting

standards by readingPIP ADG003, Guide for Editors Formatting Process Industry

Practice with Microsoft Word for Windows.

This document is a complete revision ofPIP ADG001,and therefore revision markings

are not provided.

2. References

Applicable requirements in the following PIP Practices are an integral part of this Practice. Short

titles are used herein where appropriate.

2.1 Process Industry Practices (PIP)

PIP ADG002 Specification for Technical Writers Developing Process Industry

Practices

PIP ADG003 Guide for Editors Formatting Process Industry Practices with

Microsoft Word for Windows

PIP ADG004 Guide for Authors Producing CAD Graphics for Process Industry

Practices

PIP ADG005 Specification for Authors Developing Data Forms for ProcessIndustry Practices

PIP Operations Manual

8/13/2019 Pip Adg001

5/19

TECHNICAL REVISION PIP ADG001May 2002 Specification for Authors Developing Process Industry Practices


3. Definitions

audience:Those who will read and use a Practice to perform the work it describes

authors:Members of a PIP Task Team assigned to develop a Practice

lead author:The Task Team member responsible for coordinating the efforts of the Task Team,

technical writer, and PIP editor. If the Task Team chooses not to employ a technical writer, the

lead author shall fill the technical writers role.

Practice:A compilation of documents inclusive of, but not limited to, text (criteria,

specifications, or procedures), data forms, and drawings

Requirements section:Actions to be performed, conditions to be met, or a combination of the two

as specified by a Practice to the audience

Task Team:The PIP team that has volunteered to develop the Practice. The Task Team is

responsible for planning and writing the Practice as well as complying with PIP standardsregarding organization and writing style.

technical writer:A communications specialist who works with the Task Team and the PIP editor

to write the Practice

4. Requirements

4.1 Resources

4.1.1 Authors

Authors are responsible for the following: Planning and writing Practices

Knowing and applying PIP standards for organization and writing style

Harmonizing member company standards

4.1.2 Lead Author

Lead author is responsible for the following:

Leading the development of a Practice

Ensuring that the Practice follows PIP standards for organization and writing

style

Technical writing, unless employing the help of a technical writing service

Coordinating the work of the authors, the CAD representative, the technical

writer, and the PIP editor

4.1.3 CAD Representative

Refer toPIP ADG004.

8/13/2019 Pip Adg001

6/19



4.1.4 PIP Editor

The PIP editor is responsible for ensuring that all Practices adhere to the required

sentence construction, writing style, format, and organizational structure

specified in all Administrative General (ADG) Practices and thePIP Operations

Manual.

4.1.5 Technical Writing Service

A technical writing service may be employed through the PIP office at the

discretion of the lead author to help write the Practice in the PIP style.

4.2 Planning

Before writing a Practice, the Task Team shall make the following major planning

decisions:

4.2.1 Type of Practice

Determine the type of Practice to develop on the basis of the audience and

intended use. The types of Practices are defined in thePIP Operations Manual,under Guidelines for Writing Practices and Practices Numbering System.

4.2.2 Scope of Practice

Determining the scope of a Practice involves identifying the applicable content to

include in the Practice.

4.2.2.1 Requirements to Include in the Practice

Identify requirements that apply to the Practice by completing the

following steps:

1. Identify the specific work divisions normally associated with the

subject of the Practice. Examples of work divisions follow:

a. Design

b. Detail

c. Manufacture

d. Fabrication

e. Erection

f. Installation

g. Construction

2. Identify the audiences (e.g., designers, fabricators, installers).

3. Determine the Practices to be developed that address the

requirements associated with the subject. The work divisions that are

normally contracted separately shall be described in separate

Practices.

4. Prioritize the Practices for development.

5. Determine the requirements for each Practice. A Practice shall

include only the requirements for which the audience is responsible.

8/13/2019 Pip Adg001

7/19



4.2.2.2 Avoid Duplication of Requirements

If requirements need to be known by more than one audience, the shared

requirements shall be written in only one Practice. If a Practice

containing some of the requirements already exists, the Practice shall be

referenced in the new Practice.Otherwise, the Practice in which the requirements are included is

determined by which work division occurs later in the design,

procurement, and construction process. For example, if a fabrication

Practice and a design Practice share requirements, these requirements

shall appear in the fabrication Practice because fabrication occurs later in

the process. A reference to the fabrication Practice shall appear in the

design Practice. A design Practice shall reference all other Practices

related to the same subject. However, none of the other Practices related

to that subject shall reference the design Practice.

4.2.3 Style of the Practice

There are two styles of Practices:

Exception

Narrative

4.2.3.1 Exception-Style Practice

An exception-style Practice defines exceptions to an industry standard.

An exception-style Practice shall be used if an industry standard already

defines the majority of requirements for a subject. The exception style

shall be the first choice of authors.

Comment: Exception-style Practices reduce the number of

requirements that PIP has to generate and maintain. Italso offers the benefit of alerting the contractor to non-

standard requirements.

4.2.3.2 Narrative-Style Practice

A narrative-style Practice is used if an exception-style Practice is

inappropriate. A narrative-style Practice may supplement the content of

an industry standard, but the Practices requirements are not written as

exceptions to the industry standard; rather, the author selects the

requirements to include and the structure in which they are presented.

4.2.4 Working with Technical Writers and PIP Editors

4.2.4.1 Interaction

A technical writer works with the authors to write a Practice. The authors

concentrate on the content, while the technical writer concentrates on

sentence construction and writing style.

The lead author is required to work with the PIP editor to ensure that the

Practice meets PIP standards for sentence construction, writing style,

format, and organization. Together, the lead author and the PIP editor

shall coordinate the schedule for developing the Practice.

8/13/2019 Pip Adg001

8/19



The lead author shall begin working with a technical writer, CAD

representative, and the PIP editor during the planning stage of the

Practice development and shall continue through to the final approval

stage. The intent is that the Practice will meet PIP standards before it is

submitted to the Function Team (FT) and the Steering Team for

approval.

4.2.4.2 Sharing Drafts with the Technical Writer and PIP Editor

The lead author shall make each draft of the Practice electronically

accessible for review. The draft Practice shall be in the current PIP-

approved version of Microsoft Word. If the draft Practice includes CAD

drawings, the drawings shall be provided in Adobe Acrobat .PDF format.

4.3 Organization of a Practice

The sections and subsections of a Practice are ordered as listed below. See the

PIP Operations Manualfor recommended language.

4.3.1 Title and Table of Contents Page

The title and table of contents (TOC) page identifies the Practice by number and

title and lists the main headings of the Practice.

The lead author is responsible for providing the Practice title and number. The

PIP editor formats the rest of the TOC page.

The title of the Practice shall indicate the intended audience and purpose of the

Practice. Examples of phrases to be used at the beginning of a title are listed

below:

Design of . . .

Detailing of . . . Manufacturing of . . .

Procurement of . . .

Fabrication of . . .

Erection of . . .

Installation of . .

Construction of . . .

Maintenance of . . .

8/13/2019 Pip Adg001

9/19



The TOC section is mandatory for all Practices except for Piping Line Classes.

See theAppendixfor an example of a Practice TOC.

If data forms and/or drawings are included in the contents of a Practice, they

shall be listed on the TOC page.

If a Practice is jointly authored by two or more FTs, the FTs shall be shown on

the cover page. The FT that has primary responsibility for the Practice shall be

shown first and its numbering system shall be used.

4.3.2 Introduction Section

The Introduction consists of the following subsections arranged in the order as

shown. If the Practice consists of only data forms or drawings, the Introduction

section shall be omitted.

4.3.2.1 Purpose

The Purpose defines the audience and the intended use of the Practice. It

may also describe the benefit of using the Practice.

Because the main purpose of an exception-style Practice is to supplement

an industry code or standard, the Purpose subsection shall identify that

code or standard.

An example of the purpose statement for an exception-style Practice

follows:

This Process Industry Practice (Practice) supplements API 610,

Centrifugal Pumps for General Refinery Services. Together, this

Practice andAPI 610provide requirements to suppliers for the

supply of heavy-duty centrifugal pumps.

4.3.2.2 Scope

The Scope describes the range of topics the Practice covers.

Because the main purpose of an exception-style Practice is to supplement

an industry code or standard, the Scope subsection shall identify that

code or standard.

An example of the scope statement for an exception-style Practice

follows:

This Practice describes additions, changes, and deletions that

have been made toAPI 610.In addition, decisions that have been

made regarding options offered byAPI 610have also been

described.

4.3.3 References Section

4.3.3.1 The References section lists only the Practices, industry codes and

standards, and other documents that are referenced in the Practice.

Comment: Indiscriminate use of references leads to uncertainty for

the vendor and drives up costs.

8/13/2019 Pip Adg001

10/19



4.3.3.2 A reference shall be listed under one of the following subheadings:


Industry Codes and Standards

Government Regulations

Other References

4.3.3.3 The References section shall be omitted if no documents are referenced

or if the Practice consists of only data forms or drawings.

4.3.3.4 References to Practices, industry codes, and industry standards that are

currently under development, not approved, and not readily available are

prohibited.

4.3.3.5 The only exception may be granted in the case of a design document that

is intended only for the engineering community. The status of the

referenced document shall be clearly indicated.

4.3.3.6 Practices and industry codes and standards shall be identified by the

organizations acronym (shown in parentheses next to the initial spelled-

out name of the organization) and identification code (assuming that it

has an identification code), date, and name.

4.3.3.7 Practices and industry codes and standards shall be listed in ascending

alphanumerical order by identification code, then date, and finally title.

4.3.3.8 Government regulations shall be referenced only to support technical

requirements in a Practice. Government references shall be listed in

ascending alphanumerical order.

4.3.3.9 Documents listed under the Other References subheading are typically

books and journal articles and shall be arranged in ascending alphabeticalorder by title. Books shall be identified by author, title, edition number

(if known), publisher, and publication date.

4.3.4 Definitions Section

4.3.4.1 The Definitions section defines the following terms:

Words or phrases that are not well known

Words or phrases that have multiple definitions

Industry jargon, symbols, and abbreviations

Words used to identify responsible parties, such as supplier or

purchaser

4.3.4.2 Definitions of terms used in Practices of the same FT shall be consistent.

4.3.4.3 Terms being defined shall be italicized only where presented in the

Definitions section.

4.3.4.4 The Definitions section shall be omitted if no terms require definition in

the Practice.

8/13/2019 Pip Adg001

11/19



4.3.5 Requirements Section

4.3.5.1. The Requirements section contains the requirements of the work process

described in the Practice.

4.3.5.2. The structure of the Requirements section depends on the style of the

Practice.

4.3.5.3 Exception-style Practices shall follow the structure of the industry code

or standard to which the Practice is taking exception. Only those

headings and subheadings from the supplemented document where

exceptions are taken shall be shown.

Comment:Because the Practice uses the same heading numbers as

well as heading text from the supplemented document,

the heading numbers in the Requirements section of the

Practice may begin with any number. Heading numbers

are not always consecutive, but the numbering system is

not random.

Only the subheadings and paragraphs of the Requirements section are

numbered in an exception-style Practice. The other section headings,

subheadings, and paragraphs of the Practice shall not be numbered.

An example of the first paragraph of the Requirements section in

exception-style Practices is as follows:

The numbering of the headings and paragraphs in the

Requirements section corresponds to the numbering ofAPI 610,

which this Practice revises. The type of revision made to a

specified heading or paragraph is described after the heading or

paragraph identification. All provisions ofAPI 610that are not

revised remain in force.Comment:Although the above paragraph is included in the

Requirements section, it is not part of the supplemented

document and therefore is not numbered.

The exceptions fall into one of the following four categories:

Addition

Supplement as follows

New paragraph

Modification

To read as follows (full modification)

(First, Second, Last, etc.) sentence to read as follows (partial

modification)

8/13/2019 Pip Adg001

12/19



Deletion

Delete the following portion

Delete the following sentence

Delete in entirety

Decision

Option selected

An example of how exceptions may be handled in a Practice is shown in

Figure 1.

4.3.5.4 Narrative-style Practices shall follow the natural flow of the work

process and include only those requirements for which the reader is

responsible. See Figure 2 for an example of the narrative-style Practice.

The following are organizational characteristics of the narrative-style

Practices:

All headings and subheadings numbered consecutively

No more than four levels of headings

Only one requirement per paragraph

8/13/2019 Pip Adg001

13/19



1. Requirements

The numbering of the headings and paragraphs in the Requirements section corresponds

to the numbering ofAPI 610,which this Practice revises. The type of revision made to a

specified heading or paragraph is described after the heading or paragraphidentification. All provisions ofAPI 610that are not revised remain in force.

2. Basic Design

2.1 General

2.1.7 Decision. Option Selected:

Head-capacity curves shall rise continuously to shutoff. Head rise for

parallel operation shall be 10 percent minimum.

2.1.21 Addition. New Paragraph:Suction specific speed, calculated at the best efficiency point with the

NPSHR based on a 3 percent head drop, shall not exceed 11,000.

2.10 Lubrication

2.10.3.3 Modification. To Read as Follows:

An oil reservoir, with the characteristics specified in Items 1

through 7, below, shall be supplied.

2.10.3.3 Addition. Supplement as Follows:

SpecificationMSS SP 55shall govern acceptance criteria for

visual inspection.

4. Inspection and Tests

4.4 Preparation for Shipment

4.4.1 Deletion. Delete in Its Entirety:

Additional requirements for shipment preparation shall be specified in

Addendum C, Additional Shipping Requirements.

Figure 1. Example of Key Sections of an Exception-Style Process Industry Practice

8/13/2019 Pip Adg001

14/19



4. Requirements

4.1 Quality Control

4.1.1 The fabricator shall be certified as Category II by the AISC Quality

Certification program.

4.1.2 The fabricator shall be responsible for quality control of all materials

and workmanship.

4.2 Submittals

4.2.1 The fabricator shall submit the following documents to the buyer and

receive approval from the structural engineer of record before the start

of fabrication:

4.2.2.1 Two sets of erection and shop drawings

4.2.2.2 One set of engineering calculation sheets per Section 3.1.4.6

4.2.2.3 One copy of connection design certification per Section 3.1.4.5

4.2.2 A shipping list (including total weight), a bolt list, and two sets of final

erection and shop drawings shall accompany the first shipment of each

release.

4.3 Materials

4.3.1 Structural Shapes, Plates, and Bars

4.3.1.1 ASTM A36orASTM A572Grade 50

4.3.1.2 Structural shapes, plates, and bars are specified on the design

drawings.

4.3.2 Standard Bolt Assemblies

4.3.2.1 Bolt ASTM A307Grade A heavy hex

4.3.2.2 Washer ASTM F436

4.3.2.3 Nut ASTM A563heavy hex

6.

Figure 2. Example of Key Sections of a Narrative-Style Process Industry Practice

8/13/2019 Pip Adg001

15/19



4.3.5.5 Information from reference material shall be cited, not repeated, in a

requirement paragraph. Citation shall be by document number (e.g.,

API Std 650,Section 3.1;PIP RESP001).

4.3.5.6 The structure of the Requirements section is defined by the headings.

4.3.5.7 A comment may be included if necessary to inform the reader of the

reasons for a requirement. The comment paragraph(s) begins with

Comment:and immediately follow the requirement paragraph. The

word Comment shall be italicized and the paragraph shall be

unnumbered.

Comment:If many comments are needed for the Practice, consider

creating a separate guide.

4.3.5.8 The Requirements section shall be omitted if the Practice consists of only

data forms or drawings.

4.3.5.9 Figures shall include photographs, drawings, diagrams, and/or graphs.

Tables shall be used to present numerical data and parallel descriptions.To use figures and tables effectively, follow the guidelines listed below:

Be precise: Keep figures simple. Do not include details that are not

self-explanatory or explained in your text.

Be clear: Figures and tables cannot stand alone.

Label each figure and table with a formal number and title (e.g.,

Table 1. Envelope Dimensions for Underground Pipe).

Introduce figures and tables sequentially in the text in numerical

order (e.g., Figure 1, Figure 2, Table 1, Table 2, etc.).

Provide enough information in the text for good reader

comprehension.

Split information among multiple figures rather than crowd too

much information into one figure.

4.3.6 Appendix Section

The Appendix section includes material that elaborates on or explains

information found in other sections of the Practice. Appendix information is not

essential to the Practice yet should be helpful to a reader seeking further

clarification. Information essential to the text of the Practice shall be placed

within the body of the Practice. Information not helpful to the audience shall be

left out of the Practice entirely.

8/13/2019 Pip Adg001

16/19



4.4 Data Forms

4.4.1 If a Practice contains only data forms with instructions, the instructions shall

contain the sections and subsections as described above.

4.4.2 Refer toPIP ADG005.

4.5 Drawings

Refer toPIP ADG004.

8/13/2019 Pip Adg001

17/19



This page is intentionally blank.

8/13/2019 Pip Adg001

18/19



APPENDIX

Example of the Table of Contents

8/13/2019 Pip Adg001

19/19


P I d t P ti P 17 f 17


Primary Function Team

Additional Function Team(s)



Table of Contents

1. Introduction .................................. 21.1 Purpose ............................................. 21.2 Scope................................................. 2

2. References.................................... 2Process Industry Practices........................ 2

3. Definitions ....................................3

4. Requirements ............................... 34.1 Resources ......................................... 34.2 Planning............................................. 44.3 Organization ...................................... 6

Data FormsData Form Number - Data Form Title

DrawingsDrawing Number - Drawing Title

Pip Adg001

Documents

Transcript of Pip Adg001