0% found this document useful (0 votes)
118 views34 pages

Pip Adg003 Specification For Editing Practices: Work Processes

Uploaded by

John Buntales
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
118 views34 pages

Pip Adg003 Specification For Editing Practices: Work Processes

Uploaded by

John Buntales
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 34

COMPLETE REVISION

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.

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 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

Not printed with State funds


COMPLETE REVISION
August 2016

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

Process Industry Practices Page 1 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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 provides guidelines for word usage in Practices.

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.

2.1 Process Industry Practices (PIP)


– PIP ADG001 - Specification for Developing Practices
– PIP ADG004 - Specification for Producing CAD Graphics for Practices
– PIP ADG005 - Specification for Developing Data Forms for Practices
– PIP ADG006 - Specification for Revising Practices
– PIP ADG009 - Guideline for Increasing Global Application of Practices
– PIP ADG010 - Specification for Numbering Practices
– PIP Operations Manual

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

Practice category: Exception-style or narrative-style Practices, data forms, drawings, Piping


Material Line Class Specifications, and Piping Valve Descriptions

Practice section: Divisions of a Practice identified by headings, (e.g., Scope, References,


Definitions, and Requirements)

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)

Process Industry Practices Page 2 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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

Process Industry Practices Page 3 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

a. The cover page includes:


1) The PIP logo and name
2) Authoring Function Team (Arial 16 pt., italic, bold)
3) Practice number and title (Arial 18 pt., bold)
4) Revision type and date
b. The cover page and boiler plate are unnumbered.
c. Header includes the revision type and date. See section 4.1.3.2.4.
2. Boilerplate
Use current boilerplate.

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.

Process Industry Practices Page 4 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

5) Use one or two columns as necessary.

4. Headers and Footers


a. Header and footer shall be shown 0.5 inch from top and bottom
edges of page.
b. Practice number shall be shown at left margin in header on all
narrative pages.
c. Practice title shall be shown below Practice number in header on
all narrative pages.
d. For a Practice that is not yet published, draft stage (e.g., Draft,
Member Company Review, Final Edit, or Steering Team Ballot)
shall be shown at right margin of header.
e. Type of revision shall be shown to right of draft stage in header.
See PIP ADG006 for explanation of types of revisions.
f. Draft stage date (e.g., May 6, 2016) shall be shown below draft
stage in header.
g. At Practice publication, publication date (month and year) shall
replace draft stage date in header.
h. “Process Industry Practices” shall be shown at left margin of
footer.
i. Page number shall be shown at right margin of footer as “Page
<x> of <total number of pages>.”
4.1.3.3 Narrative Format
1. Headings
a. A Practice shall not contain more than four levels of Level 1
(PIP BigHead) headings.
Comment: Exception: Guidelines can contain up to 10 levels
of Level 1 (PIP BigHead) headings.
b. The following heading styles shall be used for the levels
indicated:
1) PIP BigHead
2) PIP Head 1.1
3) PIP Head 1.1.1
4) PIP Head 1.1.1.1
c. See PIP ADG001 for use of headings in exception-style and
narrative-style Practices.
d. See Appendix A for PIP styles examples.
e. Unnumbered Paragraphs

Process Industry Practices Page 5 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

Unnumbered paragraph style shall be used only when a single


