1Technical Editing BPS/TC 67/Washington June International Organization for Standardization

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

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

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

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

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

7Technical Editing BPS/TC 67/Washington June 2010 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

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

9Technical Editing BPS/TC 67/Washington June 2010 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 Flexibility: innovations favourably considered

10Technical Editing BPS/TC 67/Washington June 2010 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

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

12Technical Editing BPS/TC 67/Washington June 2010 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

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

14Technical Editing BPS/TC 67/Washington June 2010Provisions 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

15Technical Editing BPS/TC 67/Washington June 2010 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

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

17Technical Editing BPS/TC 67/Washington June 2010 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 ,

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

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

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

21Technical Editing BPS/TC 67/Washington June 2010 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”

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

23Technical Editing BPS/TC 67/Washington June 2010 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, m f )

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

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

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

27Technical Editing BPS/TC 67/Washington June 2010 ISO Online general information: Press releases, ISO Focus information Tips and tools: Project portal: Rice model: URLs to remember

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

29Technical Editing BPS/TC 67/Washington June 2010 Thank you Any questions? Technical Editor: TPM :

30Technical Editing BPS/TC 67/Washington June 2010 Secretaries week/Training material Training material available from course run at ISO/CS ISO Secretaries week Next one – November Material also available upon request 60 slides covering procedures for technical work

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

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

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

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

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

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

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