International Organization for Standardization www iso org BPSTC

International Organization for Standardization www. iso. org BPS/TC 67/Washington June 2010 Technical Editing 1

Technical Editing by Brian Stanton Technical Editor, Standards Department ISO/TC 67 Washington D. C. June 2010 BPS/TC 67/Washington June 2010 Technical Editing 2

ISO and ISO/TC 67 Editing at ISO/CS Summary BPS/TC 67/Washington June 2010 Technical Editing 3

ISO International Organization for Standardization Membership 160 NSBs Secretariat based in Geneva – 150 people Central policy and publications Includes: editing, drawing, proofing BPS/TC 67/Washington June 2010 Technical Editing 4

ISO/TC 67 29 Participating countries Close co-operation with API Result… prolific Published over 160 documents Average of 130 pages (usual is 50) Portfolio regularly revised…. BPS/TC 67/Washington June 2010 Technical Editing 5

Status of ISO/TC 67 Standards BPS/TC 67/Washington June 2010 Technical Editing 6

ISO/TC 67 Projects 16 publications expected for 2010 So far this year: 5 published and 11 underway More details on Hit-list from ISO/TC server BPS/TC 67/Washington June 2010 Technical Editing 7

Service to ISO/TC 67 Serviced by team: Technical Programme Manager Assistant Technical Editors BPS/TC 67/Washington June 2010 Technical Editing 8

Editing policy and ISO/TC 67 Particularities of Oil and Gas sector recognized All changes checked with Project Leader period for reviewing mandatory Purpose to add value and enhance quality Specific cases can be discussed with TPM Innovations - favourably considered BPS/TC 67/Washington June 2010 Technical Editing 9

ISO survey on ISO/CS services All Secretaries, Chairs, Project Leaders and WG Convenors Good feedback on editing & publication - for ISO/CS to act on Future possibilities for improvements: XML (live) standards as databases BPS/TC 67/Washington June 2010 Technical Editing 10

Editorial rules ISO and ISO/TC 67 Editing at ISO/CS Summary BPS/TC 67/Washington June 2010 Technical Editing 11

Editing at ISO/CS Apply ISO/IEC Directives, Part 2, so that text is. . Clear - comprehensible to the user Complete - no key element (or word) missing Correct - free from mistakes BPS/TC 67/Washington June 2010 Technical Editing 12

Scope Defines unambiguously subject of the document aspects covered, limits of applicability Must be succinct: summary for bibliographic purposes BPS/TC 67/Washington June 2010 Technical Editing 13

Provisions Requirement: “shall” “shall not” “must” “may not” Recommendation: “should” “should not” Permission: “may” “need not” “can” “possible” “impossible” Statement: statement of fact, of possibility, of capability: expression that conveys information Possibility and capability: “can” “cannot” See ISO/IEC Directives, Part 2, 2004, Annex H BPS/TC 67/Washington June 2010 Technical Editing 14

Normative references Normative reference only if cited in text in such a way as to be indispensable for application of document Cannot be normative reference if: not accessible to the public only cited in an informative manner only used as background preparatory material BPS/TC 67/Washington June 2010 Technical Editing 15

Dated vs. undated references Two different types of reference: dated undated BPS/TC 67/Washington June 2010 Technical Editing 16

Subclause vs. paragraph Subclause: Numbered subdivision of a clause Must be at least two subclauses of same level No more than five levels of subclause, e. g. 5. 1. 1. 1, 5. 1. 1. 2 BPS/TC 67/Washington June 2010 Technical Editing 17

Subclause vs. paragraph Paragraph: Unnumbered subdivision of clause or subclause May contain lists BUT cannot refer precisely to a paragraph Avoid “hanging paragraphs”… BPS/TC 67/Washington June 2010 Technical Editing 18

Hanging paragraphs Incorrect 5. 2 Validation of the analysis function Before using the analysis function determined. . . — validation of the response model, — examining compliance with uncertainty requirements, . . . 5. 2. 1 Validation of the response model Response model validation means testing. . . BPS/TC 67/Washington June 2010 Technical Editing 19

Hanging paragraphs Correct 5. 2 Validation of the analysis function 5. 2. 1 General considerations Before using the analysis function determined. . . — validation of the response model, — examining compliance with uncertainty requirements, . . . 5. 2. 2 Validation of the response model Response model validation means testing. . . BPS/TC 67/Washington June 2010 Technical Editing 20

Notes & examples Optional & informative Additional information to assist understanding/use Cannot contain requirements/indispensable information, i. e. no “shall”, “should”, “may” Preferably placed at end of clause/subclause If more than one in a clause/subclause, must be numbered, e. g. “NOTE 1”, “ EXAMPLE 1” BPS/TC 67/Washington June 2010 Technical Editing 21

Quantities, units, symbols and signs In accordance with ISO 80000, IEC 80000 and IEC 60027 Symbol represents variable in text, table, figure, equation Useful checklist in ISO/IEC Directives, Part 2, 2004, Annex I BPS/TC 67/Washington June 2010 Technical Editing 22

Symbols and units ISO style: Times New Roman italics for Latin alphabet (e. g. t, m, d) Symbol italics for Greek letters (e. g. , , ) NOTE: Other types of fonts used in figures Don’t italicize subscripts unless also variables (e. g. q. V , mf) BPS/TC 67/Washington June 2010 Technical Editing 23

Equations Express in mathematically correct form Variables represented by letter symbols, not by descriptive terms or names of quantities Correct BPS/TC 67/Washington June 2010 Incorrect Technical Editing 24

Equations - Incorrect Don’t use multiletter abbreviated terms in equations Incorrect BPS/TC 67/Washington June 2010 Technical Editing 25

Equations - Correct Use symbols in equations Correct BPS/TC 67/Washington June 2010 Technical Editing 26

URLs to remember ISO Online general information: http: //www. iso. org/ Press releases, ISO Focus information Tips and tools: http: //www. iso. org/tipsandtools Project portal: http: //isotc. iso. org/pp/ Rice model: http: //www. iso. org/iso/rice_model BPS/TC 67/Washington June 2010 Technical Editing 27

Secretaries week/Training material available from course run at ISO/CS ISO Secretaries week Next one – November 2010 Email: bosmans@iso. org Material also available upon request 60 slides covering procedures for technical work BPS/TC 67/Washington June 2010 Technical Editing 28

To sum up ISO and ISO/TC 67 Editing at ISO/CS Summary BPS/TC 67/Washington June 2010 Technical Editing 29

Thank you Any questions? e-mail Technical Editor: stanton@iso. org e-mail TPM : vyze@iso. org BPS/TC 67/Washington June 2010 Technical Editing 30

Drafting IS: Where to find rules & tools ISO website: www. iso. org Drafting standards BPS/TC 67/Washington June 2010 Technical Editing 31

Drafting IS: Where to find rules & tools Click on the page for Standards development BPS/TC 67/Washington June 2010 Technical Editing 32

Drafting IS: Where to find rules & tools Click on Processes and procedures BPS/TC 67/Washington June 2010 Technical Editing 33

Drafting IS: Where to find rules & tools Click on Drafting standards BPS/TC 67/Washington June 2010 Technical Editing 34

Drafting IS: Accessing tools ISO/IEC Directives (editorial) Part 2 (2004) Guidelines for texts including Model manuscript Guidelines for graphics Boilerplate texts BPS/TC 67/Washington June 2010 Technical Editing 35

ISO/IEC Directives, Part 2 BPS/TC 67/Washington June 2010 Technical Editing 36

Guidelines: Model manuscripts BPS/TC 67/Washington June 2010 Technical Editing 37