paragraph follows a heading.
f. Numbered Paragraphs
1) If more than one paragraph follows a heading, the paragraphs
shall be numbered in accordance with the appropriate style
(e.g., PIP Head 1.1 Ln, PIP Head 1.1.1 Ln, etc.).
2) Headings and numbered paragraphs may both be used within
a numbered list. Headings that are part of a numbered list
shall be regular font (not bold).
2. Lists
a. Practice References Section
1) Bulleted lists shall be used only in the References section of
a Practice.
2) Two levels of bullets shall be used; the first level is preceded
by a bullet point (i.e., “RefBullet” style) and the second level
is preceded by a dash (i.e., “Ref-” style).
b. Practices Requirements Section
1) Lists shall be numbered or lettered.
2) A list following a 4th level header shall be numbered
(i.e., PIP Head 1.1.1.1 list style).
3) A sublist following a 5th level numbered line entry shall be
lettered (i.e., PIP Head 1.1.1.1 sublist style).
4) A list following a numbered or unnumbered paragraph shall
be lettered (i.e., “PIP BigHead List,” “PIP Head 1.1 list,”
“PIP Head 1.1.1 list,” or “PIP Head 1.1.1.1 list” style).
5) A sublist following a lettered line entry in a list shall be
designated with numerals enclosed in parentheses
(i.e., “PIP Head 1.1.1 list,” or “PIP Head 1.1.1.1 list” style).
6) Letter designators shall be lower case (e.g., a., b., c., etc.).
7) Letter designators and numeral designators not in
parentheses shall be followed by a period.
8) If required, alignment of lists shall be adjusted so that the
designator aligns with the left side of the text of the
preceding paragraph.
3. Comments
a. See PIP ADG001 for requirements regarding the application of
comments in the narrative of a Practice.
b. PIP Head 1.1 comment, PIP Head 1.1.1 comment, and PIP Head
1.1.1.1 comment styles shall be used for comments.

Process Industry Practices Page 6 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

c. The word “Comment:” shall be used to introduce a comment


paragraph and shall be manually italicized after the style is
applied.
4. Tables and Figures
a. See PIP ADG001 for requirements for the arrangement of tables
and figures.
b. “Table - <number>” and title shall be shown above the table in
Arial bold 10-point font.
c. “Figure - <number>” and title shall be shown below the figure in
Arial bold 10-point font.
d. Arial bold 10 point font shall be used to distinguish table column
headings from the body of the table.
4.1.3.4 Appendixes
1. All appendixes shall be designated with letters in alphabetical order
(e.g., Appendix A, Appendix B, etc.), including Practices having
only one appendix.
2. Except as stated in Section 4.1.4.3.3, each appendix shall begin with
a title page.
3. For Practices having several short appendixes, a single introductory
title page that lists all the appendixes may be used instead of
providing a separate title page for each appendix.
4. The pages within an appendix shall continue the header and footer
convention and pagination of the Practice narrative.
4.1.3.5 Data Forms
1. The format of data forms shall be in accordance with PIP ADG005.
2. Data forms shall not include headers and footers.
3. Integrated Data Forms
a. Data forms that are inserted into a Practice (i.e., integrated data
forms) shall be placed in the Practice in accordance with
PIP ADG001.
b. A single introductory page that lists all the data form titles shall
be used and unnumbered.
4. Stand-Alone Data Forms
a. A stand-alone data form consists of a Practice cover page,
boilerplate, and a data form.
5. Electronic Entry Data Sheets (EEDS)
a. An EEDS is a data form that has protected fields for computer
data entry.
b. See EEDS posting procedures in Appendix D-4.

Process Industry Practices Page 7 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Process Industry Practices Page 8 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

4.1.4.2 Data Forms


1. dataform_standard.dot uses standard portrait structure. This template
contains PIP styles for data forms in accordance with PIP ADG005.
Template dataform_standard.dot is available in the Editors folder on
the server.
2. dataform_landscape.dot uses landscape structure. This template
contains PIP styles for data forms in accordance with PIP ADG005.
Template dataform_landscape.dot is available in the Editors folder
on the server.
4.1.4.3 Piping Material Line Class Specification
1. See PIP website for examples of Piping Material Line Class
Specifications.
2. See PIP website for the list of Master Notes that shall be used in the
Notes area of a specification. Notes selected for a Practice shall
maintain the unique numbers assigned in the Master Notes list.
4.1.4.4 See PIP website for examples of Piping Valve Descriptions.
4.1.5 Applying PIP Template to Practice Drafts
4.1.5.1 To apply PIP Practice Template.dot to a Practice, the following steps
shall be completed:
a. Open PIP Practice Template.dot and place cursor at the bottom of the
entire document (i.e., at the top of the fourth page)
b. From the “Insert” tab, select “Text from File” from the “Object”
menu and open the .docx file of the Practice draft.
c. “Save as” file with “Practice number.docx” as the filename.
d. For each structural level (e.g., headings, paragraphs, numbered
Practice sections), apply the appropriate PIP style and page set up.
See Appendixes A and B-1.
e. Editor shall update the cover, boilerplate, and TOC pages.
f. Editor shall verify all paragraphs have PIP styles applied.
4.1.5.2 For unusual cases (e.g., embedded equations), the MS Word Normal
style can be used with adjustments as required to facilitate the
appearance of the narrative.
4.2 Word Usage
4.2.1 See PIP ADG001 for word usage in Practices (e.g., Scope, References, and
Definitions sections; exception-style Practices; and Practice titles).
4.2.2 The word usages shown in Appendix B shall also be used for copyediting.
4.3 Process Management Procedures
4.3.1 Editors’ Informal Status Reports
At the beginning of each month, an informal status report shall be posted on the
PIP In Progress web page showing current status of Practices in revision.

