Pip Adg003 Specification For Editing Practices: Work Processes
Pip Adg003 Specification For Editing Practices: Work Processes
August 2016
Work Processes
PIP ADG003
Specification for Editing Practices
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.
© 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 or modifications of any kind
are not permitted within any PIP Practice without the express written authorization of PIP.
Authorized Users may attach addenda or overlays to clearly indicate modifications or
exceptions to specific sections of PIP Practices. Authorized Users may provide their clients,
suppliers and contractors with copies of the Practice solely for Authorized Users’ purposes.
These purposes include but are not limited to the procurement process (e.g., as attachments to
requests for quotation/ purchase orders or requests for proposals/contracts) and preparation and
issue of design engineering deliverables for use on a specific project by Authorized User’s
client. PIP’s copyright notices must be clearly indicated and unequivocally incorporated in
documents where an Authorized User desires to provide any third party with copies of the
Practice.
PUBLISHING HISTORY
May 1994 Issued
November 1998 Revision
December 2000 Complete Revision
July 2005 Complete Revision
February 2011 Complete Revision
August 2016 Complete Revision
Work Processes
PIP ADG003
Specification for Editing Practices
Table of Contents
1. Scope ..............................................................................................................2
2. References .....................................................................................................2
2.1 Process Industry Practices ................................................................................................ 2
3. Definitions ......................................................................................................2
4. Requirements .................................................................................................3
4.1 Templates, Styles, and Structure ...................................................................................... 3
4.1.1 General .................................................................................................................................3
4.1.2 Styles ....................................................................................................................................3
4.1.3 Structure ................................................................................................................................3
4.1.4 Templates and Example Practices ........................................................................................8
4.1.5 Applying PIP Template to Practice Drafts .............................................................................9
4.2 Word Usage....................................................................................................................... 9
4.3 Process Management Procedures .................................................................................... 9
4.3.1 Editors’ Informal Status Reports ............................................................................................9
4.3.2 Practice Development and Publication ................................................................................10
4.3.3 Piping and Pipeline Systems Function Team Work Processes ...........................................10
Appendixes ........................................................................................................11
Appendix A - PIP Styles Examples.......................................................................................... 11
Appendix B - Word Usage, Hyphenation, and Nonbreaking Hyphens and Spaces ................ 13
Appendix C - Checklists, Pricing Guidelines, and Posting Instructions ................................... 15
Appendix D - Piping Function Team Work Processes ............................................................ 25
1. Scope
This Practice describes the methods used for editing and managing the production of Practices.
This Practice defines and details template components including Practice styles, Practice layout,
and format for each Practice category.
This Practice describes process management procedures that include review and approval of
Practice drafts, communications between PIP Office and PIP Function Teams, and tracking,
reporting, and archiving the progress of Practice development and publication.
This Practice supplements and shall be used in conjunction with PIP ADG001, PIP ADG004,
PIP ADG005, PIP ADG006, PIP ADG009, and PIP ADG010.
2. References
Applicable parts of the following Practices and other 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.
3. Definitions
format: Organization of a Practice in accordance with the Practice category
lead author: Task Team member responsible for coordinating the efforts of the Task Team and
PIP Editor
structure: Organization of Practice sections, headings, paragraphs, lists, and illustrations (i.e.,
tables and figures)
style: Typographic arrangement and display in the Practices (e.g., font, margins, indentions, line
justification, and spacing)
Task Team: Team chartered by a Function Team to develop a specific Practice. See “Task Team”
in the PIP Operations Manual.
template: A preformatted electronic (.dot) file used to apply the PIP styles, structure, and
formatting to a Practice
4. Requirements
4.1 Templates, Styles, and Structure
4.1.1 General
4.1.1.1 Practices shall be developed using PIP Practice Template.dot located in
the Editors folder on the PIP server. The template consists of the
following:
a. Cover page
b. Boilerplate
c. Table of Contents page
d. Practice narrative
4.1.1.2 The formats of narrative-style and exception-style Practices shall be in
accordance with PIP ADG001.
4.1.2 Styles
4.1.2.1 A standard group of PIP styles contained in the templates shall be
applied to Practices for uniform formatting and appearance.
4.1.2.2 Adjustments to the PIP styles can be made to accommodate special
formatting requirements (e.g., italicizing and scientific notation).
4.1.2.3 The PIP styles shall be in accordance with Appendix A.
4.1.2.4 The following fonts shall be used in Practices:
a. Arial for the cover page, table of contents (TOC), headers, footers,
headings, and tables
b. Times New Roman for all paragraphs in the Practice and on the
cover page and TOC page to identify PIP, Practice number, and the
authoring Function Team
c. Other appropriate fonts if required for scientific notation
4.1.2.5 Rather than page breaks, the keep-with-next paragraph option shall be used
to keep lines that need to remain together from separating at ends of pages.
4.1.3 Structure
4.1.3.1 Margins
1. Left and right margins shall be 1 inch.
2. Margins above or below header and footers shall be .5 inch.
4.1.3.2 Section Setup
1. Cover Page
3. Table of Contents
Comment: Piping Line Class specifications and stand-alone data
sheets include only the cover page and the boilerplate.
a. The table of contents page includes:
1) The PIP logo and name
2) Authoring Function Team (Arial 16 pt., italic)
3) Practice number and title (Arial 18 pt.)
4) Revision type and date
b. The style for the table of contents shall be based on two styles:
first level, PIP Big Head and second level, PIP Head 1.1.
1) The first-level contents shall be listed flush left, and the
second-level contents shall be indented.
2) Page numbers shall be shown to the right, preceded by a tab
leader of evenly spaced leader dots.
c. Page numbering begins on the table of contents page with “Page
1 of <total number of pages>.”
d. Creating the Table of Contents
1) The table of contents shall be created and updated
automatically by placing the cursor in the table of contents
section and pressing the F9 key.
2) Appendix, data form, and drawing title lists shall be
manually added under the appropriate heading at the end of
the table of contents by typing the titles and applying the
TOC 2 style.
3) After data sheet titles, total number of pages per respective
data sheet shall be listed in parentheses.
4) After drawing titles, total number of pages per respective
drawing shall be listed in parentheses.
4.1.3.6 Drawings
1. The format of drawings shall be in accordance with PIP ADG004.
2. Drawings shall be placed in the Practice in accordance with
PIP ADG001.
3. The Function Team or Task Team and associated CAD
representative are responsible for creating the drawings and for
providing original AutoCAD and Microstation files and PDFs of all
drawings to the PIP Editor in accordance with PIP ADG004.
Comment: Minor edits will be made to text of AutoCAD files.
4.1.3.7 Piping Material Line Class Specifications
1. Piping Material Line Class Specifications are Practices composed of
only a Practice cover page, boilerplate, and a standardized
arrangement of tables and note listings.
2. Except for the cover page and boilerplate, the PIP styles and
structures in Sections 4.1.2 and 4.1.3 shall not be used for Piping
Material Line Class Specifications.
3. The tables and note listings of Piping Material Line Class
Specifications shall be manually arranged using 6- and 8-point Times
New Roman.
4.1.3.8 Piping Valve Descriptions
1. Piping Valve Descriptions are Practices composed of a Practice cover
page, boilerplate, title and table of contents page, a standardized
narrative, a valve number to Piping Material Practices cross reference
list, and a list of valve descriptions at the end of the document.
2. The narrative comprises the following Practice section headings:
a. Scope (See PIP ADG001)
b. References (See PIP ADG001)
c. Valve Designation System (describes valve numbering)
d. Notes (provides information specific to the type of valve)
e. Cross Reference (lists the valves that are included in the Practice
and cross references these valves to the Piping Material Line
Class Specifications in which they are included)
f. Valve Descriptions shall be automatically generated from the
Excel valve database maintained by PIP. See Appendix D-2.
4.1.4 Templates and Example Practices
4.1.4.1 Template PIP Practice Template.dot shall be used for narrative Practices.
This template contains the cover page, boilerplate and PIP styles for a
Practice. Practices shall be .docx files prepared from this .dot file.
Template PIP Practice Template.dot is available in the Editors folder on
the server.
Appendix A
PIP Styles Examples
A-1. General
PIP template styles shall be applied to all Practices as demonstrated in this appendix.
1. PIP BigHead - This style is called “PIP BigHead,” and initial numeral,
followed by a decimal. See also Appendix B-5.
PIP BigHead Graph - This style is called “PIP BigHead Graph,” and its left margin aligns with
the first word of the PIP BigHead heading. See also Appendix B-6.
a. PIP BigHead List - This style is called “PIP BigHead List,” and the initial alpha or numeric
designator is automatically applied. See also Appendix B-8.
Definition: PIP Def - This style is called “PIP Def,” and italics are automatically applied to the
initial word(s), and one space (not a tab) is used after the colon. See also Appendix B-6.
1.1 PIP Head 1.1 - This style is called “PIP Head 1.1,” and initial numeral is
automatically applied. See also Appendix B-5.
PIP Head 1.1 graph - This style is called “PIP Head 1.1 graph,” and its left margin aligns
with the first word of the PIP Head l.1. style. See also Appendix B-6.
1.1 PIP Head 1.1 Ln - This style is called “PIP Head 1.1 Ln,” and initial numeral is
automatically applied. See also Appendix B-7.
a. PIP Head 1.1 list - This style is called “PIP Head 1.1 list,” and initial alpha or
numeric designator is automatically applied. See also Appendix B-8.
Comment: PIP Head 1.1 Comment - This style is called “PIP Head 1.1 Comment,”
and initial italics are automatically applied. See also Appendix B-9.
1.1.1 PIP Head 1.1.1 - This style is called “PIP Head 1.1.1,” and initial
numeral is automatically applied. See also Appendix B-5.
1.1.1 PIP Head 1.1.1 Ln - This style is called “PIP Head 1.1.1 Ln,” and initial numeral
is automatically applied. See also Appendix B-7.
PIP Head 1.1.1 graph - This style is called “PIP Head 1.1.1 graph,” and its left
margin aligns with the first word of the PIP Head 1.1.1 style. See also Appendix
B-6.
a. PIP Head 1.1.1 list - This style is called “PIP Head 1.1.1 list,” and initial
alpha or numeric designator is automatically applied. See also Appendix B-8.
Comment: PIP Head 1.1.1 comment - This style is called “PIP Head 1.1.1
comment,” and initial italics are automatically applied. See also
Appendix B-9.
1.1.1.1 PIP Head 1.1.1.1 - This style is called “PIP Head 1.1.1.1.” and initial
numeral is manually applied. See also Appendix B-7.
1.1.1.1 PIP Head 1.1.1.1 Ln - This style is called “PIP Head 1.1.1.1 Ln,” and
initial numeral is manually applied. See also Appendix B-7.
PIP Head 1.1.1.1 graph - This style is called “PIP Head 1.1.1.1 graph,”
and its left margin aligns with the first word of the PIP Head 1.1.1.1
style. See also Appendix B-6.
a. PIP Head 1.1.1.1 list - This style is called “PIP Head 1.1.1.1 list,”
and initial numeral is manually applied. See also Appendix B-8.
(1) PIP Head 1.1.1.1 sublist - This style is called “PIP Head 1.1.1.1
sublist,” and initial numeral or alpha designator is manually
applied. See also Appendix B-8.
Comment: PIP Head 1.1.1.1 comment - This style is called
“PIP Head 1.1.1.1 comment,” and initial italics are
manually applied. See also Appendix B-9.
– Ref- - This style is called “Ref-,” and it is used only in the References section. The
dash is automatically inserted followed by a tab. See also Appendix B-8.
RefBullet - This style is called “RefBullet,” and it is used only in the References
section. The bullet is installed by the styles program. See also Appendix B-8.
PIP_hiddentxt. This style is called PIP_hiddentxt and is to be used by the Function Team for the purpose
of either calling attention to items that need to be resolved at a later time after publication, or providing
information about decisions regarding a Practice requirement. Hidden text will be available only in the
native Practice format.
Appendix B
Word Usage, Hyphenation, and
Nonbreaking Hyphens and Spaces in Practices
The words and expressions in this Appendix are in accordance with dictionaries, accepted usage guides,
or industry-standard references. The word usages are in the context of typical Practice usages. See also
PIP ADG001, Appendix A.
Appendix C
Checklists, Pricing Guidelines, and Posting Instructions
Appendix C-1
Draft Review and Member Company Review Instructions
21. On the In Progress page, change the status of Practice to “In Office.”
22. When all Member comments have been resolved and made to the Practice by the FTL,
proceed to Steering Team Ballot Instructions.
Appendix C-2
Member Company Review Checklist
Completion
Reviewing Stage
Date
1. Received first draft from FTL
2. Editorial Consistency Review completed
3. Formatted by Editor
4. Edited draft sent to FTL
5. Edited draft received from FTL
6. Sent MCR Signoff Approval to FTL (and Joint Author or Reviewing Author)
7. MCR Signoff Approval received from FTL
8. PRO posted In Progress page, if applicable
9. MCR posted on In Progress page and MCR Notification sent to Members
10. MCR Completion Notification and Instructions email sent to FTL
Appendix C-3
Steering Team Ballot Instructions
1. When FTL has resolved MCR comments and all changes have been made to Practice, proceed
with STB preparation.
2. In Practice header show “STEERING TEAM BALLOT - <REVISION TYPE>” and the date.
3. For revisions other than Complete Revisions, in Tools/Options/Track Changes, make selections
so that only “vertical lines” will show in the margin where changes have been made.
4. Make sure hidden text is hidden (not showing).
5. Create a PDF from the .docx file, and incorporate PDFs of data forms and PDFs of CAD,
as applicable.
6. Email STB Signoff Approval Request, with STB PDF attached, to FTL.
7. When STB Signoff Approval is received, post the STB PDF on In Progress page.
8. On STB due date, notify FTL of STB Completion and prepare Practice for publishing.
Appendix C-4
Publishing Instructions
1. On the In Progress page, change the Status of Practice to “Closed,” “with Team,”
and (Reviewer Comments) “Pending.”
2. On the PSR, verify Practice Status updated to “APPRVD.”
3. Collect final CAD files (.dwg and .dgn) and any corrected CAD PDFs from the FTL.
4. Rename or verify file: <Practice number.docx>.
5. Delete “STEERING TEAM BALLOT” from Practice header and change date to spelled out
month and 4-digit year.
6. In PUBLISHING HISTORY section (below boilerplate), insert date (month year) and type of
Revision, or “Issued” for new Practices, and in accordance with PIP ADG006.
7. Verify that pages are numbered correctly.
8. Update Table of Contents (Press F9).
9. For revisions other than Complete Revisions as defined by ADG006, in Tools/Options/Track
Changes, make selections so that only “vertical lines” will show in the margin where changes
have been made.
10. Add Word Document Properties/Attributes in in accordance with Appendix C-4.
11. Create a PDF from the .docx file, incorporating CAD or data sheet PDFs if applicable.
12. Calculate pricing according to PIP Practices Pricing Guidelines (Appendix C-3).
13. Email Publication Signoff Approval request to authoring FTL with the publishable PDF of the
Practice and, if applicable, all protected EEDSs attached. In the email, include suggested
abstract copied from Scope section of Practice. Include suggested price and the month year of
Practice.
14. After receiving Publication Signoff from FTL, remove Practice from the In Progress page, by
submitting “Published” on the Practice Details.
15. Post the files on the website and update the Practice Status Report.
16. Email Administrative Associate requesting announcement of Practice publication. Include
Practice number, Practice title, abstract, price, and the month and year.
Appendix C-5
Document Properties
Before converting to final PDF update document properties. In Word 2013, select File > Properties >
Advanced Properties.
1. In the Summary tab, fill in the fields in accordance with the Practice.
Appendix C-6
Practices Pricing Guidelines
This appendix provides guidance for the PIP Editors in calculating the sales price for a PIP Practice.
All pages except cover page, boilerplate, and blank pages of a Practice shall be included in the price
calculation of a Practice.
Narrative Practice with Data Sheets $100 minimum (plus $5 per page for any pages
over Page 20), plus $50
Narrative Practices with Drawings $100 minimum (plus $5 per page for any pages
over Page 20), plus $25 per drawing
The appropriate FTL shall be notified of the calculated price of a Practice before the Practice is posted on
the web for sale. Adjustments of up to $15 should be made based on the FTL’s input if given.
The PIP Director should be consulted if one or both of the following apply:
The Function Team Leader's input varies the price of a Practice from the calculated price by more
than $15.
The calculated cost of a Practice exceeds $1000.
Appendix C-7
Electronic Entry Data Sheets (EEDS)
Web Site Posting Instructions
An EEDS is a Microsoft Word or Excel electronic PIP data sheet form that has protected fields in which
data can be electronically inserted without changing the structure/format of the form. The PIP office does
not distribute the password used to protect the EEDS forms.
The EEDS shall be posted in the Members and Subscribers “Practices” areas of the PIP website as a
password-protected document under “EEDS.” The Practice title page, disclaimer page, TOC, narrative
text, and any other part of a Practice shall not be included with the EEDS. The EEDS shall not be made
available to non-members.
In the Native area of the PIP website, an unprotected version of the EEDS shall be posted and shall have
the following file extension: “_native .docx” or “_native.xlsx”.
In the Subscribers area of the PIP website, no native files shall be posted; only the EEDS and .pdf files.
Appendix D
Piping Function Team Work Processes
Appendix D-1
Piping Material Specification (PMS)
Maintenance Work Process
1. One or more PMS that are due to start 5-Year review are assigned to a FT member (author) for
updating.
Comment: PMS are typically assigned in groups based on material of construction. Review
should also include associated Valve Description Practices.
2. When a group of PMS is assigned, the author should begin by updating the lowest class (typically
CL 150) PMS first.
Comment: Latest editions of all associated industry standards and Piping Decisions Log should
be reviewed to determine updates needed.
Comment: Wall thicknesses should be checked to be within industry standard allowances.
3. The draft update of the PMS should be reviewed by another experienced associate(s) or a Task
Team.
Comment: Wall thickness calculations should be verified.
Comment: Updates that involve changes in methods or philosophies that are not in accordance
with the Piping Decision Log or are otherwise debatable should be noted for further
discussion with the FT.
4. Debatable changes should be resolved at a FT meeting before incorporating them into a PMS
update.
5. If agreed by FT, new methods or philosophies should be recorded in the Piping Decisions Log.
6. Draft PMS should be reviewed with FT at a regular meeting.
Comment: Draft PMS should be posted on the PIP SharePoint site for early review by interested
FT members before the review at the FT meeting.
7. When FT review has been completed, author should incorporate the FT comments including any
changes to associated Valve Description Practices.
8. Updated PMS and Valve Description Practices should be sent to the PIP Editor with cc to the
FTL.
9. PIP Editor should prepare the PMS Practices for MCR.
Comment: If changes are required for associated Valve Description Practices, these Practices
should also be edited. The PIP Excel valve database should be used by the Editor to
prepare Valve Description Practices. See Appendix D-2 for the Editor’s work process
for preparing Valve Description Practices.
10. PIP Editor should submit the PMS Practices to the FTL, with cc to the author, for approval for
MCR. If Valve Description Practices have been revised, they should also be sent for review.
11. When FTL responds with approval, PIP Editor should post the PMS Practices for MCR. The
associated Valve Description Practices should not be posted, but held for re-publication at the
time that the PMS Practices are re-published.
12. Further reviews and publication should be performed in accordance with the work processes used
for the other PIP Practices.
Appendix D-2
Valve Description Practices
Maintenance Work Process
1. Using the PIP Excel valve database, the PIP Database Analyst should make revisions to existing
valve descriptions or develop new descriptions in the affected GVCC valve catalogs in
accordance with the revisions provided by an author of a specific Piping Material Specification
(PMS) or group of PMS.
2. The PIP Editor should create a PIP report file from the PIP Excel valve database for each Valve
Description Practice catalog that includes updates.
3. The PIP Editor should update the PIP Valve Description Practices by inserting the data from the
PIP Excel valve database report into the Valve Description section (i.e., Section 6) of the
Practices.
4. The updated Valve Description Practices should be sent to the PMS author for approval.
5. Upon publication of the associated PMS, the PIP Editor should publish the affected Valve
Description Practices.
Appendix D-3
PMS Master Notes List
Work Process
1. Piping FT makes note of changes required for the Master Notes as needed, at each FT meeting,
and as PMS Practices are updated.
3. Editor updates the Master Notes list. Changes from the last update are accepted. Current changes
are shown in tracking.
Appendix D-4
PMS Line Class Index (PIP PNCM0002)
Work Process
PIP PNCM0002 “PMS Line Class Index” is provided to the public free of charge as well as the PIP
Member Companies and Subscribers. This Practice should be updated regularly as Piping Material
Specifications (PMS) Practices are added and withdrawn.
1. In January of each year, the PIP Editor updates PIP PNCM0002 with appropriate information
from PMS Practices that have been added and withdrawn during the previous year. Changes from
the last update are shown in tracking. If PMS Practices additions or withdrawals have not
occurred, an update for that year is not necessary.
2. The yearly updates are considered Editorial Revisions and do not change the PIP 5-Year revision
cycle process for the Practice. A PRP for the yearly updates is not submitted to the PIP Steering
Team.
3. Editor submits the updated Practice to the Piping FT Leader for approval to post the Practice on
the PIP Website.
4. Upon approval, Editor accepts the changes and sends the Practice to the webmaster to be posted
to Piping areas in the Public, Member Company and Subscriber Websites.
When the Practice is due for the PIP 5-Year revision cycle review, the Piping FT shall provide a PRP and
update the Practice as required and the Practice shall be submitted for MCR and STB in accordance with
PIP procedures.
Appendix D-5
PMS Error Log
Work Process
1. Piping FT updates the Error Log at each FT meeting. Information regarding errors is obtained
from FT members and from other sources as the Practices are used.
3. Associate Director consults with the PIP Editor and develops plans for correcting the errors.
4. Editor notes the plans for corrections in the appropriate Practice files.
5. Editor makes the corrections in accordance with the agreed correction plans.
6. Associate Director and Editor review the correction completions before each scheduled Piping FT
meeting and update the Error Log on the SharePoint site.
7. Associate Director reports the correction plans and completions to the Piping FT at the FT
meetings.
Appendix D-6
PMS Practices Decisions List
Work Process