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

1 Technical EditingBPS/TC 67/WashingtonJune 2010

www.iso.orgwww.iso.org

International Organization International Organization for Standardizationfor Standardization


Technical EditingTechnical Editing

by Brian Stantonby Brian StantonTechnical Editor, Standards DepartmentTechnical Editor, Standards Department

ISO/TC 67ISO/TC 67Washington D.C. June 2010Washington D.C. June 2010


ISO and ISO/TC 67ISO and ISO/TC 67

ISO and ISO/TC 67

Editing at ISO/CS

Summary


ISOISO

International Organization for Standardization

Membership 160 National Standards Bodies

Secretariat based in Geneva – 150 people

Central policy and publications

Includes: editing, drawing, proofing


ISO/TC 67ISO/TC 67

29 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….


Status of ISO/TC 67 StandardsStatus of ISO/TC 67 Standards

48%

28%

24%

Still Confirmed Under revision Under review


ISO/TC 67 ProjectsISO/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


Service to ISO/TC 67Service to ISO/TC 67

Serviced by team:

Technical Programme Manager

Assistant

Technical Editors


Editing policy and ISO/TC 67 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


ISO survey on ISO/CS servicesISO 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


Editorial rulesEditorial rules

ISO and ISO/TC 67

Editing at ISO/CS

Summary


Editing at ISO/CSEditing 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


ScopeScope

Defines unambiguously

subject of the document

aspects covered,

limits of applicability

Must be succinct: summary for bibliographic purposes


ProvisionsProvisions

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


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


Dated vs. undated referencesDated vs. undated references

Two different types of reference:

dated

undated


Subclause vs. paragraphSubclause 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.1.1, 5.1.1.1.1.2


Subclause vs. paragraphSubclause vs. paragraph

Paragraph:

Unnumbered subdivision of clause or subclause

May contain lists

BUT cannot refer precisely to a paragraph

Avoid “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 ...

Hanging paragraphsHanging 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 ...

Hanging paragraphsHanging paragraphs


Notes & examplesNotes & 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”


Quantities, units, symbols and signsQuantities, 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


Symbols and unitsSymbols and units

ISO style:

Times New Roman italicsfor 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. qV , mf)


EquationsEquations

Express in mathematically correct form

Variables represented by letter symbols, not by descriptive terms or names of quantities

Correct Incorrect


Equations - IncorrectEquations - Incorrect

Don’t use multiletter abbreviated terms in equations

Incorrect


Equations - CorrectEquations - Correct

Use symbols in equations

Correct


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

URLs to rememberURLs to remember


To sum upTo sum up

ISO and ISO/TC 67

Editing at ISO/CS

Summary


Thank youThank you

Any questions?

e-mail Technical Editor: [email protected]

e-mail TPM : [email protected]


Secretaries week/Training materialSecretaries week/Training material

Training material available from course run at ISO/CS

ISO Secretaries week

Next one – November 2010

Email: [email protected]

Material also available upon request

60 slides covering procedures for technical work


Drafting IS: Where to find rules & toolsDrafting IS: Where to find rules & tools

ISO website: www.iso.org

Drafting standards



Click on the page for Standards development



Click on Processes and procedures



Click on Drafting standards


Drafting IS: Accessing toolsDrafting IS: Accessing tools

ISO/IEC Directives (editorial)Part 2 (2004)

Guidelines for texts including Model manuscript

Guidelines for graphics

Boilerplate texts


ISO/IEC Directives, Part 2ISO/IEC Directives, Part 2


Guidelines: Model manuscriptsGuidelines: Model manuscripts

Date post:	03-Jan-2016
Category:	Documents
Upload:	pearl-welch
View:	220 times
Download:	1 times

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

Documents