Process Industry Practices Page 9 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

4.3.2 Practice Development and Publication


4.3.2.1 A Practice shall be prepared for Member Company Review (MCR) in
accordance with the instructions provided in Appendix C-1 and C-2.
4.3.2.2 The completion of the various preparation activities shall be performed
according to the MCR Checklist provided in Appendix C-2.
4.3.2.3 The completion of the various approval and publication activities shall be
performed according to the STB and Publishing Checklist provided in
Appendix C-3 and C-4.
4.3.2.4 MS Word document properties and attributes shall be included in the
Practice electronic file in accordance with Appendix C-5.
4.3.2.5 Practice pricing shall be determined in accordance with the guidelines in
Appendix C-6.
4.3.2.6 The posting of electronic entry data sheets (EEDS) shall be performed in
accordance with Appendix C-7.
4.3.3 Piping and Pipeline Systems Function Team Work Processes
4.3.3.1 The Piping and Pipeline Systems Material Specifications Practices shall
be developed and maintained in accordance with Appendix D-1.
4.3.3.2 The Valve Description Practices shall be developed and maintained
using the PIP Excel valve database in accordance with Appendix D-2.
4.3.3.3 The Piping Material Specifications Master Notes List shall be updated in
accordance with Appendix D-3.
4.3.3.4 The Piping Material Specifications Line Class Index shall be updated in
accordance with Appendix D-4.
4.3.3.5 The Piping Material Specifications Error Log shall be updated and
correction work performed in accordance with Appendix D-5.
4.3.3.6 The Piping Material Specifications Decisions Log shall be maintained by
the Piping Function Team in accordance with Appendix D-6.

Process Industry Practices Page 10 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Process Industry Practices Page 11 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Process Industry Practices Page 12 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Word Usages to Avoid PIP Preferred Usage


& (unless consistently used in tables to save space) and
as well as, plus and
advanced warning, advanced planning, etc. warning, planning, etc.
allow permit
at least equal to or greater than,
a minimum of
close proximity close (or “proximity,” but not both)
comprised of, made up of, composed of consists of
done, created, produced, prepared performed, developed
due to (unless synonymous with “attributable to”) because of
as a result of, since because of
each and every each or every, but not both
exceed be greater than
in order to to
insure (unless in relation to insurance), assure ensure
normally, usually, frequently (if not referring to a time frame) typically
commonly, generally typically
must, will shall
per (unless used in tables to save space) in accordance with
conforming to,according to, comply with, etc. in accordance with
period of time period (or “time,” but not both)
portion part
prior to before
thru or “–“ (unless used in tables to save space) through
via, by way of, by means of through
when (used to express location) where
when (used in conjunction with a possible outcome) if
whether (unless “if” is not the question) if

Process Industry Practices Page 13 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

Typical Words and Phrases


compare to: Indicates a comparison to show similarities
compare with: Indicates a comparison to show differences
inches/inch: spell out in narrative text, but abbreviate ft, m, mm, etc.
. . . purchaser’s PIP XXXXXXXX Data Sheet . . .
PIP XXXXXXXX, Appendix A [start a citation with the “standard” number]
The purchaser shall furnish . . .
The supplier shall provide . . .
can: Means “am (is, are) able.” Not to be used as a substitute for “may.”
may: Means “have (has) permission to.”
Unless otherwise specified/approved,etc. (Use at front of sentence; avoid if possible)
All, any, some (should be minimized)
Less, greater (minimize: warmer/colder, lower/higher, below/above, </>)

Hyphenation of Numerical Expressions


If a unit of measure precedes a noun, a hyphen shall be used between the numeral and the unit
of measure. If the unit of measure precedes any other part of speech, a hyphen should not be
inserted between the numeral and the unit of measure. See the following examples:
1.5-inch clearance [noun] but 1.5 inches of clearance [prepositional]
12-ft-diameter vessel [noun] but a vessel diameter of 12 ft [adjectival]
1- to 25-ft clearance [noun] but 1 to 25 ft of clearance [preposition]

Nonbreaking Space and Nonbreaking Hyphen


If needed to keep the entire expression on the same line, a nonbreaking space (i.e., control +
shift + space) or nonbreaking hyphen (i.e. control + shift + hyphen) shall be used (with no space
before or after the nonbreaking space or hyphen) between numerical expressions, figure and
table call-outs, and alphanumeric reference citations (e.g., ANSI/AMCA 210,
OSHA 29 CFR 1919, SSPC SP-6, Figure A-2, 4-ft diameter).

Process Industry Practices Page 14 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

Appendix C
Checklists, Pricing Guidelines, and Posting Instructions

Appendix C-1 – Draft Review and Member Company Review Instructions


Appendix C-2 – Member Company Review Checklist
Appendix C-3 – Steering Team Ballot Instructions
Appendix C-4 – Publishing Instructions
Appendix C-5 – Document Properties
Appendix C-6 – Practices Pricing Guidelines
Appendix C-7 – EEDS Posting Instructions

Process Industry Practices Page 15 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

Appendix C-1
Draft Review and Member Company Review Instructions

1. FTL begins editing process for all Practices except reaffirmations.


For reaffirmations, Editor begins editing process upon PRP approval.
2. On SharePoint, maintain an archive of all drafts of the pre-published Practice.
3. Throughout the process, update Practice folder name on <Editor’s> folder on PIP shared
server to reflect current Practice stage and date of update (for Editor’s Informal Status
Report).
4. Verify Practice is in current template with current boilerplate.
5. For all types of revisions, add or update Publishing History on boilerplate page in accordance
with PIP ADG006.
6. In Practice header, show “DRAFT <revision type>” and the date.
7. For a new Practice, email draft to Associate Director for an editorial consistency review. For
a revised Practice, incorporate or verify the Associate Director’s editorial consistency mark-
up.
8. For all Practice revisions except Complete Revisions and New Practices, format and edit with
Word’s tracking tool turned on, so that change bars, in accordance with PIP ADG006, can be
shown in the margins when STB and Publication PDFs are prepared.
9. For Complete Revisions, accept all FT edits, then format and edit with Word’s tracking tool
turned on, so that FTL will receive only new editorial markups.
10. Request FTL to keep Word’s tracking tool turned on when making all changes to this
document in order to obtain a complete record of all changes.
11. Cross-check section number references in revised data form with section numbers in the
associated revised Practice.
12. When emailing the FTL, copy any Reviewing FTL and/or a Joint Author FTL (listed on the
PSR).
13. Update header for all Practice sections to show “MEMBER COMPANY REVIEW” and the
date.
14. Practices go to MCR as a Word file unless they contain a data sheet or CAD files.
15. If Practice has CAD files collect PDFs of the details from the FTL for MCR. Due to possible
changes during MCR, do not collect the final CAD files (.dgns and .dwgs) or the CAD
transmittal form until after STB.
16. If Practice contains a data sheet or CAD, create PDF of narrative and insert PDF of data form
or CAD to create one PDF.
17. Email MCR Signoff Approval Request to FTL and any Joint Author FTL. Attach a copy of
Practice or direct the FTL to the Practice on SharePoint.
18. When MCR Signoff Approval is received, post the Practice to MCR.
19. Post Practice Revision Overview (PRO) if applicable.
20. On MCR due date (five weeks after MCR posting), notify FTL of MCR completion.

Process Industry Practices Page 16 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Process Industry Practices Page 17 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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

Process Industry Practices Page 18 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Process Industry Practices Page 19 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Process Industry Practices Page 20 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

For Category, use


Sub-discipline
(see Practices Lists on
PIP website).

For Keywords, use first paragraph


of Practice Purpose. Use keywords
only. Do not use words such as
“the,” “for,” “us,” “by,” “and,” etc.

Figure C-1 – Document Properties Summary Tab Example

Process Industry Practices Page 21 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

In Custom Tab, enter the following:


1. For Name, type Issuedate.
2. For Type, select Text.
3. For Value, type <Month Year> of
Practice Revision date.
4. Click the Add button (will replace the
Modify button when date is typed in).

New Revision date should appear in


the Properties box.
5. Click OK.

Figure C-2 – Document Properties Custom Tab Example

Process Industry Practices Page 22 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Piping Material Specs (PMS) $75 each

Valve Descriptions $100 each

Narrative-only Practices $100 minimum. Any pages over Page 20


(including Appendices) are $5 per page

Narrative Practice with Data Sheets $100 minimum (plus $5 per page for any pages
over Page 20), plus $50

Data Sheet Only Practices $50, regardless of page number

Narrative Practices with Drawings $100 minimum (plus $5 per page for any pages
over Page 20), plus $25 per drawing

Drawings Only Practice $100 minimum (calculate price based on $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.

EEDS sales to the public are offered through our distributors.

Process Industry Practices Page 23 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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”.

The order for posting Practices with EEDS shall be as follows:

a. If the data sheet is included in a Practice’s appendix:


Native = .docx file of complete Practice title page, disclaimer, TOC, narrative text, etc. and
unprotected .docx or .xlsx data sheet file
EEDS = .docx or .xlsx password-protected data sheet file only (no title page, disclaimer, TOC,
etc.)
PDF = .pdf of complete Practice including title page, disclaimer, TOC, narrative text, data sheet, etc.

b. If the data sheet is a “stand alone” Practice:


Native = .docx file of data sheet Practice title page and disclaimer, and unprotected .docx or .xlsx
data sheet file
EEDS = .docx or .xlsx password-protected data sheet file only (no title page and disclaimer)
PDF = .pdf of complete data sheet Practice including title page, disclaimer, and data sheet

In the Subscribers area of the PIP website, no native files shall be posted; only the EEDS and .pdf files.

Process Industry Practices Page 24 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

Appendix D
Piping Function Team Work Processes

Appendix D-1 – Piping Materials Specifications Practices


Appendix D-2 – Valve Description Practices
Appendix D-3 – PMS Master Notes List
Appendix D-4 – PMS Line Class Index (PIP PNCM0002)
Appendix D-5 – PMS Error Log
Appendix D-6 – PMS Practices Decisions List

Process Industry Practices Page 25 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Process Industry Practices Page 26 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Process Industry Practices Page 27 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Process Industry Practices Page 28 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

2. Piping FT provides Master Notes revisions to the PIP Editor.

3. Editor updates the Master Notes list. Changes from the last update are accepted. Current changes
are shown in tracking.

4. Editor maintains hard copy file of changes.

5. Editor sends updated list to webmaster to be posted to Piping area.

6. Editor updates Master Notes on each PMS Practice as it is revised.

Process Industry Practices Page 29 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

Process Industry Practices Page 30 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

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.

2. Piping FT provides updated Error Logs to the PIP Associate Director.

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.

Process Industry Practices Page 31 of 32


PIP ADG003 COMPLETE REVISION
Specification for Editing Practices August 2016

Appendix D-6
PMS Practices Decisions List
Work Process

1. Piping FT updates the Decisions List as required at each FT meeting.

2. Piping FT maintains past revisions of the Decisions List.

3. Piping FT provides the updated Decisions List on the SharePoint site.

Process Industry Practices Page 32 of 32

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy