INTERNATIONAL ELECTROTECHNICAL COMMISSION …tc3.iec.ch/meetings/tc3/2010/Seattle/3Se4.pdf ·...

3(Seattle/Secretary)4 For IEC use only 2010-10-03 ®

INTERNATIONAL ELECTROTECHNICAL COMMISSION

TECHNICAL COMMITTEE 3: INFORMATION STRUCTURES, DOCUMENTATION AND GRAPHICAL SYMBOLS Maintenance Team 21: MAINTENANCE OF IEC 62079 Report on IEC TC 3 MT 21 Activities

1 Organization Convenors: Mrs Gabriela Fleischer (DE) Mr Naoki Tokuda (JP) Members: Mr Sumio Araki (JP)

Mr Thomas Borglin (SE) Mr Kai Bohn (DE) Mr Michael Fritz (DE) Mr Gordon Hayward (GB) Mr Hiroaki Ikeda (JP) Ms Junko KANAMARU (JP) Mr John Perry (GB) Mr Sven Radhe (ISO) Mr Arto Sirviö (FI) Mr Karl-Anker Thorn (DK) Mr Sven Ingolf Garnæs Ring (DK) Mr Roland Schmeling (DE)

2 Status of IEC 82079. The 2nd CD of IEC 82079 was circulated with closing 2010-03-05. The circulation resulted in a big number of comments which required essential changes of the draft. TC 3 Chairman and Secretary decided that a third draft should be circulated. The 3rd CD was circulated with closing date 2010-08-13. Also this circulation resulted in a big number of comments (for one thing because comments from ISO TC 10 on 2nd CD by mistake was not reported to the 2nd CD but to the 3rd). A preliminary compilation of comments was circulated 2010-09-17. MT 21 considered all comments in a meeting in September and prepared a draft intended to be circulated as CDV. The final compilation of comments has been completed but could not be circulated before the TC 3 plenary meeting in Seattle. The draft CC also including the draft CDV is attached to this report.

3 Plans and recommendations The compilation of comments shall be circulated as soon as possible after the TC 3 plenary meeting. MT 21 proposes to circulate the CDV for voting by 2011-01-15. Sven-Anders Lejdeby TC 3 Secretary

® Registered trademark of the International Electrotechnical Commission

3/1022A/CCCOMPILATION OF COMMENTS ON COMMITTEE DRAFT

Project number:IEC 82079-1

Reference number of the CD3/1000/CD

IEC/TC or SCTC 3

Date of circulation

®

2010-10-xx Title of the TC or SC: Information structures, documentation and graphical symbols

Title of the committee draft: IEC 82079-1: Preparation of instructions for use – Structuring, content and presentation - Part 1: General principles and detailed requirements The above-mentioned document was distributed to National Committees with a request that comments be submitted

Report of comments See printout attached

Comments received – see annex1

NOTE: This compilation of comments is the finally revised version of 3/1022/CC with the date of circulation 2010-09-10. For information a preliminary draft of the coming CDV have been attached to this circulation..

DECISION OF THE CHAIRMAN (in cooperation with the secretariat)

A revised committee draft will be distributed as a committee draft for vote (CDV) by (date) 2011-01-15 a

A revised committee draft will be distributed for comment by (date) .......... b

The committee draft and comments will be discussed at the next meeting (date) .......... c NOTE 1 In the case of a proposal a or b made by the chairman, P-members objecting to such a proposal shall inform the Central Office with copy to the secretary in writing within 2 months of the circulation of this compilation (see ISO/IEC Directives, Part 1, 2.5.3). NOTE 2 The above decision is preliminary, since the discussion of implementation of comments is not completed. Final decision will be announced in a revised CC. Eventually objections from P-members should refer to the final proposal. Name or signature of the Secretary Sven-Anders Lejdeby

Name or signature of the Chairman Hans Brückner

1 To be collated on FormComments and annexed

FORM CC (IEC)

2009-01-09 ® Registered trademark of the International Electrotechnical Commission

1

Report of Comments on CD - Document 3/1000/CD

Project: IEC 82079-1 Ed.1: Preparation of instructions for use - Structuring, content and presentation - Part 1: general principles and detailed requirements Circulation Date: 2010-05-14 Closing Date: 2010-08-13

Country Status Received CommentsAustralia O - - Austria P - - Belgium O 2010-07-19 N Bulgaria O - - China P 2010-08-12 Y Czech Republic P 2010-08-12 N Denmark P 2010-08-13 Y Finland P 2010-06-14 Y France P - - Germany P 2010-08-13 Y Hungary P - - India O - - Israel O - - Italy P 2010-07-07 N Japan P - - Korea (Rep. of) O 2010-08-13 N Malaysia O - - Netherlands P 2010-08-09 N Norway P 2010-08-13 Y Pakistan P 2010-08-12 N Poland O - - Portugal P 2010-08-13 N Romania P - - Russian Fed. P 2010-08-13 N Serbia P - - Singapore O - - Slovenia O 2010-07-09 N South Africa O - - Spain P - - Sweden P - - Ukraine O - - United Kingdom P 2010-07-14 Y

P-members O-members Total Y : comment received 6 0 6 N : no comments 6 3 9 - : no response 8 9 17 P-members with no response: Austria, France, Hungary, Japan, Romania, Serbia, Spain,

Sweden

1

Date Document Project Nr. 3/1000/CD IEC 82079-/Ed 1

National Committee

Line number

Clause/ Subclause

Paragraph Figure/ Table

Type of comment

(General/ Technical/Editorial)

COMMENTS Proposed change OBSERVATIONS OF THE SECRETARIAT on each comment submitted

NO1 The Norwegian national committee provide the following answers to the questions raised in document 3/954/DC.

Noted

DE 02 General editorial It appears that often multiple blanks have been used in the text

Search for multiple blanks between words and replace them by a single blank.

Accepted.

DE 03 General editorial Incorrect cross reference, e. g. 6.2.5 and6.8.3 and check-list (Annexes B and C).

Check cross references. Accepted.

DE 04 Generaland 3.45

technical Definition of supplier introduces in the note terms like vendor, distributor, retailer, agency which are not used in the text of the standard but the term "authorized representative" is missing The use of all terms like producer, manufacturer, integrator, ect. should be checked Do we need all of them have to be repeated in the text for several time?

Add to the definition: “and related documentation.” Add to the existing note: “authorised representative” Check if “supplier” can be used everywhere in the document. The definitions for manufacturer, producer and integrator are to be deleted.

Accepted.

DK 01 Foreword

T Annex B is changed to an informative Annex

Annex B, C ... are for information only Accepted.

DE-01_ISO

FOREWORD

ANN. C ge Check list for communication effectiveness should have the same normative status as check list for compliance and comments. Both check lists are equally necessary for the assessment of instructions for use. (cf. A.3)

Annexes A, B and C are normative. Not accepted because Annexes B and C are recommendations which may not be applicable to every situation covered by instructions for use.

DE-02_ISO

FOREWORD

Next par ed Add for. preparing successive drafts, in order to improve them for the principal target groups of the

Already incorporated in 3/1000/CD

GB1 Foreword Page 7

Para 2 Te This states that "Annexes A and B are normative...." This is not correct, Annex B is informative.

Amend to read "Annex A is normative, Annexes B,C, D and E are for information only."

Accepted.

2

National Committee

Line number

Clause/ Subclause


Type of comment



DE 01 Foreword Page 7

2nd paragraph

technical Last sentence the term "target group of the standard is misleading.

The sentence should read as follows: “They are addressed primarily to experts engaged in the evaluation of instructions for use but will also be helpful to writers of instructions for use who may wish to use the checklists while preparing successive drafts, in order to improve them for the principal target groups of the standard. (Delete part of the sentence behind the comma)

Accepted The text is combined with the previous paragraph.

NO2 1 1st para T We do not appreciate a list of examples directly given in the normative text of the scope. The list of examples of products should be presented as a note.

Convert the list of examples of products to a note.

Not accepted because they clarify the coverage of this international standard.

NO3 1 2nd para T We do not appreciate a list of examples directly given in the normative text of the scope. The list of examples of parties should be presented as a note.

Convert the list of examples of parties to a note.

Not accepted because they clarify the coverage of this international standard.

DE 05 1 3 editorial Sentence 3: “The amount … does only refer to the complexity of products. It has to be pointed out that the amount of the documentation in particular the amount of the instructions for use is also reflected by the abilities of the user.

Modify phrase as follows: “Among other considerations, the amount of documentation required, depends on the complexity of a particular product and the skills of the users”.

Partly accepted. The text is changed to improve English.

DE 07 1 last para editorial Terminology inconsistent (“This standard … this standard … This part of international standard …”).

Replace “This part of international standard” by “This standard”.

Not accepted and reference to self shall be in line with the rule. Therefore it reads “This part of the International Standard…”. This will be implemented in the whole document.

JP-01_ISO

1 Last sentence

te We do not think to need “guidance of usage” in the scope.

“It provides guidance on how such instructions for use are to be prepared” should be changed to NOTE of Scope.

Not accepted because the last sentence is not completely state the coverage of this part of the International Standard and covered by the first paragraph. Therefore, the last sentence was deleted.

3

National Committee

Line number

Clause/ Subclause


Type of comment



DE 06 1 and 3.16

para 1 para 2

editorial Font size inconsistent. Correct the formatting. Accepted.

GB2 1 Scope Para 1 Ed Because IEC are leading on this standard there is likely to be a mistaken assumption in some quarters that it relates only to electromechanical products. Therefore, for the avoidance of doubt it is suggested that suitable note be added to the Scope.

After paragraph 1 add "Note - The term "product" covers consumer, professional, electromechanical and mechanical products".

Accepted in principle. MT 21 is consensus to reword the proposed note as follows: NOTE The term "product" as defined in 3.34 relates to consumer, non-consumer, electric, electronic, electromechanical, mechanical and other products.

NO4 2 We note that in definitions provided, other terms defined in the document are written in bold. In other publications of TC3 (see IEC 61082-, IEC 81346-1), such used terms are written in italic. We prefer the latter method to be used.

Write used terms in definitions in italic Accepted. (Pendent)

DE 08 2 editorial The normative references are not correctly presented in accordance with the directives (titles in italics)

Write titles in italics Accepted.

DE 09 2 list editorial ISO_ 12100-1 is mentioned but not the ISO 12100-2 standard which does include in section 6 a detailed description of the documents for the use of machinery.

Add the list with a reference to ISO 12100-2.

Accepted in principle. The new normative reference is “ISO 12100 (all parts), Safety of machinery – Basic concepts, general principles for design”.

GB3 2 Normative references

ISO/DIS 7010

Te This standard will shortly be issued as FDIS.

Amend reference accordingly. Accepted.

DE 10 3 – technical “use” is not defined; “use” could be misinterpreted by only operating the product.

Add a new definition for “use”: “In the international standard “use” means any activity that the user may perform with or on the product in the whole product life cycle”

Accepted in principle. The definition is reworded as follows: any activity that the user may perform with or on the product during its whole life cycle.

DE 11 3.1 editorial Change "design" to designed" Replace "design" by "designed" Not accepted because the term “accessible design” is taken from ISO/IEC Guide 71.

4

National Committee

Line number

Clause/ Subclause


Type of comment



DE-03_ISO

3.1 New definitionAfter 3.1

te It is necessary to distinguish the two methods of safety and warning notes because many technicians use to mix them up

basic safety notes non-contextual notes to be observed through the whole product life cycle

Already covered in 3CD. Compilation of comments on 3/984/CD, i.e. 3/997/CC introduces the new definitions for "safety note" and "warning messages".

JP-02_ISO

3.1 Definition

te Sentence “including older persons and persons with disabilities” is included in the word “potential user”.

Delete the sentence “including older persons and persons with disabilities”.

Accepted.

DK 02 3.4 E We are missing the reference to 3.7 in IEC 81346-1

Make this reference Accepted.

DE-04_ISO

3.7 New definitionafter 3.7

te It is necessary to distinguish the two methods of safety and warning notes because many technicians use to mix them up.

contextual warning messages messages given before a possibly risky work step has to be taken, even redundantly if necessary, resulting from the product risk assessment

Already covered in 3CD. Compilation of comments on 3/984/CD, i.e. 3/997/CC introduces the new definitions for "safety note" and "warning messages".

GB4 3.8 Terms and definitions

Consumer. Note

Ed The Note includes a reference to "skilled person". This is defined at 3.41 and should therefore be in Italic script in 3.8.

Change font to Italic. Accepted.

DE 29 3.9 Modify definition: product to be acquired or used by a consumer

Accepted in principle. Reworded as follows: product available to, intended for or likely to be used by consumers

DE 31 3.9 2nd para editorial Singular instead of plural (last word “consumer”).

Write “used by consumers”. Accepted. See the observations on DE 29.

GB5 3.9 consumer product

Ed Missing indefinite article. Add "a" before "consumer". Already covered by the observation on DE 29.

DE 3 3.9 note editorial Change "design" to designed" Replace "design" by "designed" See the observations on DE 11. JP-03_ISO

3.13 Definition

te Add “administration” as follows. collection and administration of documents ….. .

Not accepted because the concept of administration falls in the area of document management.

5

National Committee

Line number

Clause/ Subclause


Type of comment



DE 12 3.15 technical The definition of foreseeable misuse should be consistent with the usual definition of foreseeable misuse e.g. the definition which is used in section 1.1.1., Annex I of the EC Machinery Directive 2006/42.

Modify the wording as follows: “foreseeable misuse use of a product in a way not described in the instructions for use, which may result from readily predictable human behaviour.”

Accepted in principle. The term is changed to reasonably foreseeable misuse and the definition is changed as follows: use of a product in a way not described as intended use in the instructions for use, but which may result from readily predictable human behaviour.

DK 03 3.16 E We are missing the “NOTE” the note text is already there.

Make the note a NOTE Accepted It is a problem with fonts that have been corrected.

DE- 05_ISO

3.16 te Add reasonably, as applied in relevant legal regulations.

reasonably foreseeable misuse Accepted. See the observations on DE 12.

DE-06_ISO


ed Since this standard demands consistency of terms, it should serve as a good practice example itself.

Illustration common and consistent term for graphic image, picture, figure photograph, line drawing

Accepted in principle taking into account the definition for graphic image. Two terms “graphic image” and “illustration” are combined to produce the following definition: visually perceptible figure, such as graphical image, picture, figure, photograph, line drawing, etc., artificially created to transmit specific information, excluding graphical symbols Relevant terms have been changed as appropriate.

DE 13 3.20 technical Term instruction material should be avoided for consistency reasons.

Delete definition and replace “instruction material” by “instructions for use” or by other defined concepts like “documents” within the entire document.

Accepted.

DE 14 3.21 technical The producer (manufacturer?) is not the solely person which may provide the user with the instructions for use. Also the importer or the distributor of a product may provide the user the necessary information.

Modify phrase as follows: “information provided by the supplier of a product for the user ….

Accepted.

6

National Committee

Line number

Clause/ Subclause


Type of comment



DE 15 3.22 technical The term "user" has to be deleted otherwise the user (for example the consumer) in the role of the integrator is responsible for requirements regarding instructions for use.

Delete "user" in the note Not relevant. According DE 04, the definition is deleted.

FI 1 3.22 Technical Add reference to ISO 11161 where it is originally defined (see definition 3.10 in ISO 11161) Delete note because “user” is confusing

In IEC 82079-1 user is user of the product not integrator.

3.22 integrator entity who designs, provides, manufactures or assembles an integrated manufacturing system and is in charge of the safety strategy, including the protective measures, control interfaces and interconnections of the control system [3.10 of ISO 11161]

Not longer relevant. According DE 04, the definition is deleted.

DE 16 3.23 technical Add "supplier, producer and their authorized representative" to be consistent

Replace terms by supplier only Accepted.

GB6 3.23 Intended use

Ed Clarify meaning. After "not listed" delete rest of sentence and insert "by the manufacturer/producer/integrator are excluded from the intended use of the product."

Accepted.

DE- 07_ISO

3.24 ed Add of. ...from the structure and function of the product

The comment and the proposed change were on 2CD. Text of definition of "intended use" was changed in 3CD. Therefore, they are not relevant.

DE 17 3.26 editorial The note is obviously not finished. The XXX shall be replaced by the correct expression

Not accepted because this expression is appropriate. See IEC 61355.

DE 18 3.26 2nd para editorial Terminology inconsistent (“usage”). Replace “usage” by “use”, because “use” is used throughout the whole document.

Accepted.

GB7 3.26 manual Ed Correct wording. Change "usage" to "use". Accepted. DE 19 3.27 technical Definition is not relevant for the standard. Delete definition Accepted. GB8 3.27 manufact

urer This is the only place in the document

where the term "physical products" appears. What is meant by 'physical' in this context?

Replace “physical product” with “ a product for which instructions for use are required”

Not relevant because the definition was deleted according to the observation on DE-19.

7

National Committee

Line number

Clause/ Subclause


Type of comment



DE 20 3.28 editorial Change the plural of "tactile indicators" to singular to be consistent with other terms

Delete the "s" at the end of "indicators" Accepted.

DK 04 3.29 E A product is singular Change “their” to “its” Not relevant because the text has been changed. See GB9.

DE 21 3.29 editorial Change "their" to "its" intended use" Replace "their" by "its" Not relevant because the text has been changed. See GB9.

DE 22 3.29 2nd para editorial Wrong grammatical number of pronoun “their”, the connection is “product” not “changes”

Replace “their” by “its”. Not relevant because the text has been changed. See GB9.

GB9 3.29 modification

Ed Improve wording. Delete existing text and replace with: "changes made to a product in order to alter its specified intended use".

Accepted.

GB10 3.30 Organisation Note 1

Ed The Note conveys no real information. Delete Note 1. Accepted.

DE 23 3.33 technical What is meant by “content”? Delete “and content” and replace in the note "instruction material" by "related decantation" to be correct

Accepted.

DE 24 3.34 technical Reuse the existing definition of product as defined in IEC 81346-1 definition 3.6

Replace by: intended or accomplished result of labor, or of a natural or artificial process Add a Note: In the context of this standard instructions for use are seen as a part of the product delivery, not as part of the product itself.

Accepted in principle. The definition is changed as follows: intended or accomplished result of labour, or of a natural or artificial process, which could be a good or service. Note Instructions for use are seen as a part of product delivery.

GB11 3.35 Product safety label Note

Ed The Note merely states the obvious and provides no additional information.

Delete Note. Accepted.

GB12 3.36 repair Ed The term "item" appears to refer to a physical object but is generally used in the document to refer to abstract concepts or information.

Delete "an item" and insert "a product". Accepted.

8

National Committee

Line number

Clause/ Subclause


Type of comment



DE 25 3.38 editorial Last part of the sentence sounds odd. Write “… to give users awareness of safe practices.”

Accepted in principle. The definition is changed as follows: safety related information that is collected or grouped in a document or section of a document in a meaningful organizational system to explain safety measures, raise safety awareness and provide a basis for safety related training of users

DE-08_ISO


te Term is needed for a consistent safety strategy.

residual risk risk remaining after each step of the three step integration of safety: immanently safe construction, protection devices, safety instructions

Accepted in principle, but essence of the definition is effectively added as an extension to 4.2.

GB13 3.38 Safety note

Ed Improve wording. After "section of a document" delete rest of text and insert "to explain safety measures, raise safety awareness, or provide safety-related training of users where appropriate.

Accepted.

DE-09_ISO


te Term is needed for a consistent safety strategy: necessary to put safe products in the market.

risk assessment

overall process comprising a risk analysis and a risk evaluation [ISO 12100-1:2003, definition 3.13]

Not accepted because the meaning of the term “risk assessment” depends on the domain and is not possible to define it in the context of this International Standard.

DE-10_ISO

3.42 ed operation = bold print (for consistent presentation)

risks and to avoid hazards which operation or maintenance of a product can create

Not relevant because the text of definition "skilled person" is different in 3CD.

DE 26 3.43 technical Why are stakeholders only interested in risks? The only use of the term “stakeholder” in the document is in chapter 4.1.4 where the term is used in the more general meaning of customer or owner or user. Definition not relevant for this standard

Delete definition “stakeholder” (3.43). See also 4.1.4 (last paragrph) where stakeholder can be replaced by “users and target groups”.

Accepted.

9

National Committee

Line number

Clause/ Subclause


Type of comment



JP-04_ISO

3.43 Definition

te “requirements” Word “requirements” should be changed to “design requirements”.

Comments and proposed change are on 3.43 of 2CD. Definition is not only for design requirements but also for other requirements. Therefore MT 21 suggests to remove the term and definition in the revised text.

DE 27 3.44 editorial Use plural form for "operation" Change "operation" to "operations" Accepted. DK 05 3.46 E Examples do not fit in a definition Make examples as a note Accepted in principle. Definition is

changed as follows: group of persons for which instructions for use are intended.

DE 28 3.47 technical The definition of "url" is not need delete and explain in 5.8.6. Accepted in principle but no explanation is added to 5.8.6. because URL is a common term.

DE-11_ISO

3.47 New clause after 3.47

te Term is needed for a consistent safety strategy

unskilled person individual with no or little education, training and experience to enable him or her to perceive risks and to avoid hazards which operation or maintenance of a product can create; layman

Not accepted. Comments and proposed change are on 3.47 of 2CD. The definition proposed is not adequate and creating comprehensive definition will be too complex to deal with all possible circumstances.

DK 06 3.49 E The definition has to be consistent with the text in 4.2 and 5.4.1

Make the choice: Warning message, or Warning notes

Accepted. Warning message is chosen.

GB14 3.49 Warning message

Ed Improve wording. Line 1: delete "against" and insert "about". Delete "the" and insert "them". Line 2: Delete "hazard". Delete "are" and insert "should be". After "instructions" insert "for use".

Accepted.

DE 32 4 and further documentgeneral

general Guides are matters related to standardization and are not a reference for the target groups of this standard. (seeISO/IEC Directives Part 2 Definition 3.8)

References to Guides should be omitted. Not accepted because if Guide is referenced normatively, e.g. in 4.1.5, reference to the Guide should not be omitted.

10

National Committee

Line number

Clause/ Subclause


Type of comment



DE-12_ISO

4.1.1 ed Improve wording of: "It is important that the level of description and details of information is adapted to the knowledge of target group(s). Based on ascertained needs of the target group, the instruction for use shall ensure the completeness of relevant information in a sufficient level of description."

The level of description and details of information shall be adapted to the knowledge of target group(s). Based on ascertained needs of the target group, the instructions for use shall ensure the completeness of relevant information in a sufficient level of description.

Comments and proposed change are on 4.1.1 of 2CD. The text was changed in 3CD. The comment is not relevant anymore. The new text is as follows: The level of description and details of information shall be adapted to the knowledge of target group(s), Instructions for use shall ensure the completeness of relevant information at a sufficient level of description based on the ascertained needs of the target group.

DE 33 4.1.2 Change header: Instructions for use are part of the product delivery

Not accepted because seeing instructions for use as a part of product insures that the two are considered as whole and not separate entities.

DE 34 4.1.2 1st sentence: A product shall be delivered together with instructions for use…

Not accepted because DE 33 is not accepted.

NO5 4.1.2 1st para, last sent.

T “are and depends” does not provide a requirement, but indicates a statement of facts. We disagree to provide a statement of facts on this issue as this is not true in all cases. The statement should be made as a requirement.

Reword to read: The way in which third party document are integrated shall be based on customer requirements and user needs.

Accepted.

DE 35 4.1.2 2nd clause 2nd sentence

editorial Replace "it" by "they" because it refers to "the instructions for use"

In addition they should … Accepted.

GB15 4.1.2 Para 1 Line 2

Ed Improve wording. Delete "In case that" and insert "Where". Accepted.

11

National Committee

Line number

Clause/ Subclause


Type of comment



DE-13_ISO

4.1.3 Replace shall by may. It depends on the variety of conditions due to the number of distribution channels. (cf. Note 1 of par. 5.10.3)

modifications), and may be provided as a part of instructions for use. (See also Clause 5.)

Comments and proposed change are on 4.1.3 of 2CD. The new text is in 4.1.4 of 3CD. Accepted in principle. The text is changed as follows: and shall be provided together with instructions for use.

DE 37 4.1.3 1st sentence

editorial Replace "All information regarding by "all information in"

Delete "regarding" insert "in" Accepted.

GB16 4.1.3 Line 1 Ed Improve wording. Delete "Regarding" and insert "included in".

Not accepted. See the observation on DE 37.

DE 36 4.1.3 sentence 1

technical This sentence will result in a possible misunderstanding regarding the meaning of “warranty”. The “warranty” does not include any information which might be relevant for the instructions. The instructions for use have to be consistent to the stipulations of the “warranty”.

Modify sentence as follows: “….as advertising or packaging and World Wide Web based information; the information has also to be consistent with the legal requirements which may result from any warranty stipulations.”

Accepted in principle. For improvement, the text is changed as follows: “as advertising or packaging, any warranty and World Wide Web based information, and the information has also to be consistent with the legal requirements which may result from any warranty stipulations”.

DE 38 4.1.4 technical To be consistent with clause 5.2 Start sentence with “If applicable … See also clause 5.2

Withdrawn by DE.

DE 44 4.1.4 technical It is clearly understood that this document is about instructions for use, so the headers shall be short and focus on the issue dealt with in the relevant clause ; see also 4.1.5

Replace header by : Information provided with the sale of products

Accepted in principle. 4.1.4 is split into two subclauses, each with the appropriate heading.

DE 42 4.1.4 2nd para technical The intention of this sentence is unclear. It appears that due to different requirements in different countries the issue of guarantee shall be provided in different documents or not

Replace the existing text by: As guarantee issues may be different depending on countries or sales channels, they may be presented in separate documents.

Accepted in principle The text is improved as follows: It may be appropriate to put the product guarantee into a separate document especially when the terms vary between different sales channels or countries.

12

National Committee

Line number

Clause/ Subclause


Type of comment



DE 39 4.1.4 Last clause

technical To be more precise replace "stakeholders or the general public" by "users and target groups" because the new information is intended to be used by them. If the term "stakeholder" is replaced the definition 3.43 "stakeholder" should be deleted because the term is used only once

Replace text and delete 3.43 Accepted.

DE 40 4.1.4 last para technical Why are stakeholders only interested in risks? The only use of the term “stakeholder” in the document is in chapter 4.1.4 where the term is used in the more general meaning of customer or owner or user.

Replace “the stakeholders or the general public” in 4.1.4 by “anyone interested”.

Accepted.

GB17 4.1.4 Line 1 Ed Correct word. Delete "tterms" and insert "the terms". Accepted. GB18 4.1.4 Page 16

Line 1 Ed Improve wording. Delete "questions" and insert

"information". Accepted.

DE 43 4.1.4 para 1, first sentence

editorial Spelling mistake “tterms”. Delete one t. Not relevant. See GB17.

DE 45 4.1.5 technical A guide not appropriate to be referenced.Security content is sector specific. No sector specific content should be in this standard

Delete this subclause Not accepted because it is not sector specific and if Guide is referenced normatively, e.g. in 4.1.5, reference to the Guide should not be omitted.

DE 46 4.1.5 para 1 editorial Double full stop. Delete one full stop. Accepted. DE 47 4.2 3rd bullet technical The term "warning note" is not correct.

Change to a broader term Insert "safety related information" delete "safety and warning notes".

Replace "safety and warning notes" by "safety related information"

Accepted.

DE 49 4.2 note technical Wording will effect misunderstanding. Modify wording as follows: “As a matter of principle, the supplier has an obligation to include such warnings due to the applicable product liability law.

Accepted in principle. The text is improved as follows: As a matter of principle, the supplier has an obligation to include such safety-related information, in fact it is a legal requirement in most countries.

DE 48 4.2 para 1 technical Instructions are not limited to “protect” the user and the product itself but also other persons and goods.

Write “They shall provide information to avoid any unacceptable risk for the user or other persons, damage to the product itself or other goods, malfunction …”.

Accepted.

13

National Committee

Line number

Clause/ Subclause


Type of comment



DE 50 4.3 last sent. technical The target groups shall be defined at the beginning of the content and not be identified.

Modify term; use defined instead of identified.

Accepted.

DE 51 4.6 editorial For ease of reading the clause within the Guide 71 should be added, to which the reference is made.

Not accepted because the standard should be as simple as possible. There are several appropriate clauses in the guide.

GB20 4.6.1 First bullet

Te Need to clarify meaning. Explain the meaning of "ambient conditions".

Noted. It is impossible to explain therefore the bullet is deleted.

DE 52 4.6.1 Last bullet

editorial To be consistent with Guide 71 Insert "to address the needs of" delete "design"

Accepted.

GB19 4.6.1 Line 1 Ed Improve meaning. Delete "elements". Delete "considered" and insert "taken into account"..

Accepted.

GB21 4.6.1 Para 2 Ed The intention of this paragraph seems to be to link the items listed as bullet points with the material in the following sub clauses. However, there appears to be no connection between them - i.e. the sub clause headings bear no relationship to the bulleted items. The paragraph is therefore meaningless.

Delete paragraph. Accepted.

JP-05_ISO

4.6.1, 4.6.2, and other

ed Marking ● Marking “●“ shall be changed to a), b), c) … .

Noted. The method of itemization was reviewed to be consistent in the whole document.

DE 53 4.6.1. bullet 3 technical Which requirements are similar to the legal requirements? The term “similar requirements” is useless.

Delete “or similar”. Accepted.

DK 07 4.6.2 E (see 4.6.3 below) (see also 4.6.3) Accepted.

14

National Committee

Line number

Clause/ Subclause


Type of comment



DE 55 4.6.2 editorial For better understanding Rearrange the text Accepted. Rearranged as follows: Instructions for use shall be given in one or more of the following locations as appropriate (see also 4.6.3): • inside the packaging together with the product; • on or within the product itself; • on the packaging, but not only on the packaging; • on the World Wide Web sites provided by suppliers: see 4.6.5, 5.6 and 6.2.1, but not only on the World Wide Web; Where instructions for use are complex, it is helpful that certain important messages are additionally given or displayed on the product, for example by means of short reference or reminder cards, stickers, illustrations or labels.

DE 54 4.6.2 a) editorial To be more specific Start with "as a separate document" Accepted in principle as shown in the observation on DE 55.

DE 56 4.6.2 bullet e) editorial For better understanding Stored in the product and made visible or accessible from the outside

Not accepted because the clause is only about location. See the observation on DE 55.

DE 57 4.6.2 c/d editorial Bad formatting of second sentences of list items c and d.

Use line break instead of return so that the list will not seem broken/discontinued.

Accepted in principle as shown in the observation on DE 55.

DE 59 4.6.3 editorial Delete "(GUI"" it is not needed because it is not used in the text

Delete the abbreviation “GUI” Not accepted to keep consistency.

DE 58 4.6.3 Note 1 technical Note 1 is referring to 4.6.2 but it is in contradiction with the recommendations in 4.6.2

Delete Note 1 Accepted.

GB22 4.6.3 Page 18 Para 3 Note

Ed Instructions on products are only useful if they are legible and comprehensible.

At end of first sentence add "provided they are clearly legible."

Noted but the comment is not applicable because the note was deleted. See the observation on DE 58.

15

National Committee

Line number

Clause/ Subclause


Type of comment



DK 08 4.6.4 1. para and 1. bullit

T We talk about a requirement Change “should” to “shall” Accepted in principle. But the text is changed as follows: Instructions for use given on the product shall remain legible throughout the expected life of the product. Instructions for use given on packaging or in materials accompanying the product (such as leaflets, manuals, data media, etc.) shall be produced in durable form. They shall be designed and made so as to survive frequent use during the expected life of the product in the environment where the product is intended to be used.

DE 60 4.6.4 1st bullet technical Important requirement Replace "should" by "shall" and replace “lifecycle” by “use”

Accepted in principle. See the observation on DK 08.

GB23 4.6.4 Line 1 Ed Improve meaning. Delete "application" and insert "use". Accepted. DK 09 4.6.5 1. para T The first requirement demand the next Change “should” to “shall” Accepted. DE 61 4.6.5 2nd

clause editorial To improve understanding/wording Delete "needs to be kept" Accepted.

DK 10 4.6.6 2. para T Are we here talking about permission or possibility

Maybe change “might” to “can” Not accepted because the text is changed as follows: Warning messages for foreseeable exceptional situations shall be assigned only to those nodes in the structure to which they are relevant.

16

National Committee

Line number

Clause/ Subclause


Type of comment




Ed Improve wording. At beginning of line delete "if" and insert "When". Delete "applied" and insert "provided". Delete "such system" and insert "it".

Accepted in principle The text is changed as follows: Where an electronic guidance system is provided, it shall allow a user to navigate through the structure of the system so that the users at any time know where they are in the structure. Users shall be able anytime to view on-screen the system structure, together with its nodes and associated information. The user shall be able to collapse or to expand the system structure as required. Warning messages for foreseeable exceptional situations shall be assigned only to those nodes in the structure to which they are relevant.

GB25 4.6.6 Para 1 Second sentence

Ed Clarify meaning. Delete sentence and insert "Users shall be able at any time to view on-screen the system structure, together with its nodes and associated information."

Accepted in principle The text is changed as observed on GB 24.

GB26 4.6.6 Para 1 Third sentence

Ed Improve wording. Delete sentence and insert "The user shall be able to collapse or expand the system structure as required."

Accepted in principle The text is changed as observed on GB 24.

DE-14_ISO

4.7.1.1 te Add product illustration to support the recognition of the correct instructions for use.

shall comprise the information: productillustration, product name, product type, manufacturer,

Accepted in principle. Reworded as follows: The first page of documentation shall include the information: product name, product type, supplier, document designation. If applicable, product illustration should be provided.

DK 11 4.7.1.1 2. para E A International standard is an very useful option, but not a requirement

Change ... shall indicate that the product is ... to ... shall indicate whether or not the product is ...

Noted he text is changed as follows: Where the product is in conformity with a recognized standard, this shall be clearly indicated.

DE 62 4.7.1.1 2nd clause

technical According to 3.5 Replace "conformance" by "conformity" Accepted.

17

National Committee

Line number

Clause/ Subclause


Type of comment



DK 12 4.7.1.1 3. para T We are talking about "Instructions for use" not the whole documentation.

Delete the paragraph or write: The first page of Instructions for use shall ...

Accepted in principle and reworded as follows: An introduction to instructions for use shall include: the product name and type, the supplier, and document designation.

GB27 4.7.1.1 Para 3 Ed Improve wording. Delete "the information:" and insert "the" before "product name".

Accepted.

DE 63 4.7.1.2 2nd Paragraph)

technical The proposed way is not very helpfu Modify 1st sentence: “There are different ways to organize information, for example …” Modify b) 2nd sentence to : “… highlighted using for example, sub-headings, different colors, …”

Accepted.

GB30 4.7.1.2 b) Line 1

Ed Improve wording of first sentence. Delete first two sentences, insert the following: "Information on all product variants is included in one common section and information relevant only to specific variants is visually distinguished– for example by use of highlighting, colour, font type etc "

Accepted in principle. Incorporated in revised text.

GB32 4.7.1.2 Line 1 Ed Complete wording. At end of line 1 insert "a". Accepted. GB28 4.7.1.2 Para 1

Line 4 Ed Improve wording at end of line 4. Delete "unambiguous" and insert "clearly

specified". Accepted.

GB29 4.7.1.2 Para 3 Line 1

Ed Improve wording. Delete "in case" and insert "Where". Delete "for" and insert "covers".

Accepted.

GB33 4.7.1.4 First sentence.

Ed The second sentence states the requirement. The first sentence is therefore unnecessary (and slightly confusing).

Delete the first sentence. Not accepted however the clause reworded.

DE 64 4.7.1.5 Bullets editorial Notation of list to be corrected Modify to: a) the use of re-chargeable batteries,

and b) the use of non-chargeable batteries.

Not accepted because this is an example of headings.

18

National Committee

Line number

Clause/ Subclause


Type of comment



JP-06_ISO

4.7.1.5 L2 te Quantities shall be expressed in SI units and units outside the SI recognized by CIPM as having to be retained, and for special cases some of their combination with SI units.

Add a NOTE as follows. NOTE Quantities should be expressed by units outside the SI recognized by CIPM as having to be retained, and for special cases some of their combination with SI units.

Comments and proposed change are on 4.7.1.5 of 2CD. The new subclause in 3CD is 4.7.1.4. Not accepted because the paragraph has been amended to commodity use of both SI units and non-SI units.

GB34 4.7.1.5 Line 1 Ed Correct wording. At end of line deleted "d" from "separated".

Accepted.

DE-15_ISO

4.7.1.7 ed Add the missing plural-s. The instructions for use should also contain the name and...

Comments and proposed change are on 4.7.1.7 of 2CD The new subclause in 3CD is 4.7.1.6. The text is already changed accommodating the proposed change. Not longer relevant

GB31 4.7.2 Para 3 Ed Add reference to Annex E Add "(See also Annex E)" to end of paragraph.

Accepted.

DE 65 4.7.2.2 1st sentence 2nd sentence

editorial For consistency Delete "special" insert "particular" before "needs" Replace "Particular target groups" by "Target groups with particular needs"

Accepted in principle. Improved text reads: Where products are intended to be used by target groups with particular needs, instructions for use shall take them into account. Target groups with particular needs include,…

GB35 4.7.2.2 Line 2 Ed Improve wording. After "any special needs" insert "they may have".

Already covered by the observation on DE 65.

GB36 4.7.2.3 Heading Ed Improve wording. Delete "Understandable" and insert "Comprehensible".

Accepted.

GB37 4.7.2.3 Line 1 Ed Improve wording. Delete "easily understandable" and insert "comprehensible".

Accepted.

DE-16_ISO

4.7.2.4 ed Improve wording. The signals should easily be recognizable and understandable by the target groups

Not accepted. English is not good.

DE 66 4.7.2.4 editorial Change order shift note to the end of the clause

Change to: The signals should be easily recognised and understood by the target group. Note….

Accepted but the text is combined to the first paragraph.

DE 67 4.7.2.4 Last sentence

editorial Spelling error Modify to …recognized… Not accepted because British English should be used.

19

National Committee

Line number

Clause/ Subclause


Type of comment



GB38 4.7.2.4 Line 1 Ed Improve wording. Delete "Meaning" and insert "The meanings".

Accepted.

GB39 4.7.2.5 Line 2 Ed Correct wording. Delete "these" and insert "it". Accepted. DE 68 4.7.3.1 technical The clause starting with "If a single

graphical image can serve…" is confusing in relation to the clause above starting with "Where instructions for use are given …"

Delete sentence "If a single…" Add sentence: “A single graphical image may serve for more than one language only if the image is perceived together with the text in every language, and the image does not contain language specific elements.”

Accepted with changes "only if" is replaced with "provided."

DE 69 4.7.3.1 5th para editorial Spelling error Correct to: If a single graphical image can serve multiple language variants …

Accepted.

DE 72 4.7.3.1 last para editorial Missing dash in “language independent means”

Replace by “language-independent means”

Accepted.

GB40 4.7.3.1 Para 2 Bullet a) Line 2

Ed Correct wording. Delete "in" and insert "on". Accepted.

GB41 4.7.3.1 Para 3 Ed .Paragraph 3 is intended to refer to images used to identify a language (e.g. a flag or vehicle plate letters)

In para 3, delete from “they shall..” to end of sentence. Insert “they shall be distinguishable by colour coding and/or by commencing with a graphical imagel widely associated with each language – e.g. a flag or country identification letters.”

Accepted

DE 70 4.7.3.1 para 5 editorial Why “any relevant graphical image”. Wrong full stop after “example”.

Replace “any relevant …” by “a relevant …”. Replace full stop after “example” by a comma.

Noted but text is changed. See the observation on GB41

DE 71 4.7.3.1 para 7 editorial Conflict or misunderstanding with preceding paragraph.

Clarify what is meant, e. g. fold-out page. Not accepted.

DE 74 4.7.3.2 editorial For consistency with the heading change order of words in the 1st sentence

Graphical symbols including safety signs and product safety signs…

Accepted.

DK 13 4.7.3.2 1. para T The first requirement demand the next Change “should” to “shall” Accepted DE 73 4.7.3.2 2nd

sentence technical Make requirement consistent with 5.14.6 Replace “should” by “shall”: Safety signs

and graphical symbols used on the product or within the instructions for use which are neither readily understandable nor unambiguous shall be explained.

Accepted.

DE 75 4.7.3.2 Last bullet

editorial For consistency with the 1st bullet replace "may be" by "are"

Which are internationally acceptable Accepted.

GB42 4.7.3.2 Para 1 Line 2

Ed Improve wording (use correct term) and consistency.

Delete "understandable" and insert "comprehensible".

Accepted.

20

National Committee

Line number

Clause/ Subclause


Type of comment



DE 79 4.7.3.3 technical This clause makes a statement concerning the qualification of translators. For logical reasons, there should also be a statement about the qualification of authors who write the source documents. The statement in this clause should be amended with a new Annexe F – Competencies required for technical communication experts

Add new paragraph after new 1st paragraph “The original and …”: For the creation of the source documents, technical writers or specialists shall be responsible • who have acquired advanced

competences in technical communication (see Annexe F)

• who are familiar with the product, the application, the service or the subject matter

• who know the process chain in the creation of information

• who are able to apply specialized tools for the structured content creation process

Accepted in principle. The text is reworded and included as new clause “4.2 Quality of communication.”

DE 80 4.7.3.3 technical First sentence is divided in two parts. Also one important skill is missing.

Write after the added new paragraph on source documents: “Where instructions for use are translated from the original language into others, expert translators or specialists shall be responsible for the translation including checking and proofreading. Expert translators or specialists are persons • who have basic competences in

technical communication;

• who are familiar with the subject area; • who are fluent in the original

languages, preferably native speakers in the target language;

• who are skilled in using the relevant editing tools;

Not accepted. First 3 bullets are already covered, last bullet is not relevant.

DE 81 4.7.3.3 2nd para technical “Colloquial expressions … should be avoided” is a statement that deals rather with recognized communication principles than with translation.

Shift the whole paragraph to a new clause under 6.x.y “Quality of the original and the translated instructions for use

Accepted in principle. See the observation on DE 79.

21

National Committee

Line number

Clause/ Subclause


Type of comment



DE 78 4.7.3.3 last para technical Regarding the logical structure of the argumentation this paragraph should be put in first place in this clause.

Put paragraph in first place Not accepted But the text is reworded as: The translated instructions for use should be edited by qualified persons specializing in writing and translating for the target groups.

DE 82 4.7.3.3 Last sentence

technical Delete "original and" clause is referring only to the quality of translation

Accepted.

GB43 4.7.3.3 Para 1 Third bullet

Ed Punctuation. Add full stop after "target language". Accepted.

CN 1 5 Proposed to Chapter 5, after the extension of the original s Chapter 5,6

Echoes the standard title, term content to be a separate chapter

Noted.

CN 2 5 5.x electrical and electronic equipment instructions for use For electrical and electronic products, specifications should provide RoHS (Restriction of Hazardous Substance) related content: ——Packaging of the product itself or the period specified product's environmental identity. ——Toxic and hazardous substances to provide products (Pb, Hg, Cd, Cr6 +, PBB, PBDE) content description.

Response to green design and low-carbon, and then add electrical and electronic products specifications of pollution control (RoHS) requirements

Not accepted because proposal is relevant for documentation but not for instructions for use (therefore out of scope).

DE 83 5.1 general technical Consideration of the target group should be emphasized right at the beginning of chapter 5 (like it is done e.g. in 5.9.1).

Add: “The information to be given depends on the target group(s) and the tasks that they are intended or allowed to perform throughout the lifetime of the product.”

Accepted.

DE-17_ISO

5.2 ed Incorrect wording: "notes on reasonably foreseeable use and misuse"

• notes on intended use and reasonably foreseeable misuse;

Accepted.

22

National Committee

Line number

Clause/ Subclause


Type of comment



DE 98 5.2 editorial For clarity replace "it" by "the instructions for use" in the sentence starting with "Furthermore…

Furthermore the instructions for use…. Accepted in principle but instructions for use is replaced by "the specification or description of the product."

DE-18_ISO

5.2 te Add missing requirements. • list of trouble-shooting • service addresses • notes for guarantee • sources of supply for

consumables and spare parts • information about disposal

Not accepted. Requirements are covered in clause 5 and listed bullets are not relevant for identification.

DE 99 5.2 last but one bullet

editorial The “reasonably foreseeable use” is a misleading expression and is not consistent with the terms and definitions

Change the wording to…notes on the intended use and any foreseeable misuse.

Accepted in principle. See the observation on DE-17_ISO.

DE 100 5.2 last clause

editorial Misunderstanding wording. Replace “to show the product… the standard” by “to show that the product complies with particular requirements of these product standards.”

Accepted.

GB44 5.2 Para 1 Line 2

Ed Punctuation. Add colon after "the product by". Accepted.

GB45 5.2 Para 1 Second bullet

Ed Add missing word. Before "supplier's" insert "the". Accepted.

GB46 5.2 Para 1 Third bullet

Ed Missing space. Insert space in "webaddresses". Accepted.

GB47 5.2 Para 2 Seventh bullet

Ed Improve wording. Insert "intended" before "user". Accepted.

DE 101 5.3 1st para technical The intention of that clause is not clearly expressed, as it does not precisely transmit the consequences of modifying a product. The actual text allows too many juridical interpretations.

Change to: When a supplier does not allow to modify the product, this shall be clearly stated in the instructions for use including warnings about possible consequences caused by a modification.

Accepted in principle and reworded: Where a supplier does not allow for a product to be modified this shall be clearly stated in the instructions for use including information about possible consequences caused by a modification.

23

National Committee

Line number

Clause/ Subclause


Type of comment



DE 102 5.3 2nd para editorial Make 2 sentences to avoid misunderstanding

Change to “When a producer allows users to modify a product, the instructions for use shall describe permissible (and non-permissible) modifications. The instructions for use shall clearly describe and illustrate how to undertake permissible modifications (or direct the user to a source of relevant information), so as to allow the user to modify the product correctly and to ensure continuing safe and efficient use.”

Accepted.

DE-19_ISO

5.4.1 te Add basic and contextual to easily distinguish the two types more clearly.

There are two types of safety-related information, basic safety notes and contextual warning messages.

Already covered in 3CD. Compilation of comments on 3/984/CD, i.e. 3/997/CC introduces the new definitions for "safety note" and "warning messages."

DE 103 5.4.1 technical Meaning unclear: Why shall safety-related information refer always to several phases of the life cycle and not only to one phase of the life cycle?

Replace “several” by “all” Accepted in principle. The text was changed. See GB 49.

DE 104 5.4.1 Last sentence

editorial For ease of reading the clause within the Guide 14 should be added, to which the reference is made.

Not accepted because the standard should be as simple as possible. There are several appropriate clauses in the guide.

GB48 5.4.1 Para 1 Ed Improve wording. Delete "distinguished" and "separately identified".

Accepted.

GB49 5.4.1 Para 2 Ed Improve wording. Delete "refer to several" and insert "relate to the various".

Accepted.

GB50 5.4.1 Para 2 Ed The text after "product" does not scan and is unnecessary.

Delete all text after "product" and add full stop.

Accepted.


Ed Redundant word. Delete "aspects" and add comma after "following".

Accepted.

GB52 5.4.1 Para 3 Second bullet Line 2

Ed Improve wording. Delete "applicable" and insert "any necessary". Insert a comma after "tools".

Accepted.

GB53 5.4.1 Para 3 Sixth bullet Line 1

Ed Improve wording. Delete "When failing" and insert "which may result from failure".

Accepted.

24

National Committee

Line number

Clause/ Subclause


Type of comment



GB54 5.4.1 Para 3 Sixth bullet Line 2

Ed Redundancy of meaning. Delete either "immediately" or "without being pointed out".

Accepted.

DK 14 5.4.1 The last para

T This important requirement: Restrictions concerning the use should ...

Should have its own paragraph and change “should” to “shall”

Accepted.

DE-20_ISO

5.4.2 te cf. 5.4.1 5.4.2 Basic safety notes Already covered in 3CD. Compilation of comments on 3/984/CD, i.e. 3/997/CC introduces the new definitions for "safety note" and "warning messages."

DE-21_ISO

5.4.2 te "They shall be visually highlighted." There are more means to make a warning message conspicuous than highlighting.

They shall be made conspicuous. Sentence deleted in 3CD.

DE-22_ISO

5.4.3 te cf. 5.4.1 5.4.3 Contextual warning messages Already covered in 3CD. Compilation of comments on 3/984/CD, i.e. 3/997/CC introduces the new definitions for "safety note" and "warning messages."

DE-23_ISO

5.4.3 te Add sentence "Cross references in warning messages should be avoided."

Not accepted. Cross references in warning messages are required.

GB55 5.4.4 First sentence

Ed The meaning is unclear. Delete from “each single component …“ to end of sentence and replace with “…each component that the manufacturer may despatch separately. “ "

Accepted in principle and the text is reworded as follows: Safety-related information shall be provided with each component. Where an assembly of components might produce additional potential hazards, the relevant safety-related information shall be only provided at the relevant level of assembly.

DE 105 5.4.4 Last sentence

technical To be deleted; IEC 62023 has nothing to do with the previous statements

Delete the reference to IEC 62023 Accepted.

GB56 5.4.4 Second sentence.

Ed Improve wording. Delete "In that case that" and insert "Where".

Accepted.

25

National Committee

Line number

Clause/ Subclause


Type of comment



DK 15 5.7.1 1. para T Important requirement with more items of attention

Change Instructions for use should ... To If applicable instructions for use shall ...

Accepted.

DK 16 5.7.2 1. para T The first requirement demand the next Change ... should include: To ... shall if relevant include:

Accepted.

DE 106 5.7.2 3rd bullet editorial Improve wording for "a checklist of items included in the package"

Replace “item” by “inventory” Not accepted. Meaning of checklist of items is more precise in this context.

DE-24_ISO

5.8.1 ed Replace normal by intended for consistency of wording.

The user shall be provided with information regarding intended and safe operation...

Not accepted. Term "normal operation" is correct.

DE-25_ISO

5.8.1 ed Replace abnormal operation by reasonably foreseeable misuse for consistency of wording.

...as well as reasonably foreseeable misuse of products.

Not accepted. The term "abnormal operation" is correct.

.DE-26_ISO

5.8.2 te "means of emergency stopping;" Correct wording acc. to IEC 60204-1!

• means of emergency stop or emergency switching off;

In 3CD the bullet point is deleted.


Change ... should contain the following: To ... shall if relevant contain the following:

Accepted.

DE 107 5.8.2 Last two bullets

editorial The last two bullets will be combined by the term and

- recommendations for waste removal , and

- identification and correction of malfunctions.

Accepted.

GB57 5.8.2 Line 1 Ed Improve meaning. Delete "contain" and insert "cover". At end of line add ", where applicable".

Accepted.

DE 108 5.8.3 Last two bullets

editorial The last two bullets will be combined by the term and

- - instructions on how to manage fault situations, and

- Information regarding whether the system…

Accepted.

DE 109 5.8.4 First sentence

editorial Spelling error Correct to recognizable Not accepted because deleted according to GB 58.


Ed Delete unnecessary word. Delete "Recognisable" and begin "indications" with an initial upper case letter.

Accepted.

26

National Committee

Line number

Clause/ Subclause


Type of comment




Ed Improve wording. Delete "understandable" and insert "comprehensible".

Accepted.

GB60 5.8.4 Para 3

Ed Improve clarity and use correct term - i.e. 'medical devices'..

Delete sentence and replace with: "Appropriate warnings shall be provided where use of the product in question might affect electrically controlled medical devices, such as heart pacemakers."

Accepted.

DE-27_ISO

5.8.5 te "modes and means for emergency stop;" cf. 5.8.2

• modes and means for emergency stop or emergency switching off;

Not accepted. Used term is sufficient, reason to replace is missing.

GB62 5.8.5

Fifth bullet (page 27) Line 1/2

Ed Improve wording. Delete "possibly associated with the" and insert "that may result from".

Accepted.

GB61 5.8.5 Line 1 Ed Improve wording. Delete line and insert: "Where applicable, information on the following shall be provided:"

Accepted.

DE 110 5.8.5 Page 27 (4th bullet)

editorial "information about" is not needed Delete "information about" Accepted.

DE 111 5.8.6 2nd line editorial The change of terminology is confusing,"the instruction leaflet" is not needed because it is a subcategory of Instructions for use

Consistent terminology shall be used. Delete “instruction leaflet and/or”

Accepted in principle. Necessary rewording in 5.8.6, 5.8.7, 5.9.2 and 5.9.3 has been done.

DE 112 5.8.6 and 5.08.7

Header editorial Harmonize the common parts of the headers of 5.8.6 and 5.8.7

Modify header of 5.8.7 to: Fault diagnosis and repair for skilled persons



Change ... should be provided: To ... shall if relevant be provided:


GB63 5.8.7 Fourth bullet

Ed Improve wording. Delete "rationally" and insert "efficiently". Accepted in principle. Necessary rewording in 5.8.6, 5.8.7, 5.9.2 and 5.9.3 has been done.

GB64 5.8.7 Sixth bullet

Ed Delete redundant word. After the semi-colon delete "and". Accepted in principle. Necessary rewording in 5.8.6, 5.8.7, 5.9.2 and 5.9.3 has been done.

27

National Committee

Line number

Clause/ Subclause


Type of comment



DE-28_ISO

5.9.2 ed For the sake of consistency, replace graphic images by illustrations.

...list of possible operations with appropriate graphic images illustrations


DE 113 5.9.2 editorial For consistency with 5.9 and with the heading of 5.9.2

Delete "Product" in the heading of 5.9.2 Delete "user" insert "non-skilled person" in the text


DK 19 5.9.2 4. and 5. para

T Important requirements Change 4 times “should” to “shall”


DE 115 5.9.2 Header editorial Harmonize the common parts of the headers of 5.9.2 and 5.9.3

Modify header of 5.9.2 to: Product maintenance and troubleshooting by non-skilled persons


DE 114 5.9.2 Last clause

editorial "how" is not needed Delete "how" Accepted in principle. Necessary rewording in 5.8.6, 5.8.7, 5.9.2 and 5.9.3 has been done.

DE 117 5.9.3 technical 1. sentence is partly redundant to 5.9.1. Shift "-preferably as separate documents or at least as separate clauses" to 5.9.1 Start 5.9.3 with "Information on maintenance and troubleshooting should include"

Accepted.


Change ... should include: To ... shall if relevant include:

Accepted.

GB65 5.9.3 Fifth and sixth bullets

Ed Use consistent terminology. Both "fault finding" and "troubleshooting" are used in the body of the document (twice and six times respectively). As "troubleshooting" is used more frequently it is suggested that it be the preferred term.

Delete "fault finding" and insert "troubleshooting" in bullets five and six.


DE 116 5.9.3 Header editorial Harmonize the common parts of the headers of 5.9.2 and 5.9.3

Modify header of 5.9.3 to: Product maintenance and troubleshooting by skilled persons


DE 84 5.10.2 Text editorial Apply identical font Accepted. DK 21 5.10.3 1. para T Important requirement with more items of

attention Change “should” to “shall” Accepted.

DE 85 5.10.3 1st bullet editorial "if applicable" is not needed. Delete Accepted. DE 86 5.10.3 1st bullet editorial 2nd "in the form used" not needed delete Accepted. DE 87 5.12 title technical Ambiguous title New title: “Information on repair of

products and on replacement of parts” Accepted.

28

National Committee

Line number

Clause/ Subclause


Type of comment



DE 88 5.12.1 editorial For consistency e.g. with 5.9 Change heading to "Information on repair of products and replacement of parts for non-skilled persons"

Accepted.

DE 89 5.12.2 editorial For consistency e.g. with 5.9 Change heading to "Information on repair and replacement of parts for skilled persons"

Accepted.

DE 90 5.12.2 last lines technical Information setting up a suitably equipped workshop staffed with skilled persons should not be part of an instruction for use. That could be a complete separated service.

Delete the last two lines Accepted.

DK 22 5.12.2 Last para

T A requirement Change If required ...should ... to If required ... shall ...

Accepted.

DE-29_ISO

5.13.2 ed Rearrange order of words Where relevant, the instructions for use shall state that disassembly by consumers is prohibited.

Accepted in principle and reworded as: Where appropriate, instructions for use shall include information, separately or in combination, on disassembly of the product and/or handling of any waste materials with due regard to safety and environmental considerations.

DE 91 5.13.2 2nd clause

editorial "separately or in combination" is irrelevant

Delete Accepted.

DE 92 5.14.1 editorial Clause is also relevant for other instructions for use not only for manuals

Replace "Manuals" by "Instructions for use"

Accepted.


Ed Improve wording. Delete "contained" and insert "it contains".

Accepted.

GB67 5.14.1 Para 2 Lines 3/4

Ed The text refers to complexity of structuring. However, complexity is subjective: what is overly complex for one type of user could well be acceptable for others.

Delete "and the level of structuring shall not be over complex."

Accepted.

GB68 5.14.1 Para 3 Ed The term "sets" is used here for the only time in the body of the document (apart from in Table 2 in the context of character sets) and is not explained. It should be replaced with "instructions for use".

Delete "sets" and insert "instructions for use".

Accepted.

DE 93 5.14.1 Text editorial Apply identical font Accepted.

29

National Committee

Line number

Clause/ Subclause


Type of comment



DE-30_ISO

5.14.2 te Add sentence. They should be concise and, if possible, in active voice.

Not accepted. The qualifier "if possible" might be interpreted as requiring use of passive voice verbs in tables of contents entries. Since tables of contents entries often lack verbs, such a requirement would not be appropriate.

DE 94 5.14.4 editorial Make 2 sentences to improve understandability

If instructions for use are lengthy and complex, an index of keywords presented in alphabetical order should be included. The index shall be referenced in the table of contents.

Accepted.

DE 96 5.14.5 editorial To specify wording Replace "to have empirical tests" by "to conduct empirical tests"

Accepted.

DE-31_ISO

5.14.5 5.14.6

te Delete: "are not readily understandable or not unambiguous, they ". They shall be defined in any case, because users will find a great variety of meanings for symbols in instructions for use of different manufacturers.

Graphical symbols and tactile dots (Braille) shall be defined.

Accepted in principle and reworded as: Graphical and tactile symbols and tactile dots shall be listed and explained.


technical The aspect of consistency within the instructions for use is missing

Insert after “whether”: "within the instructions for use,"

Accepted in principle and reworded as: Consistent terminology shall be used in the instructions for use themselves on the product itself, on the packaging, or in accompanying material such as manuals.

DE 97 5.14.8 technical This clause may be misinterpreted due to its dual interpretation. Clause 5.14.8 is a sub-clause of 5.14 dealing with the structural layout of the instruction for use. The intention of this requirement is inadequately expressed in this context.

Modify heading to: “Explanation of user controls and indicators” Modify text to: “Instructions for use shall contain a description of the user controls and indicators applicable to the relevant component.”

Accepted in principle. Header adapted to be consistent and "If applicable" is kept.

DE-32_ISO

6.1.1 1st par ed 1st par.: Apply consistency in wording. ...the user (at each step) to a graphic image an illustration...

Accepted.


editorial In the brackets the term "instructions for use" is wrong

delete Accepted.

DE 119 6.1.1 3rd clause

editorial Wrong wording change Change "procedural instructions for use" to "procedural instructions"

Accepted.

30

National Committee

Line number

Clause/ Subclause


Type of comment



DE 118 6.1.1 3rd para technical Text difficult to understand and to translate, add commas.

Modify to : For procedural instructions for use, preconditions for the sequence of necessary steps…

Accepted.

DE-33_ISO

6.1.1 5th par. ed Apply consistency in wording. T he use of graphical images... illustrations... ...meaningful balance of text and graphical images illustrations is recommended.

Accepted.


Ed Improve wording. Deleted "separated and distinguishable" and insert "separately identified".

Accepted.


Ed "Logical" is generally used to describe concepts rather than actions.

Delete "logical" and insert "correct". Accepted.

DE-36_ISO

6.1.10 ed ISO 9241 consists of several parts. ...ergonomic requirements as stated in ISO 9241 series.

Accepted.


Ed Improve wording. Delete "amounts of". Delete "is not useful to keep" and insert "are not helpful in holding".

Accepted.

DE-37_ISO

6.1.12 te add sentence. The assessment criteria are: • wording acc. to editorial style

guide • correct spelling and punctuation • correct grammar • consistency of terms

Accepted.

DE 121 6.1.3 technical Some terms are missing in the list Add to the list: • technical data; • maintenance plan; • trouble shooting;

Not accepted. Proposed items are no text functions.

GB72 6.1.3 9th bullet Es “Hint” has a slightly different meaning in English to German, that usually does not suit standards requirements. “Hints and tips” would be clearer but is colloquial.

Replace “hint” with “suggestions and options” or “prompts and reminders”

Accepted.

GB71 6.1.3 Fourth bullet

Ed "Prerequisite" is being used in an antiquated way in this context.

Replace "Prerequisite" with “tools required and preparations to be made” – [or just “preparations”]

Not accepted. Prerequisite is the term text function and should be kept.

DE-34_ISO

6.1.4 te Add sentences. Cross references should be avoided. Readers use to read a specific chapter. There they should find all information they need in this specific situation.

Accepted in principle and reworded "Cross references shall be kept to a minimum."

31

National Committee

Line number

Clause/ Subclause


Type of comment




Ed The standard deals with instructions for use so there is no need to repeat the term unnecessarily.

Delete "In instructions for use," and begin "terminology" with "T".

Accepted.


Ed The standard deals with instructions for use so there is no need to repeat the term unnecessarily.

Delete "in instructions for use". Accepted.

GB75 6.1.5 Last sentence

Ed Deciding whether information is necessary or unnecessary can only be a subjective judgement and cannot be address in this standard.

Delete sentence. Accepted.

DE 122 6.1.6 technical First 2 sentences are more relevant in 6.1.5

Shift to 6.1.5"The sentence structure should be simple. Sentences should be short and shall be grammatically correct."

Accepted.

DE 123 6.1.7 note editorial

Replace "instructions for use" by "in table 1"

Accepted.

DE 124 6.1.7 Table 1 editorial Correction required Modify to: Fit 3A fuses only Not accepted. No grammatical improvement.

DE 125 6.1.7 table 1 editorial Why do all sentences in the first column start with “to”?

Delete “to” and write “Use the active voice …”, “Be assertive …” and so on.

Accepted.

DE-35_ISO

6.1.8 ed In the middle of the table, replace keep by maintain, because this is the usual term.

Use, maintain, avoid Accepted.

DE-38_ISO

6.2.1 te Add new par. between 2nd and 3rd par. The best possible legibility is achieved when optimizing the relation of the four variables:

• type font

• type size

• number of characters each line (appr. 70)

• line spacing (min. 120 % of type size)

Accepted in principle and reworded

GB78 6.2.1 Table 2

Col 7 Ed In some rows, column 7 is subdivided. The heading needs to explain this subdivision

Graphical symbols including safety signs symbols | safety generally | signs

Accepted.

GB79 6.2.1 Table 2

footnote Ed There is only one general warning sign – the yellow triangle containing “!”

Replace “signs” with “sign” Accepted.

32

National Committee

Line number

Clause/ Subclause


Type of comment




Ed Improve wording. Delete "in cases" and begin "where" with "W". Delete "any of the".

Accepted.

JP-07_ISO

6.2.1 Table 2 Bottom of middle column

ed What is “__” ? “_” is Katakana character, and “_” is Hiragana character, these are not Kanji character.

“__” shall be changed to Kanji character, for examples, “__”, “___”, etc. . “__” means products, and “___” means explanation /instruction text book.

Already changed in 3CD.

DE 126 6.2.1 table 2 editorial Division of last column into 2 subcolumns is not explained and not understandable.

Explain the division of the last column, e.g. by a respective division of the table head.

Accepted. See observation on GB 78.

GB80 6.2.3 Line 1 Ed Delete unnecessary words. Delete "on more parameters" and insert "and specifications".

Accepted.

DE-39_ISO

6.2.4 te Add criteria. ...make effective use of white space (appr. 25 % of page). The editorial style guide should be followed.

Accepted in principle and reworded (text in brackets deleted) because certain amount of white space cannot be specified generally.


technical To simplify and shorten the text change text, refer to 6.13 and delete bullets.

Change to "The layout shall support the differentiation among the various text functions. Such text functions are listed in 6.1.3."

Not accepted but text reworded.

GB81 6.2.4 Para 2 Ed Will many people responsible for writing instructions understand this?

Noted The answer is yes.

GB82 6.2.4 Para 2

Ed " The bullets simply repeat the list in 6.1.3

After “..intensions” insert “..as listed in 6.1.3” . Delete the rest of the paragraph and the bullets

Not accepted but text reworded.

DE-40_ISO

6.2.5 ed Re-arrange bracket. against a possible disadvantage in contrast and (therefore) legibility,

Accepted in principle and reworded to: The advantages in terms of durability and production of incorporating instructions for use in the material of the product should be weighed against the disadvantages of loss of contrast and legibility.

DE 129 6.2.5 editorial Change reference to 6.8.4 Accepted.

33

National Committee

Line number

Clause/ Subclause


Type of comment



DE 130 6.2.5 editorial For consistency Replace "warning notices" by warning messages"

Accepted.


editorial Grammar Use plural: "possible disadvantages"

Change to "possible disadvantages in contrast (and therefore) in legibility

Accepted in principle and reworded to: The advantages in terms of durability and production of incorporating instructions for use in the material of the product should be weighed against the disadvantages of loss of contrast and legibility.

DE-41_ISO

6.3 ed Replace graphical images by illustrations. [in the whole clause 6]

6.3 Graphical images Illustrations, photographs and supporting text

Accepted.

DE-42_ISO

6.3.1 ed Replace graphical images by illustrations. [in the whole clause 6]

are most informative. Information in illustrations should be

Accepted.


editorial Make 2 sentences to simplify Graphical symbols should be designed for immediate recognition at a distance. Graphical images should be composed to focus attention on important details and should be self-explanatory.

Not accepted.

DE 132 6.3.1 3rd clause Last sentence

editorial Wording: is "comprehensible" right or is "clearly visible" more appropriate?

Not Accepted. “comprehensible” is correct


Ed Clarify meaning and word usage. Delete "be complementary and the information of the illustrations comprehensible." and insert "complement information presented in other forms. Both graphical images and illustrations should be comprehensible."

Accepted and reworded.


Ed Add reference to safety signs. After "In contrast to" insert "safety signs and".

Accepted.


technical Heading doesn't fit with the 3rd clause Reference to 4.7.3.1 doesn't fit either

Shift 3rd clause to the right place, e.g. section 4.6.4 “Durability ...” Reference to 4.6?

Accepted with the following changes: 1st sentence reworded and moved to 6.3.1 2nd sentence moved to 4.6.4.

34

National Committee

Line number

Clause/ Subclause


Type of comment



DE 134 6.6 2nd sentence

technical To specify in accordance to IEC 61355 add in the 2nd sentence after “document kinds”: "for plants, systems and equipment"

Accepted.

AU-01_ISO

6.6 Page 39 te The existing paragraph does not justify or explain the reasons for the requirement of suitably qualified people. This may lead to confusion and safety and operations issues.

Add the following paragraph after the existing paragraph. Wherever qualified persons are required, the text shall state that this is an absolute requirement for safety and / or technical reasons and that no other people shall operate or maintain the machines. The qualifications and skills required of the people concerned, in order to carry out the desired operations and maintenance, are to be clearly stated in the instruction manual or other written documents relevant to the machines concerned.

Accepted in principle intention and additional text is added in 5.4.1.

GB85 6.7.1 Para 5 (Page 40)

Ed It is not clear whether "in accordance with applicable legal regulations" refers to the form of the electronic media that may be used or that electronic-only instructions should only be used if this is legally permissible.

Delete "If, in accordance with applicable legal regulations," and insert "Where". Suggest the legal point is clarified and included as a Note. “Note: Legal regulations may require printed instructions to accompany some products.”

Accepted.

DE 135 6.7.2 2nd bullet

technical The last phrase "and increase the knowledge transfer rate as compared with other medias" because it is unnecessary

delete Accepted.


Ed The phrase "however, shall not be overwhelming for the user." can only be an aspiration and any such assessment could only be subjective. Therefore, 'shall' is not appropriate.

Delete 2nd sentence and insert “However care should be taken that users are not overwhelmed by the duration, information density or complexity of electronic sequences.”

Accepted.

GB87 6.8.1 First bullet. Line 2

Ed Include reference to safety signs. After "(see 6.10)," insert "safety signs and".

Accepted.

DE 136 6.8.3 list technical Add as 6th bullet point; this improves consistency with chapter 5.4

Add: “state the probable consequences of not avoiding the hazard without playing down the consequences “

Accepted MT 21 changed term “warning” to “warning messages.”

DE-43_ISO

6.9.2 ed Keep the wording consistent. 6.9.2 Making graphic imagesillustrations conspicuous Graphic images Illustrations for safety-related issues shall be emphasized...

Accepted.

35

National Committee

Line number

Clause/ Subclause


Type of comment



DE 137 6.9.2 technical Meaning of the 2nd sentence is unclear Replace by: “Therefore, information shall not be presented by the use of colour only; colour is an additional means for the presentation of instructions for use and for the improvement of understanding.”

Accepted.

DE-44_ISO

6.9.3 ed Improve wording of 6th bullet par. • provide clear guidance on what how to avoid the hazard;

Already covered in 3CD. See 6.8.3.

DE-45_ISO

6.9.3 ed Correct grammar of 7th bullet par. ...illustrations and provided the user with a...

Not relevant. In 3CD, The text is changed as in 6.8.3.

DK 23 6.9.3 1. para T Important requirement Change “should” to “shall” Accepted. GB88 6.9.3 Line 1 Ed Line 1: delete "consideration" and insert

"care". After "select" insert "contrasting". Line 2: delete "also" and insert "even".

Accepted.

DE-46_ISO

6.9.6 te Add condition, because the use of hierarchical signal words is not mandatory.

When alerting users by using signal words in a hierarchical manner, ...

Accepted in principle The text is reworded as in 6.8.6.

DE-47_ISO

7 ed In the whole clause 7, replace consumer/s by user/s.

user, users Accepted.

DE-49_ISO

7.1 ed Delete first be. ...judgements. This check list may be also be used as a guide to...

In 3CD,,the text is already changed.

DE 138 7.1 2nd clause

technical Replace "(some or all) consumers by "the target group(s)" because it is more specific and some information in Annex B is not intended for consumers

Replace "(some or all) consumers by "the target group(s)"

Not accepted. See the observation on DE-47_ISO.

DE-48_ISO

7.1 3rd par. ed Replace qualitively by qualitatively Replace is by it.

...could neither be achieved nor be measured qualitatively, and so in practice assessment is it must...

In 3CD, the text is already changed.

DE-50_ISO

7.1 4th par. ed Delete sentence. Importance cannot be a criterion, because instructions for use contain only necessary information -- no more and no less.

For a particular product, certain requirements may be designated important or very important.

Accepted.

GB89 7.1 Para 3 Ed Delete unnecessary word. Delete "communication". Accepted. GB90 7.1 Para 3

Lines 2/3 Ed Whilst the effectiveness of instructions

for use in communicating information can be measured it does not follow that even the best will always influence the behaviour of users. There are many examples of comprehensible instructions and safety signs and symbols being ignored.

Delete "and influencing their behaviour". insert “and predicting their effectiveness in influencing user behaviour.”

Accepted.

36

National Committee

Line number

Clause/ Subclause


Type of comment



GB91 7.1 Para 3 Lin 6

Ed Space. Close up space between "effective" and the comma.

Accepted.

DE 139 7.2 3nd bullet

technical What is meant by "sample" ? Accepted and explained: sample replaced by product sample.

DE-51_ISO

7.2 Note ed Improve wording. and/or there may need to be internal evaluations and revisions ...and/or there may be need for internal evaluations and revisions...

Accepted.

DK 24 A.3 3. para E Annex B is informative Change ... shall be carried out using ... to ... shall be carried out preferable using …

MT 21 discussed the proposed change and concluded that the text will be changed to “should be carried out using…”

DK 25 A.3 4. para T Annex C is also informative but Change ... should be carried out using ... to ... shall be carried out preferable using …

Not accepted because of consistency between 3rd and 4th paragraphs in A3. No change.

DE 141 Annex A A.2 2nd bullet

technical Replace "product" by "instructions for use"

Accepted.

GB92 Annex A A.3 Para 2 Line 2

Ed Correct word. Delete "instruction" and insert "instructional".

Accepted.

GB93 Annex A A.3 Paras 3 and 4

Ed Missing initial capital letters. Begin both "annex B" and "annex C" with "A".

Accepted.

DE 142 Annex B 2.8 editorial Delete "for example" Accepted. DE-52_ISO

Annex B Footnote te Add footnote to table heading. 1) In order to assess instructions for use, this check list may be downloaded and distributed free of charge at http://www.[din, dke, iec, iso/...].htm

Not accepted. MT21 appreciates the proposal but for practical problems to organize.

GB94 Annex B Heading item 4

Ed Orphaned from text it applies to Move to top of next page Accepted.

DE 143 Annex B3.7

3.7 technical Replace the term "qualified people" by "skilled persons"

Accepted.

DE-53_ISO

B.3.7 ed Replace qualified people by skilled persons (consistency).

skilled persons Accepted.

DE 144 Annex B6.3

6.3 technical Replace the term "qualified people" by "skilled persons"

Accepted.

37

National Committee

Line number

Clause/ Subclause


Type of comment



DE 145 Annex B7.

7. technical In the 62079:2001 the following information is listed additionally: "7.1 General safety regulations summarized at the beginning of the instruction material 7.2 Recognized technical regulations have been observed 7.3 Clear guidance on what to do and what to avoid is provided"

Discuss in MT21 and introduce respective statements in 2nd edition.

Not accepted: Information is already covered in Annex B.

DE-54_ISO

B.7.4 ed Replace useful life by life cycle. life cycle Not accepted. Text is corrected as written in draft CDV (attached)

DE-55_ISO

Annex C te Check list for communication effectiveness should have the same normative status as check list for compliance and comments. Both check lists are equally necessary for the assessment of instructions for use. (cf. A.3)

Normative Not accepted. See the observation on DE-01_ISO.

DE-58_ISO

Annex C 02 te Line length and line space are missing. Add "line length and line space". Accepted.

DE-59_ISO

Annex C 02 te White space is missing. Add "white space used". Not accepted because certain amount of white space cannot be specified generally.

DE-60_ISO

Annex C 04 te Replace consumer (consistency). Each language version checked by a native speaking user and/or expert for comprehensibility and absence of linguistic errors

Accepted in principle and reworded as: Each language version checked by a native speaker for comprehensibility and absence of linguistic errors

DE 146 Annex C 4. technical Replace "consumer" by "expert" or "translator" or "person of the target group"

Accepted in principle and reworded. See the observations on DE 60_ISO.

GB96 Annec C Heading item 5

Orphaned from text it applies to Move to top of next page Accepted.

DE-61_ISO

Annex C 06 ed Replace any by and. for any new symbols and non-registered symbols

Not accepted Reworded see GB 98.

DE-56_ISO

Annex C Footnote te Add footnote to table heading. 1) In order to assess instructions for use, this check list may be downloaded and distributed free of charge at http://www.[din, dke, iec, iso/...].htm

Not accepted. MT21 appreciates the proposal but for practical problems to organize not accepted.

38

National Committee

Line number

Clause/ Subclause


Type of comment



DE-57_ISO

Annex C new 01 te Add new no. 1. Before we know the target group (kind of users), we cannot assess the comprehensibility of a document. Renumber the following Nos.

01 Target group/s

• Target group/s specified

• Instructions for use adequately presented for target group/s

• Conventions: How to read this document

Accepted.

GB95 Annex C Para 1 Line 4

Ed Unnecessary word. Delete "with". Accepted..

GB97 Annex C Table Item 6 First bullet

Ed Use correct term. Delete "recognizable" and insert "comprehensible"

Accepted.

GB98 Annex C Table Item 6 Third bullet

Ed Delete unnecessary text. At end of line delete "any non-registered symbols".

Accepted.

GB99 Annex D D.1 Line 1

Ed Improve wording. Delete "Annex gives" and insert "This Annex provides".

Accepted.

GB100 Annex D D.2 Lines 1 and 2

Ed Improve wording. Delete brackets around "(instructions for use)". Delete "impose major restrictions on" and insert "can affect". Delete "received by" and insert "provided for".

Accepted.

GB105 Annex D D.2 Para 2 First bullet

Ed Correct wording. Delete "documentation" and insert "document".

Accepted.

GB106 Annex D D.2 Para 2 Sixth bullet Line 1

Ed Word spacing is out of keeping with rest of document. Unnecessary word at end of line.

Correct word spacing and delete "to" at end of line.

Accepted to delete "to" but word spacing is correct.

GB107 Annex D D.2 Para 2 Seventh bullet

Ed Rogue capital letter. Begin "Compliance" with "c". Accepted.

39

National Committee

Line number

Clause/ Subclause


Type of comment



GB101 Annex D D.2 a) Line 1

Ed Word spacing is out of keeping with rest of document.

Correct word spacing. Not accepted (word spacing is correct).

GB102 Annex D D.2 a) Third bullet Line 2

Ed Unwanted bracket. Delete second bracket after "see section 5)"

Accepted.


Ed If information is to be presented on the product then space for this should be allowed for at the design stage.

Delete "can" and insert "should". Accepted.

GB104 Annex D D.2 a) Third Bullet Line 2

Ed Unnecessary plural and incorrect punctuation.

Make "products" singular. Delete full stop at end and insert semi-colon.

Accepted.

GB108 Annex D D.3 Lines 1 and 2

Ed Word spacing is out of keeping with rest of document. Unnecessary word at end of line. Note: rogue word spacing appears in some other places so whole document requires checking.

Correct word spacing. Not accepted (word spacing is already correct).

GB109 Annex D D.3 Line 1

Ed Improve wording. At end of line delete "each individual" and insert "all possible" and make "requirement" [line 2] plural.

Accepted.

GB110 Annex D D.3 a) First bullet Lines 4 and 5

Ed Phrase "means of implementing instructions for use within the product" does not make sense.

Delete ", means of implementing instructions for use within the product" and place full stop after "cycle".

Accepted.


Ed Improve wording. Delete "are known by" and insert "will be known to".

Accepted.

GB112 Annex D D.3 d) Para 2 Line 4

Ed Missing plural. Make "device" [after safety] plural. Accepted.

GB113 Annex D

D.3 d) Para 3 Line 1

Ed Improve wording. Delete "defects" and insert "shortcomings".

Accepted.

40

National Committee

Line number

Clause/ Subclause


Type of comment



GB114 Annex D D.3 e) Para 1 Line 2

Ed Incomplete phrase. At end of line add "for use". Accepted.

GB115 Annex D D.3 j) Line 1

Ed Correct English. Delete "utilizable" and insert "usable". Accepted.

DE-62_ISO

Annex D i) te Supply an example for required standard.

Appropriate standards for translation services should be taken into account (e.g. EN 15038).

Accepted.

AU-02_ISO

Annex D Section d)

Page 54 te The existing text does not cover the situation where only qualified and experienced persons should use or assemble or disassemble the product. This would be a requirement for safety and operational reasons.

After the last paragraph insert the following paragraph. Wherever qualified persons are required, the text shall state that this is an absolute requirement for safety and / or technical reasons and that no other people shall assemble, operate, maintain or disassemble the machines or item. The qualifications and skills required of the people concerned, are to be clearly stated in the instruction manual or other written documents relevant.

Accepted in principle and reworded as: Wherever skilled persons are required, the text shall state that this is an absolute requirement for safety and/or technical reasons and that no other people shall assemble, operate, maintain or disassemble the machines or item. The qualifications and skills required of the people concerned, are to be clearly stated in the instructions for use.

DE 147 Annex D

D.2 D.2 1st sentence

technical Replace "users" by "producers" Not accepted but reworded.

DE 148 Annex DD.3

D.3 12. bullet

technical Add "for use" after instructions Accepted.

DE 149 Annex DD.3

D.3 8. bullet


DE 150 Annex DD.3

D.3 e) 1st sentence


DE 151 Annex DD.3

D.3 f) 3rd clause

technical Add "for use" after instructions Accepted and reworded.

DE 152 Annex DD.3

D.3 h)


DE 153 Annex DD.3

D.3 j)


41

National Committee

Line number

Clause/ Subclause


Type of comment



DE 154 Annex EE.2.1

E.2.1 technical Add "for use" after instructions in the 3rd and 4th column,in the row "scope/objectives"

Accepted.

DE 155 Annex EE.2.2

E.2.2 technical Replace "representation" by ""representativeness"

Accepted.

DE 157

Annex EE.2.3

E.2.3 Cons

editorial Change order of words "assessment development" to development of assessment

Accepted.

DE 156 Annex EE.2.3

E.2.3 pros


DE 158 Annex EE.2.5

E.2.5 Pros

editorial Add "those of" after "with" Accepted.

DE-63_ISO

Annex F (new)

te Add Annex F as attached to this document.

Annex F... ((see attached proposal)) Not accepted. MT 21 appreciates effort and result The idea is helpful for another part or revision of the standard. But at this stage of the standard it is too late to introduce new and extensive material.

DE 140 8 Annex G

technical Add new Annexe G – Competencies required for technical communication experts

Not accepted. There is not yet common basis for education of technical writers at least in Europe and Japan. The approach is not rejected generally but it is seen as too early to put it in an International standard.

DE 159 Annex G technical Add a new Annex G (informative), see proposal below

Not accepted. See the observation on DE 140.

42

Annex F (informative)

Example of a table of contents of instructions for use

F.1 General This annex gives guidance on the selection and sequential arrangement of information in technical instructions in a user manual. This user manual may include all instructions for handling a product from its delivery to its disposal.

F.2 Restrictions to be observed An example cannot give comprehensive information covering each individual requirement. Therefore each heading listed here has to be checked against the appropriate requirement depending on complexity, risk, legal issues, etc. Nevertheless, this example might fulfil user needs for guidance on a standard layout for manuals.

F.3 Table of contents (example) 1 Identification

1.1 Product brand and type designation 1.2 Product version/release N° (software)/edition of document 1.3 Producer, supplier, distributor name and address 1.4 Declaration of conformance to product standards 1.5 Manual guide: definitions, description of symbols, print conventions

2 Specification of the product 2.1 General functions and range of applications, intended use 2.2 List of control units 2.3 Dimensions and weight (for transport purposes) 2.4 Supply data for power, gas, water and other consumables 2.5 Energy consumption, conditions 2.6 Emission of noise, waste, etc. conditions 2.7 Type of protection, IP code (for example, protected against waterdripping vertically) 2.8 Environmental conditions and limits for operation and storage

3 Basic safety information, summary (personal protection, unintended use) 4 Preparing the product for use

4.1 Transport and storage 4.2 Safety precautions before use 4.3 Unpacking, checking scope of delivery

43

4.4 Disposal of packaging material 4.5 Preparatory work before installation 4.6 Installing and assembling, work places 4.7 Storing and protecting when out of use 4.8 Repackaging for transport 4.9 Information assignment (users, operators, service experts) 4.10 Location of instructions

5 Operating instructions 5.1 Safe operating/functioning 5.2 Normal intended function (manual, automated operation) 5.3 Secondary functions (for example, material handling) 5.4 Exceptional functions/situations 5.5 Signals to be observed 5.6 Personal protection 5.7 Optional modules, extras 5.8 Quick reference instructions 5.9 Disposal of waste materials 5.10 Measures in the case of emergency

6 Maintenance 6.1 Safety precautions 6.2 Maintenance and cleaning by users 6.3 Maintenance and cleaning by qualified people 6.4 Trouble-shooting, fault diagnosis, and repair

7 Optional modules and extras, specifications 8 Service and repair by service agent

8.1 Service cycles for safe operating 8.2 Addresses of service agents 8.3 Repackaging for further transport

9 List of spare parts and consumables 10 Taking product out of operation, dismantling, disposal If applicable: Instructions for use, delivered by suppliers of components EC declaration of conformity Glossary Index

44

Annexe G (informative) Competencies required for the preparation of instructions for use G.1 Core competencies

• Communication principles Social, psychological and linguistic aspects of communication; communication models; oral and written communication; how information is perceived and processed

• Understanding and using tools Knowledge of relevant and available tools. Hardware components and their interfaces; operating systems; basic principles of systematic use of software; overview on common software in technical documentation: word processing, image processing, publishing tools, data management tools

• The regulatory framework for Technical Communication Knowledge of laws, directives, national and international standards; where to get information about these

• Project and process management How to write specifications; needs analyses, goals definitions, project planning, project monitoring and evaluation, controlling, steering processes, budget planning, basic principles of business administration

• Information gathering How to obtain information; interview techniques; use of the internet and databases; questionnaires; research methodology and techniques

• Documentation planning and information development Draft a documentation plan; define scope and objective; define target groups; define information to be transmitted and adequate means to transmit the information; define tools to be used; define standards

• Usability Target group analyses; needs analyses; usability test designing; data collection and analysis – both quantitative and qualitative; document testing methods

• Structuring information Use structuring methods and techniques (e.g. "mind mapping", "card sorting"); apply structuring principles in accordance to information types and target groups

• Standardisation techniques Overview of different techniques such as information mapping, instructional design, style guides; application of standardised structures using software (e.g. templates, XML-schema, SGML-DTDs)

• Professional writing How to describe complex technical matters in a simple and concise way; text analyses, text types, writing processes, writing techniques, stylistics; use of consistent terminology

• Editing

Substantive editing, style editing, copy editing and proof-reading of printed text and online text • Visual communication

Basic principles of visual analysis; graphic design; visualisation of technical and abstract contents; basic principles of digital image processing; integration in DTP; understanding of the principles of combining text and visual elements

• Layout and typography Typographical elements, concepts and styles; visual structure for different output media (print or screen); relation text-image; basic knowledge of DTP; use and creation of templates

45

G.2 Specialist competencies

• Quality management Basic principles of process-oriented quality management systems; how to define quality criteria for technical documentation in conformity with national and international quality standards; how to organise a feedback control loop; quality assurance; usability testing

• Production and publishing of technical documentation Different output media; production processes and techniques (typesetting, print, processing, finishing); production budget planning

• Localisation and internationalisation Basic principles of intercultural communication; understanding of the requirements of the translation and localization process; understanding the basic principles of translation memory use; management of localisation projects

• Terminology Basic principles of terminology theory; mono-, bi- and multi-lingual terminology; understanding of existing terminology resources; controlled language, create and administrate terminology data bases; terminology management tools; create glossaries

• Indexing and abstracting Write effective index entries; evaluate and edit an index; embed index markers in documents; design of controlled vocabularies for indexing and searching; computer-assisted techniques; how to write an abstract; application to multimedia and hypermedia

• Databases The use of data bases in technical documentation; basic principles of data modelling; structured query language (SQL)

• XML and Single Source Publishing XML/SGML user skills; how to create a DTD; which software can be used to process data in conformity with SGML; publishing SGML-data; XML-based web applications

• Online help Basic principles (topics, levels of help, data bases, structuring principles, display issues); create and integrate topics; create and administrate help systems

• Designing digital media Overview of different media (sound, video, interactions); digital formats; media processing software; design, process and integrate multimedia elements

82079-1 Ed.1 © IEC:2009 – 1 – 82079-1 Ed.1 © CEI:2009

CONTENTS

Page

1 Scope ............................................................................................................................ 7 2 Normative references ..................................................................................................... 7 3 Terms and definitions ..................................................................................................... 8 4 Principles ..................................................................................................................... 13

4.1 Provision of instructions for use ........................................................................... 13 4.1.1 General ................................................................................................... 13 4.1.2 Instructions for use are part of the product ................................................ 13 4.1.3 Consistency of information ....................................................................... 14 4.1.4 Product warranty ...................................................................................... 14 4.1.5 Information provided after sale of products ............................................... 14 4.1.6 Security aspects ...................................................................................... 14

4.2 Quality of communication ..................................................................................... 14 4.3 Minimizing risks ................................................................................................... 14 4.4 Target group(s) ................................................................................................... 15 4.5 Special precautions ............................................................................................. 15 4.6 Short-life products ............................................................................................... 15 4.7 Considerations as to the nature of instructions for use .......................................... 15

4.7.1 General ................................................................................................... 15 4.7.2 Location ................................................................................................... 16 4.7.3 Means of communication and media ......................................................... 16 4.7.4 Durability ................................................................................................. 16 4.7.5 Availability ............................................................................................... 17 4.7.6 Electronic guidance systems .................................................................... 17 4.7.7 User training ............................................................................................ 17

4.8 Creating instructions for use ................................................................................ 17 4.8.1 Conformity with the product ...................................................................... 17 4.8.2 Consideration of needs of target groups ................................................... 19 4.8.3 Languages ............................................................................................... 19

5 Content of instructions for use ...................................................................................... 21 5.1 General ............................................................................................................... 21 5.2 Identification and specification of the product ....................................................... 21 5.3 Modification of products ....................................................................................... 21 5.4 Safety-related information .................................................................................... 22

5.4.1 General ................................................................................................... 22 5.4.2 Safety notes ............................................................................................ 23 5.4.3 Warning messages ................................................................................... 23 5.4.4 Safety-related information for industrial plants .......................................... 23

5.5 Product compliance ............................................................................................. 23 5.6 Importance of retaining instructions for use .......................................................... 23 5.7 Preparing products for use ................................................................................... 24

5.7.1 Transportation and storage ...................................................................... 24 5.7.2 Installation ............................................................................................... 24 5.7.3 Commissioning ........................................................................................ 24

82079-1 Ed.1 © IEC:2009 – 2 – 82079-1 Ed.1 © CEI:2009

5.8 Operation of products .......................................................................................... 24 5.8.1 General ................................................................................................... 24 5.8.2 Normal operation ..................................................................................... 24 5.8.3 Additional information for automatic and remotely controlled products ....... 25 5.8.4 Indications of faults and warning device signals ........................................ 25 5.8.5 Exceptional/emergency situations ............................................................. 25 5.8.6 Troubleshooting and repair for non-skilled persons ................................... 26 5.8.7 Troubleshooting and repair for skilled persons .......................................... 26

5.9 Maintenance ........................................................................................................ 26 5.9.1 General ................................................................................................... 26 5.9.2 Product maintenance by non-skilled persons ............................................ 26 5.9.3 Product maintenance by skilled persons ................................................... 27 5.9.4 Planned maintenance of industrial plants .................................................. 27

5.10 Supplied accessories, consumables and spare parts ............................................ 27 5.10.1 Accessories ............................................................................................. 27 5.10.2 Consumables ........................................................................................... 27 5.10.3 Spare/replacement parts .......................................................................... 28

5.11 Information on special tools, equipment and materials .......................................... 28 5.12 Information on repair of products and replacement of parts ................................... 28

5.12.1 Information on repair of products and replacement of parts for non-skilled persons ......................................................................................... 28

5.12.2 Information on repair of products and replacement of parts for skilled persons ................................................................................................... 29

5.13 Information required when the product is no longer needed .................................. 29 5.13.1 General ................................................................................................... 29 5.13.2 Disassembly ............................................................................................ 29 5.13.3 Recycling ................................................................................................. 29 5.13.4 Disposal .................................................................................................. 29

5.14 Structure ............................................................................................................. 29 5.14.1 General ................................................................................................... 29 5.14.2 Page numbering ....................................................................................... 30 5.14.3 Table of contents ..................................................................................... 30 5.14.4 Index ....................................................................................................... 30 5.14.5 Technical terms, acronyms and abbreviations ........................................... 30 5.14.6 Graphical and tactile symbols and tactile dots ........................................... 30 5.14.7 Presentational conventions ...................................................................... 30 5.14.8 User controls and indicators ..................................................................... 30

6 Presentation of instructions for use ............................................................................... 30 6.1 Comprehensibility ................................................................................................ 30

6.1.1 Recognized communication principles ...................................................... 30 6.1.2 Style guide............................................................................................... 31 6.1.3 Structure .................................................................................................. 31 6.1.4 Consistent terminology ............................................................................. 32 6.1.5 Simple and brief ....................................................................................... 32 6.1.6 One sentence, one command ................................................................... 32 6.1.7 Rules for simple wording .......................................................................... 32 6.1.8 Standardized signs and graphical symbols................................................ 33 6.1.9 Ergonomic principles ................................................................................ 33

82079-1 Ed.1 © IEC:2009 – 3 – 82079-1 Ed.1 © CEI:2009

6.1.10 Keeping the attention of the readers ......................................................... 33 6.1.11 Proof reading ........................................................................................... 33

6.2 Legibility .............................................................................................................. 33 6.2.1 Text font sizes and graphical symbol heights ............................................ 33 6.2.2 Maximum brightness contrast ................................................................... 36 6.2.3 Legibility standards .................................................................................. 36 6.2.4 Layout ..................................................................................................... 36 6.2.5 Instructions for use on surfaces of products or packaging ......................... 36

6.3 Illustrations and supporting text ........................................................................... 36 6.3.1 Quality ..................................................................................................... 36 6.3.2 Following a sequence of operations .......................................................... 37 6.3.3 Illustration with captions ........................................................................... 37 6.3.4 One illustration, one item of information .................................................... 37

6.4 Graphical symbols, including safety signs ............................................................ 37 6.4.1 Graphical symbols for use on equipment, including safety signs ................ 37 6.4.2 Explanation of graphical symbols ............................................................. 37 6.4.3 Graphical symbols for diagrams ............................................................... 37 6.4.4 Minimum sizes of graphical symbols ......................................................... 37

6.5 Use of tables ....................................................................................................... 37 6.6 Use of appropriate document types ...................................................................... 38 6.7 Use of electronic media ....................................................................................... 38

6.7.1 General ................................................................................................... 38 6.7.2 Didactic Requirements ............................................................................. 39 6.7.3 Requirements for downloadable instructions for use.................................. 39 6.7.4 Requirements for user interaction ............................................................. 40

6.8 Making safety-related information prominent and conspicuous .............................. 40 6.8.1 Making text conspicuous .......................................................................... 40 6.8.2 Making illustrations conspicuous .............................................................. 40 6.8.3 Design of warning messages .................................................................... 40 6.8.4 Permanence and visibility ......................................................................... 41 6.8.5 Making warning messages prominent ....................................................... 41 6.8.6 Signal words ............................................................................................ 41

6.9 Colours ............................................................................................................... 41 6.9.1 Consistency ............................................................................................. 41 6.9.2 Colour perception considerations ............................................................. 41 6.9.3 Photocopying/printing considerations ........................................................ 41

7 Evaluation of conformance to this part of the International Standard .............................. 42 7.1 Claiming conformance to this part of the International Standard ............................ 42 7.2 Documentary evidence of evaluation .................................................................... 42

Annex A (Normative) Evaluation of instructions for use ....................................................... 44 A.1 General ............................................................................................................... 44 A.2 Choice of methodologies for evaluation ................................................................ 44

A.2.1 Desk research by experts ......................................................................... 44 A.2.2 Empirical evaluation by potential users ..................................................... 44

Annex B (Informative) Checklist for conformity and comments ............................................ 45 Annex C (Informative) Checklist for communication effectiveness ....................................... 48 Annex D (Informative) Planning the preparation of instructions for use ................................ 51

82079-1 Ed.1 © IEC:2009 – 4 – 82079-1 Ed.1 © CEI:2009

D.1 General ............................................................................................................... 51 D.2 Restrictions on planning the preparation .............................................................. 51 D.3 Planning preparation in detail (example) .............................................................. 52

Annex E (Informative) Empirical methods supporting the preparation of instructions for use............................................................................................................................... 56 E.1 General ............................................................................................................... 56 E.2 Methods .............................................................................................................. 56

E.2.1 Opinion polls ............................................................................................ 56 E.2.2 Usability-Testing ...................................................................................... 57 E.2.3 Self Assessments and Checklists ............................................................. 57 E.2.4 Expertise, Expert reviews and Certification ............................................... 57 E.2.5 Findings from independent award or merit schemes .................................. 58 E.2.6 Feedback from Complaints Management, Hotlines and Service

information............................................................................................... 58 Bibliography ....................................................................................................................... 59

82079-1 Ed.1 © IEC:2009 – 5 – 82079-1 Ed.1 © CEI:2009

INTERNATIONAL ELECTROTECHNICAL COMMISSION

____________

PREPARATION OF INSTRUCTIONS FOR USE

– STRUCTURING, CONTENT AND PRESENTATION:

Part 1: General principles and detailed requirements

FOREWORD

1) The International Electrotechnical Commission (IEC) is a worldwide organization for standardization comprising all national electrotechnical committees (IEC National Committees). The object of IEC is to promote international co-operation on all questions concerning standardization in the electrical and electronic fields. To this end and in addition to other activities, IEC publishes International Standards, Technical Specifications, Technical Reports, Publicly Available Specifications (PAS) and Guides (hereafter referred to as “IEC Publication(s)”). Their preparation is entrusted to technical committees; any IEC National Committee interested in the subject dealt with may participate in this preparatory work. International, governmental and non-governmental organizations liaising with the IEC also participate in this preparation. IEC collaborates closely with the International Organization for Standardization (ISO) in accordance with conditions determined by agreement between the two organizations.

2) The formal decisions or agreements of IEC on technical matters express, as nearly as possible, an international consensus of opinion on the relevant subjects since each technical committee has representation from all interested IEC National Committees.

3) IEC Publications have the form of recommendations for international use and are accepted by IEC National Committees in that sense. While all reasonable efforts are made to ensure that the technical content of IEC Publications is accurate, IEC cannot be held responsible for the way in which they are used or for any misinterpretation by any end user.

4) In order to promote international uniformity, IEC National Committees undertake to apply IEC Publications transparently to the maximum extent possible in their national and regional publications. Any divergence between any IEC Publication and the corresponding national or regional publication shall be clearly indicated in the latter.

5) IEC itself does not provide any attestation of conformity. Independent certification bodies provide conformity assessment services and, in some areas, access to IEC marks of conformity. IEC is not responsible for any services carried out by independent certification bodies.

6) All users should ensure that they have the latest edition of this publication.

7) No liability shall attach to IEC or its directors, employees, servants or agents including individual experts and members of its technical committees and IEC National Committees for any personal injury, property damage or other damage of any nature whatsoever, whether direct or indirect, or for costs (including legal fees) and expenses arising out of the publication, use of, or reliance upon, this IEC Publication or any other IEC Publications.

8) Attention is drawn to the Normative references cited in this publication. Use of the referenced publications is indispensable for the correct application of this publication.

9) Attention is drawn to the possibility that some of the elements of this IEC Publication may be the subject of patent rights. IEC shall not be held responsible for identifying any or all such patent rights.

International Standard IEC 82079-1 has been prepared by IEC technical committee 3: Information structures, documentation and graphical symbols in liaison with ISO technical committee 10: “Technical product documentation, and ISO Committee on consumer policy (COPOLCO).”

This part of the International Standard replaces IEC 62079 (2001).

The text of this part of the International Standard is based on the following documents:

FDIS Report on voting

XX/XX/FDIS XX/XX/RVD

82079-1 Ed.1 © IEC:2009 – 6 – 82079-1 Ed.1 © CEI:2009

—————————

Full information on the voting for the approval of this part of the International Standard can be found in the report on voting indicated in the above table.

Annex A is normative, and Annexes B, C, D and E are for information only. The Annexes are addressed primarily to experts engaged in the evaluation of instructions for use but will also be helpful to writers of instructions for use who may wish to use the checklists while preparing successive drafts.

This publication has been drafted in accordance with the ISO/IEC Directives, Part 2.

The committee has decided that the contents of this publication will remain unchanged until the maintenance result date1) indicated on the IEC web site under "http://webstore.iec.ch" in the data related to the specific publication. At this date, the publication will be

• reconfirmed, • withdrawn, • replaced by a revised edition, or • amended.

1) The National Committees are requested to note that for this publication the maintenance result date is ....

82079-1 Ed.1 © IEC:2009 – 7 – 82079-1 Ed.1 © CEI:2009

PREPARATION OF INSTRUCTIONS FOR USE –

STRUCTURING, CONTENT AND PRESENTATION:

Part 1: General principles and detailed requirements

1 Scope

This part of the International Standard provides general principles and detailed requirements for the design and formulation of all types of instructions for use that will be necessary or helpful for users of products of all kinds ranging from a tin of paint to large or highly complex products, such as large industrial machinery, turnkey based plants or buildings.

NOTE The term "product" as defined in 3.29 relates to consumer, non-consumer, electrical, electronic, electromechanical, mechanical and other products.

This part of the International Standard is intended for all parties involved in the preparation of instructions for use, for example:

• suppliers technical writers, technical illustrators, software designers, translators or other people engaged in the work of conceiving and drafting such instructions for use;

This part of the International Standard does not specify a fixed amount of documentation that has to be delivered with a product. This is obviously not possible because this part of the International Standard is applicable to all kinds of products. The amount of documentation required, will depend on the nature of the product, its complexity and the skills of the users.

2 Normative references

The following referenced documents are indispensable for the application of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.

IEC 60073:2002, Basic and safety principles for man-machine interface, marking and identification – Coding principles for indication devices and actuators

IEC 60204-1, Safety of machinery – Electrical equipment of machines – Part 1: General requirements

IEC 60417, Graphical symbols for use on equipment IEC 60529, Degrees of protection provided by enclosures IEC 60617, Graphical symbols for diagrams IEC 60848, GRAFCET specification language for sequential function charts IEC 61082-1:2006, Preparation of documents used in electrotechnology – Part 1: Rules IEC 81346-1, Industrial systems, installations and equipment and industrial products –

Structuring principles and reference designations – Part 1: Basic rules IEC 61310-1, Safety of machinery – Indication, marking and actuation – Part 1: Requirements

for visual, acoustic and tactile signals IEC 61355-1:2008, Classification and designation of documents for plants, systems and

equipment – Part 1: Rules and classification tables IEC/FDIS 62507-1, Requirements for identification systems enabling unambiguous information

interchange – Part 1: Principles and methods

82079-1 Ed.1 © IEC:2009 – 8 – 82079-1 Ed.1 © CEI:2009

IEC/PAS 62569-1:2009, Generic specification of information on products – Part 1: Principles and methods

IEC 80416-1, Basic principles for graphical symbols for use on equipment – Part 1: Creation of symbol originals for registration

ISO/IEC 80000 (all parts), Quality and units ISO 3864 (all parts), Graphical symbol – Safety colours and safety signs ISO 7000, Graphical symbols for use on equipment – Index and synopsis ISO 7010, Graphical symbols – Safety colours and safety signs – Registered safety signs ISO 7731:2003, Ergonomics – Danger signals for public and work areas – Auditory danger

signals ISO 9000:2005, Quality management systems – Fundamentals and vocabulary ISO 9186 (all parts), Graphical symbols – Test methods ISO 9241 (all parts), Ergonomics of human-system interaction ISO 10628, Flow diagrams for process plants – General rules ISO 11429:1996, Ergonomics – System of auditory and visual danger and information signals ISO 11683, Packaging – Tactile warnings of danger – Requirements ISO 12100 (all parts), Safety of machinery – Basic concepts, general principles for design ISO 14617 (all parts), Graphical symbols for diagrams ISO 15006:2004, Road vehicles – Ergonomic aspects of transport information and control

systems – Specifications and compliance procedures for in-vehicle auditory presentation ISO/TR 16352:2005, Road vehicles – Ergonomic aspects of in-vehicle presentation for

transport information and control systems – Warning systems ISO/IEC Guide 14:2003, Purchase information on goods and services intended for consumers ISO/IEC Guide 37, Instructions for use of products by consumers ISO/IEC Guide 51:1999, Safety aspects – Guidelines for their inclusion in standards ISO/IEC Guide 71:2001, Guidelines for standards developers to address the needs of older

persons and persons with disabilities ISO/IEC Guide 73:2002, Risk management – Vocabulary – Guidelines for use in standards ISO/IEC Guide 74:2004, Graphical symbols – Technical guidelines for the consideration of

consumers' needs ISO/IEC Guide 81:---, Guidelines for the inclusion of security aspects in standards

3 Terms and definitions

For the purpose of this International Standard, the following definitions apply.

3.1 accessible design product product which is designed to maximize the number of potential users

3.2 Braille writing system using a series of two dimensional patterns of raised dots to be read with the fingers

82079-1 Ed.1 © IEC:2009 – 9 – 82079-1 Ed.1 © CEI:2009

3.3 commissioning procedures prior, or related, to the handing over of a product ready for putting into service, including final acceptance testing, the handing over of all documentation relevant to the use of the product and, if necessary, instructing personnel

3.4 component product used as a constituent in an assembled product, system or plant

[3.7 of IEC 81346-1] 3.5 conformity fulfillment of specified requirements

NOTE The term “conformance” is synonymous but deprecated.

3.6 consequence outcome of an occurrence of a particular set of circumstances

NOTE 1 There can be more than one consequence from one event.

NOTE 2 Consequences can range from positive to negative. However, consequences are always negative for safety aspects.

NOTE 3 Consequences can be expressed qualitatively or quantitatively.

[3.1.2 of ISO/IEC Guide 73]

3.7 consumable any part or material that is necessary for continued use or maintenance of the product

3.8 consumer individual member of the general public, purchasing or using products, property or services, for private purposes

NOTE For the purpose of the requirements of this part of the International Standard, a “consumer” is assumed not to be a skilled person.

3.9 consumer product product available to, intended for or likely to be used by consumers

NOTE Consumer products include accessible design products.

3.10 customer individual or organization that purchases or receives a product

NOTE 1 Examples are consumer, client, end-user, retailer, beneficiary and purchaser.

NOTE 2 The term "customer" includes but has a broader meaning than “consumer”.

[3.3.5 of ISO 9000, modified]

82079-1 Ed.1 © IEC:2009 – 10 – 82079-1 Ed.1 © CEI:2009

3.11 display device provided as part of a product for the purpose of visually or tangibly presenting text or graphics

3.12 document fixed and structured amount of information intended for human perception that can be managed and interchanged as a unit between users and systems

[3.1.2 of IEC 61082-1]

3.13 documentation collection of documents related to a given subject

[3.1.4 of IEC 61082-1]

3.14 equipment associated assemblies intended to achieve a defined final objective

3.15 graphical symbol visual perceptible figure with a particular meaning used to transmit information independently of language

[3.1 of IEC 80416-1]

3.16 harm physical injury or damage to the health of people or damage to property or the environment

[3.3 of ISO/IEC Guide 51]

3.17 hazard potential source of harm


3.18 illustration visually perceptible figure, such as graphical image, picture, figure, photograph, line drawing, etc., artificially created to transmit specific information, excluding graphical symbols

3.19 instructions for use information provided by the supplier of a product to the user, containing all the necessary provisions to convey the actions to be performed for the safe and efficient use of the product

NOTE Instructions for use of a single product comprise one or more documents.


82079-1 Ed.1 © IEC:2009 – 11 – 82079-1 Ed.1 © CEI:2009

3.20 intended use exhaustive range of functions or foreseen applications defined and designed by the supplier for the product

Note 1 Functions or applications not listed by the supplier are excluded from the intended use of the product.

Note 2 Modification of the product which is possible to be done by a skilled person leading to additional or modified functions or applications are excluded of the intended use.

3.21 label item, attached to a product, which displays information related to one or more characteristic(s) of the product


3.22 maintenance actions intended to retain a product in or restore it to, a useful and safe condition in which it can perform the intended use

3.23 manual document containing information for the use of a product

NOTE IEC 61355-D00014 defines the document type “XXX Manual”.

3.24 marking logo, inscription, graphical symbol, pictogram, tactile indicator, warning sign on the product to identify its type or to give directive

NOTE Marking may also include short textual messages.

[2.4 of ISO/IEC Guide 14, modified]

3.25 modification changes made to a product in order to alter its specified intended use

3.26 organization group of individuals and facilities with an arrangement of responsibilities, authorities and relationships

EXAMPLES company, corporation, firm, enterprise, institution, charity, sole trader, association, or parts or combination thereof

NOTE An organization can be public or private.

[3.3.1 of ISO 9000, modified]

3.27 personal protective equipment any device or appliance designed to be worn or held by an individual for protection against one or more health and safety hazards

82079-1 Ed.1 © IEC:2009 – 12 – 82079-1 Ed.1 © CEI:2009

3.28 plant assembly of different systems on a specific site

[IEC 61355-1]

3.29 product intended or accomplished result of labour, or of a natural or artificial process, which could be a good or service

Note Instructions for use are seen as a part of a product.

3.30 product safety label label on a product that informs the observer of one or more potential hazards and describes the safety precautions and/or actions required to avoid the hazard(s)

3.31 reasonably foreseeable misuse use of a product in a way not described as intended use in the instructions for use, but which may result from readily predictable human behaviour


3.32 repair part of corrective maintenance in which actions are performed on a product including replacement of worn-out parts and reworking of defective or damaged parts or functions

3.33 risk combination of the probability of occurrence of harm and the severity of that harm


3.34 safety note safety-related information that is collected or grouped in a document or section of a document in a meaningful organizational system to explain safety measures, raise safety awareness and provide a basis for safety related training of users

3.35 safety sign sign which gives a general safety message, obtained by a combination of colour and geometric shape and which, by the addition of a graphical symbol, gives a particular safety message

[ISO 7010]

3.36 service result of activities between a supplier and a customer, and the internal activities carried out by the supplier to meet the requirements of the customer


82079-1 Ed.1 © IEC:2009 – 13 – 82079-1 Ed.1 © CEI:2009

3.37 skilled person individual with relevant technical education, training and/or experience enabling him or her to perceive risks and to avoid hazards occurring during use of a product

[IEV 195-04-01 and 3.53 of IEC 60204-1, modified]

3.38 supplied accessory part packaged with the product (or as optional extra) that is necessary for certain operations or maintenance of the product

3.39 supplier individual or organization that provides products and related documentation

NOTE Examples of supplier are producer, manufacturer, integrator, vendor, distributor, retailer, agency, provider of information or their authorized representatives.

[2.16 of ISO/IEC Guide 14 and 3.3.6 of ISO 9000, modified]

3.40 target group group of persons for which instructions for use are intended

3.41 use any activity that the user may perform with or on the product during its whole life cycle

3.42 user individual or organization that uses products

NOTE In this part of the International Standard, the term “user” means “end user” except when otherwise noted

3.43 warning message safety-related information that warns users about hazards and instructs on how to avoid them. Warning messages should be given within instructions for use related to tasks in which the hazards may occur

4 Principles

4.1 Provision of instructions for use

4.1.1 General

The level of description and details of information shall be adapted to the knowledge of target group(s), Instructions for use shall ensure the completeness of relevant information at a sufficient level of description based on the ascertained needs of the target group.

4.1.2 Instructions for use are part of the product

A product shall be accompanied by instructions for use which promote its intended use and contain all information that a user needs to know before using the product. Where instructions for use comprise more than one document, these shall be arranged in a meaningful and organized system and support navigation. The way in which third party documents are integrated shall be based on customer requirements and user needs.

82079-1 Ed.1 © IEC:2009 – 14 – 82079-1 Ed.1 © CEI:2009

Instructions for use should reduce the risk of injury or illness to people or animals. In addition they should reduce the risks of damage, malfunction or inefficient operation of the product. Instructions for use cannot compensate for design deficiencies or missing safety systems (see ISO/IEC Guide 37).

4.1.3 Consistency of information

All information in instructions for use shall be consistent within itself and with all other information relating to the same product issued by the supplier, such as advertising or packaging, any warranty and World Wide Web based information, and the information has also to be consistent with the legal requirements which may result from any warranty stipulations. Consistent terminology shall be used in the instructions for use, on the product and its packaging, and in supplementary materials, all training and promotional materials including markings, labels and transport packaging.

4.1.4 Product warranty

The product warranty shall include all relevant terms and conditions (for example, date of expiry, service conditions, allowed modifications, availability of spare parts), and shall be provided together with instructions for use.

It may be appropriate to put the product warranty into a separate document especially when the terms vary between different sales channels or countries.

4.1.5 Information provided after sale of products

After the product has passed into the user’s possession, it can be helpful to provide, via World Wide Web sites or other means of communication to users and target groups, newly added or revised instructions for use, information about using the product, and other information that will be beneficial to the user.

4.1.6 Security aspects

Inclusion of security aspects shall be in accordance with ISO/IEC Guide 81.

4.2 Quality of communication

Expert writers or specialists shall be responsible for the preparation of instructions for use, including checking and proofreading, and:

• have advanced competencies in communication;

• have solid competencies in the original language;

• are familiar with the subject area;

• know the process chain for the preparation of instructions for use and are competent in the application of the requirements of this part of the International Standard in the process chain.

Instructions for use should be contextually edited by qualified persons specialised in writing for the target groups.

4.3 Minimizing risks

Instructions for use are an integral part of the safe operation and maintenance of a product. They shall provide information to avoid any unacceptable risk for the user or other parties, damage to the product itself or other goods, malfunction or inefficient operation. They shall directly help to avoid reasonably foreseeable misuse, which may result in the generation of hazards, therefore:

82079-1 Ed.1 © IEC:2009 – 15 – 82079-1 Ed.1 © CEI:2009

• risk assessment of use, i.e. the analysis of the process from risk analysis to risk evaluation, shall be undertaken by the supplier in accordance with ISO 12100 and/or IEC 60204-1 if applicable;

• result of the risk assessment, that is remaining risk, shall be taken into account in the instructions for use as safety-related information in accordance with ISO/IEC Guide 51 and, any relevant standards for safety-related information;

• reasonably foreseeable misuse and risks arising from the use of the product shall be covered.

See also 5.4.

NOTE As a matter of principle, the supplier has an obligation to include such safety-related information, in fact it is a legal requirement in most countries.

4.4 Target group(s)

When preparing instructions for use, the needs and capabilities of the intended target group of the product shall be addressed. Usually they will be the type of people likely to use the product, defined for example by age range, language, technical knowledge, or technical discipline. See also 4.8.2 and 4.8.3.

If instructions for use are directed to more than one target group (for example consumers and persons responsible for installation, repair or certain types of maintenance), those shall be separated and be adequately marked in a clear visible manner. The target groups shall be defined at the beginning of the content.

4.5 Special precautions

Attention should be drawn to the need for special protective measures, such as adult supervision or the wearing of special clothing, needed to protect users and bystanders.

Dangers to particularly vulnerable groups such as children, older persons and persons with disabilities (including, for example, users with heart pacemakers, or who suffer allergic reactions to specific chemicals or are sensitive to strobe lighting effects) should also be highlighted (see ISO/IEC Guide 37 and ISO/IEC Guide 71).

4.6 Short-life products

For products which have an intended limited life, for example, for safety reasons, quality or economic performance, information shall be provided about the year of manufacture, date of expiry and/or hours of operation.

4.7 Considerations as to the nature of instructions for use

4.7.1 General

With respect to the nature of instructions for use, the following shall be taken into account:

• writing style, for example. the use of discriminatory or offensive language;

• legal requirements and standards;

• the latest technology available for preparing instructions;

• relevant international standards addressing the needs of older persons, persons with disabilities and accessibility. See ISO/IEC Guide 71.

82079-1 Ed.1 © IEC:2009 – 16 – 82079-1 Ed.1 © CEI:2009

4.7.2 Location

Instructions for use shall be given in one or more of the following locations as appropriate:

• inside the packaging together with the product;

• on or within the product itself;

• on the packaging, but not only on the packaging;

• on the World Wide Web sites provided by suppliers: see 4.7.5, 5.6 and 6.2.1, but not only on the World Wide Web.

Where instructions for use are complex, it is helpful that certain important messages are additionally given or displayed on the product, for example by means of short reference or reminder cards, stickers, illustrations or labels.

4.7.3 Means of communication and media

Means of communication and media shall be chosen as appropriate according to the environment and types of target groups (including child users, older users and users with disabilities). The decision about the media shall ensure that the target groups can have permanent easy access to all information necessary during use under foreseeable circumstances, especially for safety, intended use, installation, getting started, commissioning, putting into service, troubleshooting, maintenance and disposal.

In most cases, such as for consumer products, a printed version of the instructions for use is necessary. Supplying instructions for use only in electronic format is not permissible in many cases, such as for compliance with legal requirements.

The following are examples of possible means of communication and media:

a) Means of communication 1) graphical symbols; 2) text, video (including auxiliary means such as audio and subtitles when appropriate),

speech; 3) Braille, large text, tactile figures, signs or other visible hand gestures; 4) in supplementary documentation (for example, leaflet, manual or information provided

by Braille) or electronic-documentation (for example built-in manual, recorded media, or in World Wide Web).

b) Medium 1) accessing information via Web sites; 2) accessing information via appropriate tools using for example Radio Frequency

Identification Devices (RFID); 3) leaflets with text and illustrations; 4) manuals for users and maintenance staff; 5) a graphical user interface (GUI).

4.7.4 Durability

Instructions for use given on the product shall remain legible throughout the expected life of the product.

Instructions for use given on packaging or in materials accompanying the product (such as leaflets, manuals, data media, etc.) shall be produced in durable form. They shall be designed and made so as to survive frequent use during the expected life of the product in the environment where the product is intended to be used. It should be taken into consideration

82079-1 Ed.1 © IEC:2009 – 17 – 82079-1 Ed.1 © CEI:2009

that a fold-out made of thin paper will not be sufficiently durable if frequent reference to it is required.

4.7.5 Availability

Instructions for use shall be marked KEEP FOR FUTURE REFERENCE or its equivalent unless it is clear that there will be no circumstances in which they will be required during the product's operational life. The supplier of the product shall keep replacement copies of all such instructions for use available throughout the expected life of the product. For each consumer product instructions for use should in addition be made available and easily found on the World Wide Web (see 5.6 and 6.2.1).

Since packaging is often impermanent and destroyed in the unpacking process, the instructions for use which need to be kept for future reference should not be placed on the packaging only. Where this cannot be avoided (for example, for practical reasons), the advice to keep them for future reference shall be clearly indicated. If only a part of the packaging contains instructions for use, that part should be easily detachable from the rest of the packaging and have an appropriate form and size for being stored.

4.7.6 Electronic guidance systems

Where an electronic guidance system is provided, it shall allow a user to navigate through the structure of the system so that the users at any time know where they are in the structure. Users shall at any time be able to view on-screen the system structure, together with its nodes and associated information. The user shall be able to collapse or to expand the system structure as required.

Warning messages for foreseeable exceptional situations shall be assigned only to those nodes in the structure to which they are relevant.

4.7.7 User training

Where user training is required, this shall be specified in the instructions for use and, where appropriate also in the supply contract. However, user training courses cannot be a substitute for instructions for use but only complement them. User training courses should be provided where the instructions for use alone cannot fulfill the general requirements given in 4.1.1 because of the complexity of the product or the necessity for more comprehensive user information, or if a sufficient knowledge on behalf of the user cannot be expected.

4.8 Creating instructions for use

4.8.1 Conformity with the product

4.8.1.1 Relationship between instructions for use and the product

Instructions for use shall unambiguously relate to the supplied product, therefore they shall contain the information related to identification with which the product is marked. This shall as a minimum comprise name and address of the supplier, designation of series or type and, if applicable, serial number.

Where the product is in conformity with a recognized standard, this shall be clearly indicated. For identification requirements see IEC 62507-1. See also 5.2.

An introduction to instructions for use shall include: the product name and type, the supplier, and document designation. If applicable, a product illustration should be provided.

82079-1 Ed.1 © IEC:2009 – 18 – 82079-1 Ed.1 © CEI:2009

4.8.1.2 Variants of one product

If more than one product variant is addressed by a set of instructions for use, the identifier of a specific variant shall be clearly recognizable in the instructions for use and on the product to ensure unambiguous identification. The relationship between content and operational features of different product variants shall be unambiguous.

Where a single document covers multiple variants of one product, there are different ways to organize information, for example:

a) Each product variant has its own sections. Common parts are repeated in each product variant section. In this solution the amount of pages is large, but from the user’s point of view it is easy to read (all content is applicable for the particular product variant) and the risk for misinterpretation is low. Identification of the applicable product variant is highlighted for example in footer or header of each page (see 5.2).

b) All product variants have one common section. Product variant specific information is highlighted using for example, sub-headings, different colours, This solution is compact, but special care needs to be taken when implementing and verifying instructions for use.

If option b) is used the result should be verified using empirical evaluation because there is a higher risk of misinterpretation.

4.8.1.3 Information on installation and maintenance

The parts of instructions for use dealing with installation and maintenance shall include as a minimum addresses of the supplier and authorized service centres for the product. The following information should be included as far as applicable: technical data, notes on warranties, trouble-shooting, a list of consumables and information about disposal.

4.8.1.4 Units of measurement

Quantities should normally be expressed in SI units (international system of units of measurement) or in derived SI units (see ISO/IEC 80000). However, quantities expressed in instructions for use shall comply with those units of measurement used on the product. Where non-SI units of measurements are used for the product, SI equivalents should be provided.

4.8.1.5 Optional modules and extras

Instructions for use concerning optional modules or extras should be kept clearly separate from common instructions for use and from instructions for use for other modules or extras (for example by using separate sections, headings, etc.) so that users are not confused by irrelevant information.

Where a product offers, for example, both the ability to charge re-chargeable batteries in the battery compartment or to use non-rechargeable batteries, the instructions for use should include paragraphs under separate headings for:

a) the use of re-chargeable batteries; b) the use of non-rechargeable batteries.

4.8.1.6 Special tools, equipment, material

Instructions for use should include information for interconnecting accessories and other equipment including indication of suitable accessories, detachable parts and any special materials, as far as appropriate. The instructions for use should also contain the name and address of suppliers from whom special tools, materials, etc. and technical assistance can be obtained.

82079-1 Ed.1 © IEC:2009 – 19 – 82079-1 Ed.1 © CEI:2009

If necessary, information on repackaging should be provided for replacement, repair, reworking, refilling, etc.

4.8.2 Consideration of needs of target groups

4.8.2.1 Analyses of target groups

Consideration of the needs of target groups shall be based on analyses as set out in 4.4. For consumer products empirical tests are recommended. See also Annex E.

4.8.2.2 Target groups with particular needs

Where products are intended to be used by target groups with particular needs, instructions for use shall take them into account. Target groups with particular needs include, for example, older persons, children or other persons unable to use the product safely without supervision, persons with disabilities, adults supervising children and persons who are functionally illiterate.

4.8.2.3 Comprehensible terminology

Instructions for use shall be comprehensible by the general public unless the product is intended for use by a specific target group with specialist knowledge. Where the use of technical terms and expressions is unavoidable, their meanings shall be explained.

4.8.2.4 Meanings of signals

The meanings of signals, such as flashing indicators, colour changes or audible signals, shall be explained so that they are easily recognised and understood by the target group.

NOTE Examples of signal signs are found in IEC 60073, ISO 7731, ISO 11429, ISO 15006 and ISO/TR 16352.

4.8.2.5 Supplementary information

Where supplementary information is provided, either for particular target groups or for a specific purpose, it shall clearly be indicated on the first page of the instructions for use.

4.8.3 Languages

4.8.3.1 General

Instructions for use shall be supplied in the official language(s) of the country of sale in accordance with the local or regional legal requirements.

Selection of the additional language(s) of instructions for use should take into account the following:

a) Tourists, ethnic minorities and cross-border internet buyers are likely to be a significant (and increasing) proportion of customers of many products on the markets of many countries.

b) A large number of target groups (for example, migrants and refugees) are non-native speakers of the official language(s) of the country they live in. They therefore will find themselves using products whose instructions for use are not written in a language they adequately understand.

Where instructions for use are given in several languages, they shall be distinguishable by colour coding and/or by commencing with an illustration widely associated with each language – for example a flag or country identification letters. In order to facilitate ease of use, instructions for use in different languages should be provided separately.

82079-1 Ed.1 © IEC:2009 – 20 – 82079-1 Ed.1 © CEI:2009

Where illustrations need explanatory texts, they shall be placed adjacent to one another so that they are perceived together (see also 6.3.4).

A single illustration may serve for more than one language provided the illustration is perceived together with the text in every language and the illustration does not contain language specific elements.

In addition, important operation and safety precautions can be conveyed by language-independent means such as safety signs and graphical symbols and self-explanatory illustrations.

4.8.3.2 Graphical symbols, including safety signs and product safety labels

Graphical symbols, including safety signs and product labels shall be easily recognizable and comprehensible by the target group. Safety signs and graphical symbols used on the product or within the instructions for use which are neither readily comprehensible nor unambiguous shall be explained.

Because of the limited space generally available, placing instructions for use on a product may present problems in relation to languages, especially when the country where the instructions for use will be used has more than one official language. These problems can be solved by use of:

• safety signs, product safety labels and graphical symbols (see 6.4) which are comprehensible;

• alpha-numeric codes, with an explanation of the meaning;

• certain words or abbreviations (for example STOP, MAX./MIN.) which are internationally acceptable.

NOTE 1 ISO 7010, IEC 60417 and ISO 7000 provide internationally standardized safety signs and graphical symbols.

NOTE 2 The ISO 9186 series of standards provides procedures for testing the comprehensibility of graphical symbols including safety signs.

4.8.3.3 Quality of translations

Where instructions for use are translated from the original language into others, expert translators or specialists shall be responsible for the translation including checking and proofreading, and;

• have basic competences in communication;

• are familiar with the subject area;

• are fluent in the original and target languages, preferably native speakers in the target language.

Colloquial expressions and untypical regional variations of names and product features should be avoided.

The translated instructions for use should be edited by qualified persons specializing in writing and translating for the target groups.

82079-1 Ed.1 © IEC:2009 – 21 – 82079-1 Ed.1 © CEI:2009

5 Content of instructions for use

5.1 General

The functionality of products shall be described and users questions such as WHERE? WHO? WHAT? WHEN? HOW? WHY? should be anticipated and appropriate answers provided.

The information to be given depends on the target group(s) and the tasks that they are intended or allowed to perform throughout the life of the product.

5.2 Identification and specification of the product

The specification or description of the product shall enable the user to identify the product itself and find the identifying information on the product by:

• product identification number, serial number, model and/or type, see IEC 62507-1;

• name/identifying information of the supplier together with the supplier’s contact details such as easily accessible telephone numbers, fax numbers, and any other possible means of communication;

• name, address, phone numbers, fax numbers, e-mail and web addresses of providers of special tools, material, etc. and technical assistance.

Furthermore, the specification or description of the product shall provide a general overview on requirements, performance and features, and provide the following information as far as applicable:

• complete measurements, for example, mass, volumetric capacity, and performance;

• information regarding energy consumption and input voltage, insulation category (in case of insulation category II marking with graphical symbol IEC 60417-5172, in case of insulation category III marking with graphical symbol IEC 60417-5180) and IP Code defined in IEC 60529;

• energy efficiency rating;

• requirements for gas supply (for example, type, pressure), water supply and other relevant information on items such as cleaning agents, lubricants, and fuses (for example, type, rated value and characteristics);

• emitted noise level, waste discharge rate, etc. under specified circumstances;

• electromagnetic compatibility;

• description of the type of intended user (and, especially in the case of accessible design products, a clear statement of any special precautions that should be followed by the user (see ISO/IEC Guide 71));

• standards to which the product complies;

• notes on reasonably foreseeable use and misuse.

For principles and methods for detailed specification of products, see IEC/PAS 62569-1.

Some product standards may require the use of particular marking or labelling on the product and/or associated instructions for use in order to show the product complies with particular requirements of these product standards.

5.3 Modification of products

Where a supplier does not allow for a product to be modified this shall be clearly stated in the instructions for use including information about possible consequences caused by a modification.

82079-1 Ed.1 © IEC:2009 – 22 – 82079-1 Ed.1 © CEI:2009

Where applicable it should be clearly stated that any modification of the product by the user is not recommended and any consequences will not be covered by support services or product warranties.

When a supplier allows users to modify a product, the instructions for use shall describe permissible (and non-permissible) modifications. Instructions for use shall clearly describe and illustrate how to undertake permissible modifications (or direct the user to a source of relevant information), so as to allow the user to modify the product correctly and to ensure continuing safe and efficient use.

5.4 Safety-related information

5.4.1 General

There are three types of safety-related information which should be separately identified:

• safety notes;

• warning messages;

• product safety labels.

Note ISO 3864-2 defines product safety labels.

Safety-related information shall relate to the various phases of the life of the product.

Safety-related information shall include the following, if applicable:

• intended use of the product, the main function/purpose and scope of application and the essential safety principles to be observed;

• limits of application regarding, for example, place, time, environment and type of application, materials and additives, any necessary tools, as well as climatic conditions for operation and storage, such as temperature and humidity, explosive atmosphere, outdoor operation;

• clear and prominent information about personal protective equipment (for example, clothing, protective goggles) that is necessary to use the product safely;

• protective features that need to be installed or activated by users;

• potential hazards or precautions for specific groups of persons of which users shall be aware and which would not be immediately obvious without being pointed out;

• potential health consequences which may result from failure to observe precautions or avoid hazards if the risk or severity would not be immediately obvious;

• description of the user type, for example, skilled persons, or ordinary persons older than 18 years;

• information regarding restrictions on the personnel who are permitted to use the product together with any special skills required;

• specific indications that products are no longer safe to use, for example, due to wear, ageing or damage;

• information regarding safe disposal;

• explanation of graphical symbols used in safety-related information (see ISO 7000, ISO 7010, IEC 60417);

• restrictions and/or recommendations for safe use, for example, use in dry environments, or not to be used in bathrooms or other humid environments;

• signal words and/or graphical symbols;

• warning messages on hazards;

• warning messages on reasonably foreseeable misuse;

82079-1 Ed.1 © IEC:2009 – 23 – 82079-1 Ed.1 © CEI:2009

• warning messages on radiation, including any sealed hazard, for example, laser according to IEC 60825-1, microwave, ultraviolet, infrared and lethal voltages.

Information about personal protective equipment should additionally be given on the packaging and/or on the product itself.

Restrictions concerning the use of the product shall be given clearly in the instructions for use, for example in specifications and in commercial brochures at the point of sale (see also ISO/IEC Guide 14).

NOTE Product-related standards and legal regulations may contain additional requirements.

5.4.2 Safety notes

Safety notes shall be presented in a meaningful organizational system. They shall be provided in a separate clause or section at the beginning of the instructions for use. This clause or section shall be clearly identifiable and shall have a heading which emphasizes the importance of the content.

Safety notes shall as a minimum provide directions on the safe use of products, indicate potential hazards and how to avoid such hazards, and state the probable consequences of not avoiding them.

5.4.3 Warning messages

Warning messages shall be given in the context in which a danger may occur. They shall indicate potential hazards and state possible consequences if not avoided.

Warning messages shall be concise. They shall not contain complete procedures, but complement the procedures described elsewhere in the instructions for use. Information about avoiding the hazards shall be included. However, if the information about avoiding the hazard is clearly understood by the intended target groups, it may be omitted in the warning message itself.

5.4.4 Safety-related information for industrial plants

Safety-related information shall be provided with each component. Where an assembly of components might produce additional potential hazards, the relevant safety-related information shall be only provided at the relevant level of assembly. When integrating components to higher assemblies, safety-related information should be provided only at that level of aggregation where they occur.

5.5 Product compliance

Where applicable, instructions for use shall include information about legal and other requirements applicable to the product.

5.6 Importance of retaining instructions for use

The user's attention shall be drawn to the importance of retaining instructions for use for the life of the product by means of a statement such as

IMPORTANT READ CAREFULLY BEFORE USE KEEP FOR FUTURE REFERENCE.

82079-1 Ed.1 © IEC:2009 – 24 – 82079-1 Ed.1 © CEI:2009

Replacement copies of all such instructions for use should be made available from the supplier on demand (for example, from the web site), throughout the expected life of the product.

5.7 Preparing products for use

5.7.1 Transportation and storage

If applicable instructions for use shall include information for the protection of the product and the safety of persons during transportation and storage, for example:

• dimensions, mass, and centre of gravity;

• methods of lifting, handling and transportation that are ergonomically efficient and will prevent damaging impacts (for example, by indicating gripping points and lock-down screws); and

• storage requirements with associated ambient conditions (for example, humidity, laying flat, avoiding direct sunlight);

• storage of the product after use;

• methods for securing the product against unexpected shocks.

5.7.2 Installation

For products which require installation, instructions for use shall if relevant include:

• methods for the removal of transport and packaging restraints, and equipment transit clamps;

• procedures for unpacking (provided on the outside of the packaging) and for the removal and safe disposal of any protective and preservative packaging;

• a checklist of items included in the package;

• minimum space needed for use, maintenance and repair;

• a layout plan;

• interconnection diagram and/or table;

• conditions for assembly and mounting; and

• methods, precautions and legal requirements for connecting the product to power and water supplies, drainage and other auxiliary supplies.

5.7.3 Commissioning

The instructions for use shall include all the information necessary for the commissioning of the product prior to its handing over in working order to the user.

5.8 Operation of products

5.8.1 General

The user shall be provided with information regarding normal and safe operation as well as abnormal operation of the product.

5.8.2 Normal operation

Instructions for use shall if relevant cover the following:

• information related to the operational environment;

• information on any manual operating techniques;

• information about local/remote operation and how to switch between the two;

82079-1 Ed.1 © IEC:2009 – 25 – 82079-1 Ed.1 © CEI:2009

• information regarding vibration for portable hand-held and hand-guided machinery if necessary;

• means of starting/stopping the product's operation;

• any initiating operations, checks, adjustments or conditioning required prior to each occasion of normal use;

• illustrations that clarify or reinforce understanding of the main functions and safety precautions;

• recommendations for waste removal; and

• identification and correction of malfunctions.

5.8.3 Additional information for automatic and remotely controlled products

User guidance systems shall provide the user in an on-line mode with additional information on the operational state of the products. For example:

• full information about normal operation;

• an indication that the system has automatically switched to safe operation mode before a hazardous situation has been reached;

• the current state of operation so that the user is made aware of this automatically guided function;

• what to do when the control system itself has failed;

• instructions on how to manage fault situations; and

• information regarding whether the system is in manual, local or automatic mode.

NOTE For software documentation for user guidance systems, refer to IEC 61506.

5.8.4 Indications of faults and warning device signals

Recognisable indications of normal and abnormal operation and the recognition of signals from any warning devices shall be explained in instruction media that can be referred to without operation of the product itself.

Any signals or displays intended to indicate impending risk of damage or imminent danger shall be readily comprehensible and unambiguous.

Appropriate warnings shall be provided where use of the product in question might affect electrically controlled medical devices, such as heart pacemakers.

Advice shall be given to enable users to recognize any medical symptoms or adverse medical reactions that might arise from the use of the product and to understand what corrective actions or treatment to implement.

5.8.5 Exceptional/emergency situations

Where applicable, information on the following shall be provided:

• sequence of actions to be taken in the case of an unexpected interruption of power, cooling, etc;

• fault indication and its location, and restarting after an intervention;

• in the case of possible fire, which type of fire-fighting equipment to be used;

• information about foreseeable emissions or leakages of substances with associated warnings of the nature of any hazard including precautions to avoid harm and, if possible, by which means the effects may be countered and the normal state of operation regained;

82079-1 Ed.1 © IEC:2009 – 26 – 82079-1 Ed.1 © CEI:2009

• first aid treatments recommended for any foreseeable acute medical conditions that may result from the use of the product, for example, toxic shock, epileptic fit or burns, and advice on subsequent professional medical treatment to be sought.

5.8.6 Troubleshooting and repair for non-skilled persons

If the user of the product can perform troubleshooting and repair tasks without risk of harm to him/herself, other people or safety of the product, the instructions for use shall provide a checklist of possible faults (or ‘frequently-asked-questions - ‘FAQs’). This checklist or the FAQs including appropriate illustrations shall give a clear indication of those faults which the user can attempt to repair. Directions for repairing faults should be limited to those tasks that a non-technical user could reasonably be expected to undertake.

Telephone and URL or e-mail contact details, for communicating a complaint or customer service query, should be provided in instruction media that can be referred to without operation of the product itself. A list of the locations and contact details of the supplier in the country or countries in which it is marketed shall accompany the product or be available on the supplier’s website.

5.8.7 Troubleshooting and repair for skilled persons

The following information shall if relevant be provided:

• list of indications for fault identification and its location;

• list of indications of normal operation;

• descriptions of built-in diagnostic systems to aid fault detection, when applicable;

• drawings and diagrams enabling the troubleshooting task to be done effectively;

• directions for noting malfunctions of equipment, noting abnormal symptoms and indications, and recording operation of alarms and trips;

• directions for starting standby or alternative systems, and for shutting-down and isolating malfunctioning units;

• repairs and adjustments;

• aids for troubleshooting procedures, such as functionally identified maintenance system (FIMS), fault step diagnosis (FSD), fault step and algorithms, or, in complex systems, fault trees and computer-based fault diagnosis.

• clear definition of troubleshooting and repair tasks that should not be attempted by the user, together with instructions on how to contact the supplier or others from whom technical assistance may be obtained; and

• name, address, accessible telephone numbers, fax numbers, and any other means of communication of the supplier or others from whom technical assistance can be obtained.

5.9 Maintenance

5.9.1 General

Separate information shall be provided for maintenance that can be performed by skilled and non-skilled persons - preferably as separate documents or at least as separate clauses.

5.9.2 Product maintenance by non-skilled persons

If the user of the product can perform maintenance tasks without harm to the user, other people, or the product, the instructions for use shall include specific descriptions of these tasks and their nature and frequency.

Instructions for use shall provide a list of possible maintenance tasks with appropriate illustrations as required to allow users to perform the tasks accurately and without difficulty.

82079-1 Ed.1 © IEC:2009 – 27 – 82079-1 Ed.1 © CEI:2009

When certain maintenance tasks need to be performed more frequently than others, everyday maintenance tasks shall be distinguished from periodic (short-term and long-term) maintenance and inspection activities.

Materials and tools used for cleaning, for example, appropriate chemical substances, cleaning cloths and brushes, shall also be specified. Risks arising from the use of inappropriate materials and tools shall be clearly specified.

When there are maintenance tasks that should not be attempted by the user, those tasks shall be clearly identified and the user shall be instructed how to contact the supplier or others from whom technical assistance may be obtained.

5.9.3 Product maintenance by skilled persons

Information on maintenance for skilled persons shall be provided separately from the information provided to non-skilled persons – preferably as separate documents or at least as separate clauses. Such information shall include:

• the nature and frequency of inspections;

• safety precautions and warnings for maintenance carried out on running or live equipment;

• drawings and diagrams enabling the maintenance task to be done effectively;

• regular checking of warning devices;

• details of cleaning methods. Where there is a possibility of an incorrect cleaning or decontamination process or the use of wrong cleaning materials that causes an immediate safety hazard or problems resulting from corrosion or weakening of structural parts of a product this shall specifically be mentioned;

• maintenance schedules and, if necessary, master schedules which incorporate details of all tasks required to be carried out at regular intervals;

• the name, address, accessible telephone numbers, fax numbers, and any other means of communicating with the supplier or others from whom technical assistance can be obtained.

5.9.4 Planned maintenance of industrial plants

An overall maintenance and service plan for an industrial plant shall be drawn up by combining the maintenance and service plans for all key components.

5.10 Supplied accessories, consumables and spare parts

5.10.1 Accessories

The following information, as required for each accessory, should be supplied in instructions for use:

• name, part number and whether basic or optional;

• illustrations to allow the user to identify the accessory and where to attach it;

• description of its function and purpose.

5.10.2 Consumables

Where consumables are required, the following information shall be provided in the instructions for use:

• description and recommended quantity of consumables, the official model name or part number, any common commercial name (and, for materials, generic name);

82079-1 Ed.1 © IEC:2009 – 28 – 82079-1 Ed.1 © CEI:2009

• typical replacement frequency (in time or volume of usage);

• an illustration that allows the user to identify the consumables;

• an illustration to show the position of, or the access to, the consumables (in an exploded view if clearer);

• information for removal and replacement or refilling;

• information about disposal of removed consumables.

5.10.3 Spare/replacement parts

A list of replacement parts purchasable as spares shall be provided. The following information should, as appropriate, be provided for each part, together with an indication of the level of skill required to replace the part without causing potential hazards:

• its name, identification and serial numbers in the form used on the product and in commercial transactions;

• the supplier's part/type and version numbers as well as the name, reference and version numbers for branded parts, if different from the above;

• an illustration of the part and its position, preferably in exploded view;

• sources of supply as well as alternative sources of supply for spare parts;

• parts for which there is a refurbishing service available provided by the supplier or a service provider;

• an identification in accordance with IEC 81346 of components of complex products;

• an identification in accordance with IEC 81346 of locations where a specific spare part can be used as replacement;

• the year of manufacture or the year of expiry for the spare/replacement parts availability if not given in a separate document;

• information about disposal of removed spare/replacement part.

5.11 Information on special tools, equipment and materials

Information on any special tools, items, or equipment required to deal with special conditions, but not used in normal operation, shall normally not be provided to non-skilled persons. Such information shall be provided only to skilled persons.

The information shall include descriptions of interconnections with accessories and other equipment, including indication of suitable accessories, detachable parts, and any special materials that may be used.

Methods to repackage shall be provided, if necessary, for replacing, repairing, reworking, and refilling the product.

Consumables, cleaning material, lubricant products and repair kits shall be identified, if appropriate.

5.12 Information on repair of products and replacement of parts

5.12.1 Information on repair of products and replacement of parts for non-skilled persons

Information on repairing and replacing parts for consumers shall be provided if this can be undertaken without risk of harm to consumers, other people or the safe use of the product.

When the supplier permits consumers to replace parts themselves, the following information shall be provided to consumers:

82079-1 Ed.1 © IEC:2009 – 29 – 82079-1 Ed.1 © CEI:2009

• the source of replacement parts;

• the method of repair or replacement; and

• the method for testing after the repair or replacement, if any test is required.

When the supplier does not permit consumers to replace parts themselves, information about the service agent(s) to contact shall be provided.

5.12.2 Information on repair of products and replacement of parts for skilled persons

Information on repairing and replacing parts shall be provided for skilled persons:

• to repair the equipment and/or to replace parts;

• to carry out tests that have to be performed after replacing a part.

5.13 Information required when the product is no longer needed

5.13.1 General

Instructions for use shall contain information relating to handling, reuse, recycling or disposal of the product after it is no longer needed.

5.13.2 Disassembly

Disassembly by the consumer shall only be permitted where this does not create a hazard.

Where appropriate, instructions for use shall include information, separately or in combination, on disassembly of the product and/or handling of any waste materials with due regard to safety and environmental considerations.

5.13.3 Recycling

Where specific procedures are necessary for recycling of the product or its components, these shall be specified in accordance with the appropriate legal requirements and/or standards.

5.13.4 Disposal

Any applicable standards for disposal processing should be clearly indicated.

Instructions for use shall convey important information to the user about aspects relating to waste disposal and environmental considerations.

If the product contains any hazardous substance, or if any hazardous substance is supplied together with the product, the necessary information on its constituents and the correct disposal procedure shall be given with due regard to safety and legal requirements.

5.14 Structure

5.14.1 General

Instructions for use that are lengthy or complex shall be clearly divided into convenient parts, and shall have a regular format. Requirements for individual parts should be specified in relevant product standards or in technical documentation within an industry sector taking account of the provisions of this part of International Standard.

Depending on the purpose of the instructions for use and the amount of information they contain, some of the subclauses in Clause 5 of this part of the International Standard may be omitted. The structure of chapters, sections, and topics shall be internally consistent.

82079-1 Ed.1 © IEC:2009 – 30 – 82079-1 Ed.1 © CEI:2009

For instructions for use comprising multiple manuals, the information on the front covers and/or spines shall make it easy to distinguish one manual from another.

5.14.2 Page numbering

If instructions for use comprise more than two (printed) pages, the pages shall be numbered as n of m where n is the actual page number and m is the total number of pages.

5.14.3 Table of contents

Instructions for use that exceed four pages shall have a table of contents.

Headings appearing in the table of contents shall be the same as those used in the text.

5.14.4 Index

If instructions for use are lengthy and complex, an index of keywords presented in alphabetical order should be included. The index shall be referenced in the table of contents.

5.14.5 Technical terms, acronyms and abbreviations

Unavoidable technical terms, acronyms and abbreviations not readily comprehensible by the intended target group shall be listed and explained.

For consumer products it is useful to conduct empirical tests if it is doubtful whether technical terms are generally understood by the target group. A glossary is recommended when technical terms are often used in the instructions for use.

Consistent terminology shall be used in the instructions for use themselves on the product itself, on the packaging, or in accompanying material such as manuals.

5.14.6 Graphical and tactile symbols and tactile dots

Graphical and tactile symbols and tactile dots shall be listed and explained.

5.14.7 Presentational conventions

Presentational conventions used in instructions for use shall be listed and explained, for example the use of a specific typeface for actions to be carried out by the user.

5.14.8 User controls and indicators

If applicable, instructions for use shall contain a description of the user controls and indicators applicable to the relevant component.

6 Presentation of instructions for use

6.1 Comprehensibility

6.1.1 Recognized communication principles

Within each section of instructions for use, the learning process demanded of the user should, as far possible, be broken down into a series of small steps. Building understanding in a continuous sequence may be reinforced by numbering operational steps and/or by referring the user (at each step) to an illustration representing each action visually or its effect schematically. Each step should provide a single action.

82079-1 Ed.1 © IEC:2009 – 31 – 82079-1 Ed.1 © CEI:2009

The function and meaning of information (for example, the description of the product or information about troubleshooting) should be readily identifiable and different types of information should be separately identified.

For procedural instructions, preconditions for the sequence of necessary steps shall be given before the sequence of operation.

Where possible (and particularly for assembly) the user should be led to read a single instructional step, then perform it, appreciate the effect, then read the next step.

Accepted methods for structuring should be used which support the correct use of the product ("what" should be done with the product and "how", in correct order). General aspects should be described in an overview chapter, specific aspects in the relevant context.

The use of illustrations increases comprehensibility of instructions for use. An effective balance of text and illustrations is recommended. Illustrations shall be provided with a unique number to which reference can be made in the text.

6.1.2 Style guide

An editorial style guide should be established and followed through the entire instructions for use covering, for example:

• writing style (see Table 1);

• wording;

• terms (consistency);

• way to address the readers; and

• design of text and page layout including selection of typeface and font size (see Table 2).

6.1.3 Structure

The wording should fit the structure which supports the various text functions. Such text functions are for example:

• subject (heading);

• description;

• goal;

• prerequisite;

• condition;

• action;

• result;

• warning;

• prompt and reminder;

• example;

• caption (addressing a figure or a table).

The use of a consistent structuring method is recommended.

Instructions for use should cover basic or normal functions first, and other functions later.

82079-1 Ed.1 © IEC:2009 – 32 – 82079-1 Ed.1 © CEI:2009 Headings shall be numbered, short and easy to understand. As a structuring element, they shall serve as a guide as the user reads through the instructions for use, and shall help the user to locate the required information.

6.1.4 Consistent terminology

Terminology shall be used consistently according to an editorial style guide thus enhancing comprehensibility.

Consistent terminology shall be used in the instructions for use themselves, on the packaging, in other collateral materials and on the product itself.

6.1.5 Simple and brief

Information shall be as simple and as brief as possible, and shall be expressed in consistent terms and units. The sentence structure should be simple. Sentences should be short and shall be grammatically correct.

Cross references shall be kept to a minimum.

6.1.6 One sentence, one command

One sentence shall contain one command only, or at most a small number of closely related commands.

6.1.7 Rules for simple wording

The text of instructions for use shall be written in simple, clear, direct phrases within short sentences, thus following the principle “One expression, one simple meaning”. The logical structure of the text shall be clear.

Abbreviations and acronyms shall be avoided unless it can be assumed that they will be familiar to the intended users or the terms are explained when they first appear in the instructions for use.

The examples in Table 1 should be observed independent of the language used.

Note Translators of this part of the International Standard may substitute examples of effective wording in Table 1 in the language into which translation is being made.

Table 1 – Writing style examples

Recommendation Preferred Not preferred

Use the active voice of verbs rather than the passive Turn off power Be sure that the power has been disconnected

Be assertive in using commands rather than weaker forms

Do not remove tabs The tabs should not be removed

Phrase directions around action verbs rather than abstract nouns

Use, maintain, avoid Utilization, maintenance, avoidance

Speak directly to users rather than saying what they might do

Pull black lever towards you

Users will pull the black lever away from the machine

Avoid double negatives There will always be some leakage.

Fit only 3 A fuses

There will never be any leakage.

Fit no fuses other than 3 A

Avoid easily confused words (particularly with prefixes that look and sound alike)

Flammable contents

High(/low) sensitivity

Inflammable contents

Hyper(/hypo) sensitivity

82079-1 Ed.1 © IEC:2009 – 33 – 82079-1 Ed.1 © CEI:2009

6.1.8 Standardized signs and graphical symbols

Where appropriate, the use of standardized safety signs in ISO 7010 or graphical symbols for use on equipment in IEC 60417 and ISO 7000 shall be considered in order to convey important messages such as warnings.

6.1.9 Ergonomic principles

Instructions for use presented using electronic media, for example, on-line or on-screen documentation, shall fulfil ergonomic requirements as stated in ISO 9241 series.

6.1.10 Keeping the attention of the readers

If the readers find expressions that irritate them, they will be distracted from processing the information. At worst they may discontinue reading or disregard the whole text.

Disrespectful, prejudiced or patronising expressions, assumptions or stereotypes should be avoided, for example, those relating to older people, users with particular disabilities, gender-role stereotypes or assumptions about family/household structures.

Excessive warnings are not helpful in holding the attention of the readers. As far as possible warnings should be phrased so that they relate to events or errors users can foresee. For example instead of “Do not immerse toaster in water” advise “Keep internal parts dry when cleaning.”

Marketing and advertising messages (for example, unnecessarily repeating or emphasising brand names) shall not intrude into instructions for use.

Necessary statements in legal terms for example statements relating to liability shall be clearly distinguished from and kept separate within instructions for use. They shall be written in a way that allows the users to follow the meaning and intent of these statements.

6.1.11 Proof reading

Instructions for use shall be proof-read by persons other than the writer or translator, preferably a native speaker, with knowledge of the product in question.

The assessment criteria are:

• wording according to editorial style guide;

• correct spelling and punctuation;

• correct grammar;

• consistency of terms.

6.2 Legibility

6.2.1 Text font sizes and graphical symbol heights

Text fonts and graphical symbols used for information integrated in the product, of printed material and of computerized information shall be as clear and as large as practicable to ensure the best possible legibility for all users, including older users and users with visual impairment.

Recommended minimum text font sizes and graphical symbol heights are listed in Table 2.

82079-1 Ed.1 © IEC:2009 – 34 – 82079-1 Ed.1 © CEI:2009 The best possible legibility is achieved when optimizing the relation of at least four variables including: type font, type size, number of characters per line (approximately 70 in Latin characters) and line spacing (minimum 120 % of type size in Latin characters).

Measures used to create emphasis shall be considered carefully so as not to reduce legibility. Bold letters, underlining, and if applicable, upper case and italic letters may be used to emphasize single words and phrases, but not to emphasize whole paragraphs or sections.

Where instructions for use present any of the text in a font size smaller than 10 point, or the legibility is reduced by other factors, such as low contrast, the supplier shall provide a larger printed version upon request free of charge.

For the benefit of consumers who are visually impaired, suppliers should offer options of access to all information in large print versions, and alternative media, for example, audio files or plain text files which can be read using Braille.

Table 2 – Minimum recommended text font sizes and graphical symbol heights (to be continued)

NOTE The term "point" (abbreviated here to "pt") is a unit of measurement of type sizes and spacing. There are several kinds of standards. However, "DTP point" is adopted in this part of the International Standard which is 0.353 mm or 1/72 inches.

Product/ instruction document

size

Location and role of instruction

High contrast

dark text on light

background

Low contrast colours or

white on black

Complex character sets (for example

Kanji)

Other remarks Graphical symbols including safety

signs

Symbols generally

Safety signs

Instructions for use viewed from up to 1 m distance on floor-standing products

Critical on-product markings

14 pt bold

BEFPR 68.39l,0 QGOC aeocld

16 pt bold

BEFPR 6.83l,0_QGOC aeocld

Consider using large print fonts specially developed to help people with visual impairments to read signs and labels at 30 cm to 100 cm

As required by standards/regulations

Otherwise according to viewing distance from which attention needs to be attracted or the symbol needs to be recognised.

Less than 15 mm height unlikely to be sufficient for critical on-product markings

text 14 pt 16 pt

Manuals, single-fold leaflets, & desk-top products


14 pt bold


Headings, warning phrases, decimals

12 pt


Serif fonts may be used. 5 mm min

height (or 14 pt)

10 mm min height

continuous text

10 pt

12 pt Do not use graphical symbols in continuous text

82079-1 Ed.1 © IEC:2009 – 35 – 82079-1 Ed.1 © CEI:2009

Table 2 – Minimum recommended text font sizes and graphical symbol heights (continued)

Product/

instruction document

size

Location and role of instruction

High contrast

dark text on light

background

Low contrast colours or

white on black

Complex character sets (for example

Kanji)

Other remarks Graphical symbols including safety

signs

Hand-held products & multi-fold instruction sheets


12 pt

5 mm min height

10 mm min height

Headings, warning phrases, decimals

10 pt


12 pt

BEFPR 68.39l,0 QGOC_ aeocld_

Use only sans serif fonts at this level and below.

pref min 5 mm;

4mm/12 pt if very simple

10 mm min height except*:

continuous text

9 pt BEFPR 68.39l,0 QGOC aeocld

Not advised for text smaller than 12 pt

9 pt with 150 % line spacing

電気

規格

ELECTRONIC, AUDIO, OR LARGE PRINT MEDIA SHALL BE AVAILABLE ON DEMAND

(for example from web site or point of sale)

Do not use graphical symbols in continuous text

Very small products and packaging (for example, printable surface < 10 cm2)

Markings, headings, warning phrases, decimals


pref min 5 mm;

3 mm if very simple

10 mm min height*

continuous text


Do not use graphical symbols in continuous text

*except the general warning sign (ISO 7010-W001) accompanying text warning, which may be 5 mm minimum as a marking and 3 mm minimum in headings to text.

82079-1 Ed.1 © IEC:2009 – 36 – 82079-1 Ed.1 © CEI:2009

6.2.2 Maximum brightness contrast

For printed or engraved instructions for use, the brightness contrast (ratio of reflectance of the bright part over reflectance of the dark part) shall be as high as possible.

Contrast requirements for text displayed on visual display terminals shall be in accordance with ISO 9241-300.

6.2.3 Legibility standards

National standards may contain detailed information and specifications relating to legibility, and especially on the relation between type size and reading distance. These should be consulted and considered when producing instructions for use.

6.2.4 Layout

The layout shall make it easy to distinguish the various elements of information. The text block should have appropriate proportions and make effective use of white space.

The layout shall facilitate differentiation between the various types of information to be communicated, for example:

• subject (heading);

• description;

• action;

• warning.

6.2.5 Instructions for use on surfaces of products or packaging

The location of on-product instructions for use and the angle between their surface and the vertical plane shall be such that they can be easily read and understood by users from their position(s) during use of the product.

Instructions for use on packaging should be visible and legible when the package is in the upright position.

The advantages in terms of durability and production of incorporating instructions for use in the material of the product should be weighed against the disadvantages of loss of contrast and legibility. Incorporating instructions for use in the material of the product generally produces an inferior result to that of good quality printing (See also 6.8.4 on the permanence and visibility of warning messages).

6.3 Illustrations and supporting text

6.3.1 Quality

Attention shall be paid to quality and clarity of illustrations, and to choosing where photographs, line drawings or CAD-generated are most informative. Information in illustrations should complement information presented in other forms and be comprehensible. Illustrations should not be overloaded with information. Visual representations of complex or specific information need to be selective in what detail they show (for example. cross-sections, exploded views, conceptual diagrams and cartoon strips).

In contrast to graphical symbols and safety signs, which should be designed for immediate recognition at a distance, illustrations should be composed so as to focus attention on important details and to be self-explanatory. Illustrations should be chosen or designed individually for each purpose by a competent graphic artist or technical illustrator.

82079-1 Ed.1 © IEC:2009 – 37 – 82079-1 Ed.1 © CEI:2009

Whenever appropriate, text and illustrations shall be used together, each supporting the other to make the instructions for use more comprehensible. Information in illustrations and supporting text should be identical and clear. A sequence of illustrations should be logical and comprehensible. Illustrations shall be comprehensible at the expected viewing distance.

In addition to the recommendations in 4.8.3.1, illustrations which fold out, may be placed on pages of the leaflet or manual, so that they can be seen adjacent to different pages of text at different times.

6.3.2 Following a sequence of operations

If a sequence of operations is being described, text and illustrations shall follow the same sequence. Illustrations shall be placed as close as possible to the text to which they relate, so that they can be viewed adjacent to the relevant text.

6.3.3 Illustration with captions

Illustrations should be supplemented with captions providing written details. There shall be a clear relationship between the illustration(s) and the caption text. The caption should be numbered for clear reference from the main text.

6.3.4 One illustration, one item of information

Illustrations should normally provide only information relevant to describing the related function. Illustrations or detailed part(s) of these should be repeated in the relevant part(s) of instructions for use as needed to assist the user. Information overload in illustrations shall be avoided.

However, where proliferation of illustrations would be cumbersome, several items of information may be presented in a single illustration if this will be easier to understand.

6.4 Graphical symbols, including safety signs

6.4.1 Graphical symbols for use on equipment, including safety signs

Graphical symbols shall comply with internationally recognized standards, for example ISO 7010, IEC 60417 and ISO 7000.

6.4.2 Explanation of graphical symbols

Graphical symbols, pictograms, markings and pictorial symbols placed on the product itself or in accompanying materials shall be explained in the instructions for use.

6.4.3 Graphical symbols for diagrams

Graphical symbols for diagrams shall comply with internationally recognized standards, for example IEC 60617 and ISO 14617.

6.4.4 Minimum sizes of graphical symbols

Minimum sizes for graphical symbols in different situations are listed in Table 2. They should be complied with unless smaller sizes are unavoidable because of the dimensions of the product.

6.5 Use of tables

Tables are frequently used in instructions for use in order to present the information to the user in a more convenient form. Tables shall be presented next to the relevant text.

82079-1 Ed.1 © IEC:2009 – 38 – 82079-1 Ed.1 © CEI:2009

Tables are useful for different purposes, for example, for referencing and troubleshooting. They shall be set out clearly, informatively, presented in a consistent design and be repeated when necessary.

6.6 Use of appropriate document types

Instructions for use should use those document types which suit best the intended purpose. An overview of established document types is given in IEC 61355. Existing document types for plants, systems and equipment shall be used.

Examples:

• If a specific sequence of operations needs to be documented for a safe and correct use of a product, it is recommended that a flow chart is used.

• If a specific safety function of a product needs to be documented, it is recommended that a circuit diagram is used and the related circuitry is highlighted.

6.7 Use of electronic media

6.7.1 General

Electronic media are any modes of communication that can be used to convey the contents of documentation in the form of on-screen displays and/or audibly. These include:

• audio sources;

• video sources;

• combined video and audio sources;

• printable versions of documents which are made readable on-screen through a file exchange format in which the layout matches that of the printed version;

• interactive multimedia applications that combine static elements, for example text, images, with dynamic elements, for example video, audio, animations, dynamic symbols, spoken language. They may operate at the same time and users can control them interactively;

• on-line context sensitive help systems. These may contain elements of interactive multimedia applications as described above. Furthermore they can offer numerous access and search options;

• web-based collaboration applications (like blogs and wikis) which support the creation of content by a virtual team or community.

Instructions for use delivered via electronic media shall take maximum advantage of the chosen media. However, like printed instructions for use, they shall be readily comprehensible by users and follow the requirements of this part of the International Standard (for example, concerning languages, legibility and illustrations).

Accessibility is an important consideration for instructions for use. Care shall be taken to ensure that all users can obtain the information they need. Electronic media should use a medium which would allow the addressing of the widest possible audience, but shall focus on the user, be easy to use and promote comprehension. For example, audio and video or multimedia DVDs should provide a range of sound tracks and sub-title options including a sign language feature for consumers with a hearing impairment and audio description for those with sight impairment.

The Internet potentially offers access to information for users with the greatest range of individual needs, but it is important that barriers to access are not inadvertently introduced by, for example, difficult methods of navigation or use of animations requiring special software. Therefore, when any part of the instructions for use or related information is made available on the Internet, both the presentation of it and all necessary navigation to it should conform to

82079-1 Ed.1 © IEC:2009 – 39 – 82079-1 Ed.1 © CEI:2009

the Web Content Accessibility Guidelines (WCAG) recommended by the World Wide Web Consortium (W3C®).

Where instructions for use are provided ONLY electronically (that is, with no print version available) this shall be clearly indicated at the point of sale and on the packaging, together with the media format and the type of player required to access the instructions for use (for example, personal computers, CD audio or DVD video players).

NOTE Legal regulations may require printed instructions to accompany some products.

6.7.2 Didactic Requirements

The didactic advantages of electronic media compared to print media should be fully utilized for the achievement of better communication results. However care should be taken that users are not overwhelmed by the duration, information density or complexity of electronic sequences.

Therefore:

• instructions in electronic media shall follow the order of activities that the user has to perform;

• if complex processes are to be explained, for example, difficult maintenance and repair tasks, a sequence of suitable visual and auditory elements can facilitate the understanding of the user;

• the requirement for conveying safety-related information in electronic media, particularly in multimedia applications, shall be the same as for printed media (see 6.8).

Animation sequences may enable the amount of other visual information to be reduced to the basic features needed. Animation sequences shall have synchronized spoken accompaniment or written text.

If advertising or promotional content is included in electronic media, it shall be kept clearly separate from the instructions for use, and viewing of such content shall not be required prior to viewing the instructions for use.

6.7.3 Requirements for downloadable instructions for use Instructions for use in electronic media shall be provided in a form that allows downloading and display without further changes on commonly used computer platforms. Therefore:

• the web site shall allow the download of the electronic media at any time;

• the web site shall provide either the software needed, or a link for download of the required viewing software.

Electronic media shall be conceived and executed in a manner that allows them to be displayed without further changes on commonly used computer platforms. Therefore:

• the method of distribution shall ensure the ability to access the electronic media from the computer platform at any time;

• the computer platform shall be provided with software needed to permit viewing the electronic medium;

• the supplier shall guarantee the availability of any proprietary viewer/player necessary to access instructions for use supplied on electronic media.

82079-1 Ed.1 © IEC:2009 – 40 – 82079-1 Ed.1 © CEI:2009

6.7.4 Requirements for user interaction

Electronic media applications shall take advantage of dynamic navigation and presentation devices to facilitate rapid location, comprehension and, where appropriate, printing of necessary information. Therefore:

• electronic media applications shall provide a (preferably tree-like) navigation system that facilitates free user movement within the application, as well as access to all individual portions of the application. Points of reference shall facilitate constant user orientation, and make it possible to return to fixed starting points at any time;

• appropriate navigation elements such as menus, buttons, hyperlinks, breadcrumbs and bookmarks shall be provided to enable user orientation and interaction with the system. Furthermore, so called hot spots, that is, areas for interaction, may serve as entry points for submenus;

• especially for on-line help applications, but also for other advanced multimedia applications, access to topics may be realized using electronic search functions. The most important of these are tables of contents, keyword searches, full text searches, natural-language searches and catchword searches;

• to maintain layout clarity for extensive sections of text, texts should be embedded behind clickable subheadings (hot spots). When required, the user can activate these and display or hide individual sections;

• print functions may be provided with electronic printable versions of documents as well as on-line help applications. Printable versions shall adapt or exclude multi-media applications and dynamic web page elements that printed pages cannot represent;

• how to use software shall, as far as possible, be integrated into the user interface. Where integration is not possible, for example, because of the extent of the information, access shall be directly available, for example, via a help button.

6.8 Making safety-related information prominent and conspicuous

6.8.1 Making text conspicuous

Safety related information shall be emphasized by use of larger and/or different type font or size (see 6.2.1), by use of colours (see 6.9), safety signs and graphical symbols (see 6.4) or other means of making it conspicuous.

6.8.2 Making illustrations conspicuous

Illustrations within safety-related information shall be emphasized by use of colours, shapes, positioning (see 6.3) or other means of making them conspicuous.

Packaging and containers with hazardous contents may require tactile danger warnings in accordance with ISO 11683 if there is a possibility that the contents will be mistakenly misused by people unable to see a visual warning.

6.8.3 Design of warning messages

Warning messages shall be designed consistently and shall be made conspicuous and prominent. In the formulation and design of warning notices, the following shall be taken into account in order to achieve maximum effectiveness:

• start with signal words (see 6.8.6);

• limit the text and/or illustrations to the essentials;

• make the location, content and style of the warning messages conspicuous in accordance with 6.2;

• ensure that the warning messages is visible to the user and to any other people exposed to hazards, from their position during use (see also 6.2.5), and at the right time;

82079-1 Ed.1 © IEC:2009 – 41 – 82079-1 Ed.1 © CEI:2009

• explain the nature of a hazard and, if appropriate, its causes;

• provide clear guidance on how to avoid a particular hazard;

• place warning messages as determined by the risk assessment. Warning messages repeated too frequently may reduce their effectiveness;

• state the probable consequences of not avoiding the hazard without playing down the consequences.

6.8.4 Permanence and visibility

Warning messages for special hazards leading to an increased risk when the instructions for safe use have not been followed shall continue to be clearly visible to users during the life of the product. When colours are used in warning messages, discoloration and fading shall be taken into account.

6.8.5 Making warning messages prominent

Warning messages about hazards or restrictions on use (for example NOT SUITABLE FOR CHILDREN UNDER THREE YEARS OF AGE) are crucial for safety and shall be given prominence at least equal to other instructions in documents issued with the product.

6.8.6 Signal words

Warning messages shall always draw attention to themselves. If using signal words, the following shall be used as appropriate. These are set out in ISO 3864-2.

DANGER: the signal word that indicates a hazard with a high level of risk which, if not avoided, will result in death or serious injury,

WARNING: the signal word that indicates a hazard with a medium level of risk which, if not avoided, could result in death or serious injury, and

CAUTION: the signal word that indicates a hazard with a low level of risk which, if not avoided, could result in minor or moderate injury.

The general warning sign as in ISO 3864-2 composed of an equilateral triangle surrounding an exclamation mark in specified safety colours as in ISO 3864 should precede the signal words DANGER, WARNING or CAUTION.

6.9 Colours

6.9.1 Consistency

The use of colours shall be consistent, in addition to being functional and systematic. Any safety signs in instructions for use shall conform to requirements, including colours, specified in the ISO 3864 series.

6.9.2 Colour perception considerations

It should be kept in mind, that a sizeable percentage of users have some form of colour-deficient vision. Therefore, information shall not be presented by the use of colour only; colour is an additional means for the presentation of instructions for use and for the improvement of understanding.

6.9.3 Photocopying/printing considerations

When selecting colours, care shall be taken to select contrasting colours which will remain distinct even after black and white photocopying or printing on a monochrome printer.

82079-1 Ed.1 © IEC:2009 – 42 – 82079-1 Ed.1 © CEI:2009

7 Evaluation of conformance to this part of the International Standard

7.1 Claiming conformance to this part of the International Standard

Claims of conformity to this part of the International Standard shall be dependent upon the supplier maintaining the availability of evidence that the instructions for use (including safety information) have been evaluated either by expert desk research or by an empirical evaluation, for example, a usability test, following the requirements and guidance in Annexes A, B and C.

The checklist in Annex B lists types and items of information content that may (depending on the type of product) need to be supplied to some or all users by means of the instructions for use. Conformance could be indicated by items being ticked off one by one if they have been adequately covered.

The checklist in Annex C summarizes the criteria against which to evaluate the effectiveness of instructions for use in communicating the information to consumers and predicting their effectiveness in influencing user behaviour. For most products 100 % effectiveness of instructions for use can neither be achieved nor be measured qualitatively, and so in practice assessment shall be based on subjective judgements. The checklist may also be used as a guide to criticizing items in the instructions for use that are shown not to be effective, rather than just a list of criteria against which to award marks to the document as a whole. Constructive criticism needs to be very specific about the section in need of improvement and the reasons why it is not considered to be effective (and preferably how it could be revised to become effective).

Neither checklist should be assumed to be comprehensive for every type of product. They may need to be supplemented and/or amended in accordance with relevant product standards or (in the absence of such standards) in accordance with standards dealing with comparable products or functions, or in any other appropriate way.

Where a regime of independent certification of conformance is required (whether by legislation, product standards or contractual specification), independent certificates shall state:

• what documentary evidence (that is, research reports or evaluation reports) was submitted by the supplier after the instructions for use were assessed;

• whether the evidence referred to the above bullet was based on expert desk research or empirical evaluation;

• the name of the body or person who made these assessments.

7.2 Documentary evidence of evaluation

Research reports or evaluation reports shall state:

• what instructions for use and retail packaging were submitted for examination;

• the language of the instructions for use which was assessed and approved in compliance with this part of the International Standard;

• whether the product sample was supplied fully assembled or was assembled as part of the assessment of the instructions for use;

• which aspects of the assessment were based on expert desk research and which on an empirical evaluation;

• the name of the body or person(s) who made the assessment;

• the name of the body or person(s) responsible for checking and verifying each translation.

No claim of compliance to this part of the International Standard shall be made unless the instructions for use have been evaluated by suitably qualified experts. These experts shall not

82079-1 Ed.1 © IEC:2009 – 43 – 82079-1 Ed.1 © CEI:2009

have been previously involved in the writing of the instructions for use or in the development, design, production or marketing for the product in question. See also Annex A.

NOTE Depending upon the complexity of the product and the extent to which safe and correct use depends on conveying information to the user, instructions for use may need to be evaluated during the development stage and/or there may be a need for internal evaluations and revisions of draft instructions for use to optimise them before they are submitted to a third party for evaluation.

82079-1 Ed.1 © IEC:2009 – 44 – 82079-1 Ed.1 © CEI:2009

Annex A (Normative)

Evaluation of instructions for use

A.1 General

Instructions for use should be evaluated in accordance with the following criteria.

A.2 Choice of methodologies for evaluation

Depending upon the complexity of the product and the importance of conveying relevant information to the user in order to ensure safe and correct use, assessment should take the form of:

• desk research by experts outside the product development team;

• interactive empirical evaluation of the instructions for use by a panel covering the range of potential users;

• a combination of both.

A.2.1 Desk research by experts

Only suitable qualified experts who have no connection with any aspect of the design, production, or marketing of the product and its instructions for use may carry out assessment by desk research.

The actual product (and preferably packaging) shall be available to the researcher or independent evaluator, not just the instructional media.

Comprehensiveness checks should be carried out preferable using the checklist in Annex B.

Effectiveness checks should be carried out preferable using the checklist in Annex C.

It may be necessary for desk research to be supplemented by independent third-party checking; for example, where provision of information at the point of sale is a requirement.

The effectiveness of each translation shall be proofread and evaluated for comprehensibility and linguistic accuracy using the relevant criteria listed in the checklist in Annex C as a guide for comments.

A.2.2 Empirical evaluation by potential users

See Annex E for guidance on empirical methods.

82079-1 Ed.1 © IEC:2009 – 45 – 82079-1 Ed.1 © CEI:2009

Annex B (Informative)

Checklist for conformity and comments

NOTE This checklist should not be considered to be comprehensive.

Items to be checked Relevant clause

Compliance Comments

1. Identification

1.1 Brand and type designation 5.2

1.2 No. of model, version, type, subgroup

1.3 Expiry date

1.4 Up-to-date check / for example. date of publication of the handbook coverage of product modifications

1.5 Supplier or other information 5.2

1.6 Contact details. of supplier/service agency 5.2

1.7 Certification references

1.8 Requirements of specific product standards 5.2

1.9 Optional modules/extras 4.8

2. Technical specification of the product and its residual hazards

2.1 Functions and range of application 5.2

2.2 Safe and correct use; principal residual hazards, general warnings about product or use

5.4

2.3 Dimensions — mass — capacity 5.2

2.4 Chemical composition 5.2

2.5 Performance data 5.2

2.6 Supply data for power, gas, water and other consumables (for example. detergents, lubricants)

5.2

2.7 Energy consumption and methods of measurement used 5.2

2.8 Emission of noise, waste water, etc., with methods of measurement used

5.2

2.9 Expected product life and intended disposal

2.10

Information on personal protection (for example. clothing) 5.4

2.11

Information on dangers to particular vulnerable groups (for example. potential allergy or strobe effects)

5.4

3. Preparing the product for use 4.7

3.1 Safety precautions before installation

3.2 Unpacking

3.3 Safe disposal of packaging

3 4 Installation and assembly (for example. special tools, space for maintenance and repair)

3 5 Storage and protection during intervals in normal use

3.6 Repackaging to prevent damage in transport

3.7 Information on operations to be carried out only by skilled persons. Separation of this information from instructions for use to users. Comprehensiveness of instructions for use to qualified people

82079-1 Ed.1 © IEC:2009 – 46 – 82079-1 Ed.1 © CEI:2009


Compliance Comments

4. Operation of products 5.8

— structure from basic to sophisticated operations/functions

— meaningful separation between basic product and optional modules

4.1 Basic functions

— Complete for correct intended use

— Complete for safe intended use

— Complete for reasonably foreseeable misuse

— Conformity with minimum list in relevant product standard(s)

4.2 Secondary functions(identical to 4.1 above)

4.3 Optional modules and extras

4.4 Personal protection

4.5 Quick references

— by reminder cards, stickers or labels

— by reference to handbook, etc.

4.6 Disposal of waste products

5. Information needed by user

Explanations of visible and audible signals 4.8.2.4

Distinctions between characteristics of normal and faulty/dangerous operation

5.8

Trouble-shooting advice (for example. in the form of Frequently Asked Questions and fault detection procedures) – intelligible to consumers and paying due regard to safety

5.8

6. Maintenance and cleaning 5.9

6.1 Safety precautions (for example. personal protection, special tools)

6.2 Maintenance and cleaning by users

6.3 Maintenance and cleaning by skilled persons

6.4 Safety/deterioration checks during maintenance

7. Critical safety and health information 5.4

7.1 Safety warnings/cautions

— correct locations (for example. to alert, remind, etc)

on product and/or

on packaging and/or

in accompanying material

— if relevant, visibility at point of sale

— correct use of terms

— use of simple/standardized phrases

— durability of warnings

— conformity with requirements in relevant product standard(s)

7.2 Safety signals

7.3 Information on residual risk

7.4 Safe disposal of product at the end of its useful life

7.5 Environmental impacts of using the product

82079-1 Ed.1 © IEC:2009 – 47 – 82079-1 Ed.1 © CEI:2009


Compliance Comments

8. Consistency in design of information and of whole ‘product’ offered

8.1 Integrated design of product and instructions for use - No compensation for design deficiencies

8.2 Consistent terminology on the product itself; on the packaging; in accompanying material, on Web site resources and in marketing media (see clauses 6.2 and 6.3)

8.3 Structure of text and graphics 6.1

— structure follows communication principles

— meaningful headings used

— unnecessary material excluded to avoid information overload (for example. sales promotion, extensive repetition, too many documents)

8.4 Location(s) and presentation of instructions for use

8.5 Numbered pages and/or paragraphs, with table of contents and/or index appropriate to length and complexity of text. Use of keywords

82079-1 Ed.1 © IEC:2009 – 48 – 82079-1 Ed.1 © CEI:2009

Annex C (Informative)

Checklist for communication effectiveness

This list offers criteria for subjectively evaluating each individual item in the instructions for use being assessed – e.g. each on-product warning, each paragraph in leaflets and each graphic. It is only necessary to record comments on those items or sections considered to be in need of improvement. The evaluations should be listed giving the reasons why the item is not considered to be effective (and preferably how it could be altered to become effective).

Issues that may need to be addressed Relevant clause Evaluation Comments

1. Target groups

Target group/s specified

Instructions for use adequately presented for target Group/s

Conventions: How to read this document

2. Location and medium

Placement on product, on packaging or in accompanying media meets needs of availability and durability

4.7

Alerting function is appropriate to user’s needs (prominence/ visibility distance, etc )

Place in order or sequence with respect to other information following communication principles

6.1

Grouped under appropriate heading and found in index??

3. Legibility of text 6.2

Clear typeface and adequate font size (depending on reading distance)

Line length and line spacing

Contrast with background

Durability of legibility of on-product (or on-packaging) text

4. Wording and structure of text 6

Text/use of words

— words and phrases not complicated or over-sophisticated

— short phrases

— one sentence-one command. Not too much information in one sentence

— direct active voice and assertive commands

Terms used for features and user actions

— terms familiar to consumers used if possible

— technical features and terms well explained

— consistent use of terms

Communication principles

— encouraging quick reactions (for example. simple and easy information for an emergency)

— setting out learning process for complex functions

— answering the questions WHERE? WHO? WHAT? WHEN?

82079-1 Ed.1 © IEC:2009 – 49 – 82079-1 Ed.1 © CEI:2009


HOW? WHY?

5. Multiple language variants 4.8.3

Clear differentiation/ identification of languages

Each language version checked by a native speaker for comprehensibility and absence of linguistic errors

6. Illustrations 6.3

Clarity of features and actions illustrated at intended viewing distance

(lack of ambiguity; self-explanatory without text whenever possible)

Sufficient number of illustrations for each one to provide clear and specific information

Illustrations supported by clear and helpful captions

Clear connections or cross-references between text and illustrations

Can be viewed adjacent to relevant text when necessary

7. Use of graphical symbols 6.4

Adequate size to be comprehensible at intended viewing distance

Standardized symbols used where possible (in standard colours)

Standard design principles (for example. shape and colour) followed for any new symbols

Each symbol clearly explained in text

Durability of on-product (or on-packaging) symbols

8. Tables, conceptual diagrams and flow charts 6.5,6.6

Provided and located where appropriate

Clearly set out and informative

Repeated where necessary

9. Use of colours 6.9

Functional

Clear and easily distinguishable

Consistent

10.

Explanation of visual and audible signals 4.8.2.4

Clarity of information provided to users

Lights, sounds, text displays (or other indications) that may be given by the product at each stage are explained and referred to at each relevant point in the text

11.

Instructions for use presented in audio, video or animated text

6.7

Indicate whether supplementing or replacing instructions for use in text

Follow structure and language of text except when this is unsuitable to medium

Offer multi-lingual and text/audio options

82079-1 Ed.1 © IEC:2009 – 50 – 82079-1 Ed.1 © CEI:2009


12.

Durability 4.7

Those items of instructions for use that need to be kept for reference or new users should be in media that offer adequate provision against loss or deterioration in expected (normal) life of product and discouragement of their disposal.

82079-1 Ed.1 © IEC:2009 – 51 – 82079-1 Ed.1 © CEI:2009

Annex D (Informative)

Planning the preparation of instructions for use

D.1 General

This Annex provides guidance on planning the preparation of instructions for use. This guidance is based on an example of a plan that includes typical procedures for preparing instructions for use from conception to publication, and is composed of the three phases planning, development and optimisation.

D.2 Restrictions on planning the preparation

The time, resources and priority accorded to the preparation of instructions for use can affect the quality and effectiveness of the information provided for users (for example, if planning is not begun until the product is being manufactured, or the writers are untrained or evaluation is simply a rubber stamping exercise). It is the responsibility of Senior Management to arrange the resources, time plans and quality targets so as to enable the planning, preparation and delivery of effective instructions for use.

a) Senior Management should ensure that the development of instructions for use is

considered in parallel with the development of product design and marketing, so that (for example):

• the choice of medium /media to be used to convey instructions for use is made early in the

design process (see 4.7.3);

• detailed lists of the specific content that will need to be included (instructions, warnings and user information – see section 5) can be compiled throughout the development of the product;

• locations where on-product information will need to be presented should be allowed for in the exterior design and surface styling of the product and packaging (see 6.2.5);

b) Senior Management should arrange availability (through combination of staff resources and access to external consultants) of all the skills and experience necessary to prepare instructions for use.

Depending on the product, these may include: • technical document writing;

• human error/ergonomics expertise;

• graphic art creation;

• design/creation of electronic instructional media;

• thorough understanding of the product’s development and intended functions;

• scientific/technical knowledge and experience necessary to analyse hazards and anticipate damage, wear and faults likely to develop during use;

• legal compliance and product liability expertise;

• technical translation competence for each language intended to be used.

82079-1 Ed.1 © IEC:2009 – 52 – 82079-1 Ed.1 © CEI:2009

A writer who is initially unfamiliar with the product but familiar with the language needs of the target group will be in the best position to take into account the needs of first time users.

c) Senior Management should decide (at an early stage) the method of evaluating the draft instructions for use and the agency or individuals who will undertake it, so that sufficient time can be planned for this without delaying production, packaging or meeting legal and contractual requirements.

D.3 Planning preparation in detail (example)

A single example cannot give comprehensive information covering all possible requirements, therefore each step listed here has to be checked against the appropriate requirement depending on complexity, risk, legal issues, etc. This example is for a fairly large scale and comprehensive project, it may nevertheless prove helpful to writers of instructions for simpler products by illustrating the range of processes that may need to be planned.

During the process of creating instructions for use several steps should be considered. The following describes steps which can help ensure that instructions for use are well thought out and provide users with the information they require. The steps described here are intended to be adapted and completed according to the requirements of the party responsible for the development of the instructions for use.

a) Analyses, define general conditions

To meet all requirements and ensure that instructions for use are fit for purpose, relevant sources, such as legal requirements, contracts and standards should be investigated. This will provide the basis for the preparation of a list of requirements which the instructions for use shall satisfy. The following should be analysed:

• the product to which the instructions for use relate: aim and function of the product, similar products and their instructions for use, structure of the product, residual risks (from risk assessment), possible problems and troubleshooting, spare parts and options, compliance and conformity, product life;

• the proposed market in which the product is going to be used: attributes of the market, channels of distribution of the product;

• all legal and normative requirements for all markets, which have to be fulfilled. Usually the legal and normative documents which apply to the product will be known to the product developer;

• the relevant target groups: Intended users of the instructions for use, and other persons who are going to be instructed in the use of the product in question.

After completing the above analyses a detailed list of requirements should be drawn up before beginning the preparation of documentation.

b) Planning and project management

The development of instructions for use requires special project management and project communication. Tasks, responsibilities, authorization and milestones should clearly be defined. An editorial deadline may be helpful to ensure that all relevant information is provided in time.

c) Conceptual design

Instructions for use should be developed on the basis of a well planned concept. A concept is needed to assure consistency and accessibility of the information.

Components of a conceptual design are, but are not restricted to:

• guidelines and definition of the intended information quality;

82079-1 Ed.1 © IEC:2009 – 53 – 82079-1 Ed.1 © CEI:2009

• type and structure of the documents to give the user an optimal access to the information;

• combination of more than one document, if applicable;

• use of text, types of visualization and the coordination of text and visualization;

• media concept;

• media-specific layout and navigation;

• information types (for example. action sequence, component description, screen description, maintenance plan, trouble shooting table, safety note, warning message) and their communication patterns (definition, structure, phrasing and authoring rules);

• if the instructions for use are made up of information modules: description and types of modules;

• way of using cross references and links;

• single-source concept if applicable;

• language and general text production rules;

• terminology and its use in the instructions for use;

• glossary and index, where terminology is of outstanding importance;

• globalization and internationalization, preparation for translation and localization.

The concept should be defined and well explained with worked-out and tested examples in an in-house style guide. Especially if the instructions for use are to be produced by a team of technical writers and/or over a longer period of time, a style guide and corresponding training for the technical writers is necessary to assure quality and consistency. The style guide should be presented in a form which makes it easy to use during editing and writing.

Usually a concept is defined for a series of instructions for use. The concept itself should be periodically improved.

d) Instructions for use as a part of a product

The development of instructions for use is an integral part of the development and construction of the product.

Especially with respect to safety, the developer of instructions for use should be involved in the risk assessment to make clear the limits of instructions for use, to work out the need for constructional safety, and to get an optimal interplay of the means of construction, for example, inherent safety, safety devices, safety equipment, user interface design, and information such as warning messages, safety notes, training, packaging.

All available sources of feedback from users should be searched for indications of shortcomings in instructions for use supplied with previous similar products, for example, customer complaints, service reports, analyses of causes of accidents and injuries, and reviews of products posted on the Internet.

Wherever skilled persons are required, the text shall state that this is an absolute requirement for safety and/or technical reasons and that no other people shall assemble, operate, maintain or disassemble the machines or item. The qualifications and skills required of the people concerned, are to be clearly stated in the instructions for use or other written documents relevant.

e) Research

Research is a crucial factor in the development of instructions for use. If possible the product should be available for the technical writers to assure correct and adequate instructions for use.

82079-1 Ed.1 © IEC:2009 – 54 – 82079-1 Ed.1 © CEI:2009

Research interviews should be well planned. Interviewed developers should have the necessary resources and enough time to give all information properly.

Product developers should have a duty to deliver information when the product is going to be changed. A proper change process should be put in place so that the instructions for use can be amended when necessary.

It should be made sure that results from surveillance (for example. complaint management, service, and publications) with effect on the instructions for use will be taken into account.

If existing information is going to be re-used this information should be identified. It should be made sure that the information for re-use is applicable. If necessary such information needs adoption.

f) Content creation

Content should be created on the basis of the concept and the research. Chapters and sections should be planned in a table of contents. Every Chapter and section should be assigned to a single information type. Such a plan may serve as a basis for documentation made up of information modules.

Check lists and tools for authoring assistance are helpful to assure correct terminology, phrasing, structure and completeness of information. Authoring tools and editors should support authoring as good as possible.

Early quality control and user tests of draft versions should be performed to reveal and avoid failures at an early stage of the development of the instructions for use.

g) Reviews and Quality control

Instructions for use should be carefully reviewed according to the requirements and the style guide by a person skilled in the area of technical communication or with at least 5 years experience in that area. Enough time should be scheduled for this reading and the following editing.

Reviews for technical correctness should be scheduled and performed.

If the requirements are not met by the instructions for use a decision about further editing is necessary. The intention of no failure should be aimed for.

h) Quality assurance

Empirical evaluation (user testing) should show whether the instructions for use achieve the aim. User testing should be performed in the development of the whole product including the instructions for use. All improvements should be incorporated within the requirements, quality assurance and style guide to gain a continuous advancement in instructions for use quality. Change lists may be used to organize improvement.

i) Translation

In most cases translation cannot be of higher quality than the source text. So a high quality and translation-adequacy of the source text is of paramount importance for the quality and safety of the translated text.

Translation projects should be well planned and managed, including a linguistic and a technical review by persons who have the necessary skills. Appropriate standards for translation services should be taken into account (for example EN 15038).

j) Media production

82079-1 Ed.1 © IEC:2009 – 55 – 82079-1 Ed.1 © CEI:2009

The produced (for example. printed) instructions for use should be usable for the expected life time of the product. Printed instructions for use should be printed on durable paper.

82079-1 Ed.1 © IEC:2009 – 56 – 82079-1 Ed.1 © CEI:2009

Annex E (Informative)

Empirical methods supporting the preparation of instructions for use

E.1 General

A variety of empirical methods can be employed when preparing instructions for use:

• opinion polls (written interviews, oral interviews, focus groups);

• usability testing;

• self assessments and checklists;

• expertise, expert reviews and certification;

• independent award or merit schemes;

• complaints management, hotlines and service information.

E.2 Methods

E.2.1 Opinion polls

Written Interviews Oral Interviews Focus groups

Scope / Objectives • Analysis of satisfaction

• Target group analysis

• Identification of information about use; for example why, where, how often

• Identification of users' needs

• Assessment/evaluation of documentation regarding handling of and working with the instructions for use

• Comparison of different documents

• Small tasks for appliances can be integrated

• Identification of users' needs

• Assessment/evaluation of the documentation regarding handling of and working with the instructions for use

• Comparison of different documents/ documentation styles

Pros • Low-cost

• Geographically broad spread of target groups reachable

• Determination of frequency

• Statistically representative data

• Substantial avoidance of misunderstandings regarding the interpretation of the questions

• Interviewee can make proposals for change

• Background information and explanations possible

• Opposing opinions can be discussed

• The creative potential of the group can create proposals for solutions

• Easy and practical

Cons • Limited integration of examples of the instructions for use

• Only limited explanations and background to the answers

• Questionnaires should be developed by experts

• Time consuming and relatively expensive

• Availability of interviewees may be limited

• Trained person as interviewer needed

• Representativeness of results not always guaranteed

• Pressure of the group can restrict expression and narrow perspectives

• No statistical representativeness

• Only qualitative results

82079-1 Ed.1 © IEC:2009 – 57 – 82079-1 Ed.1 © CEI:2009

E.2.2 Usability-Testing

Scope/Objectives:

• development of new instructions for use/documentation;

• testing of instructions for use/documentation or comparison of different documents and

• testing of comprehensibility and usability.

Pros:

+ reliable results about the usability of a documentation and + weak points are detectable quickly.

Cons

- special laboratory techniques are needed; - statistical representativeness of the results should be proven and - comparatively cost-intensive.

E.2.3 Self Assessments and Checklists

Scope/Objectives:

• assessment of quality according to technical criteria and

• checklists according to standards.

Pros:

+ low-cost; + comparison of different instructions for use with the same criteria possible and + process and changes over time resp. steps for optimizing can be detected.

Cons:

- despite objective assessment criteria, subjective differences in assessment can not be excluded;

- no information ascertainable about customers' wishes and requirements and - know-how needed for development of assessment.

E.2.4 Expertise, Expert reviews and Certification

Scope/Objectives:

• assessment of instructions for use according to defined criteria;

• analysis of weak points and

• arrangements regarding legal disputes.

Pros:

+ expert assessment; + variable range of test criteria; + identification of weak points and + certification of compliance with designated requirements.

Cons:

82079-1 Ed.1 © IEC:2009 – 58 – 82079-1 Ed.1 © CEI:2009

- inability to ensure an objective assessment from a single expert; - comparatively high cost (of comprehensive expertise/certificates); - no compulsory requirement to incorporate suggestions for improvement, and - despite certificate, no release from liability.

E.2.5 Findings from independent award or merit schemes

Scope/Objectives:

• certification of high quality of a product according to generally accepted guidelines and

• competition with other information products

Pros:

+ independent experts; + low-cost and + comparability of assessment results with those of other information products.

Cons:

- criteria checklist is not tailored to a particular question/problem and - does not necessarily reflect the customer's point of view regarding quality.

E.2.6 Feedback from Complaints Management, Hotlines and Service information

Scope/Objectives:

• ongoing improvement process;

• optimization of request handling and

• improvement of the information product.

Pros:

+ ongoing feedback; + information can be used for improvement of instructions for use and + hotline costs can be reduced.

Cons:

- no systematic evaluation according to defined criteria; - no quantitative evaluation regarding how common the problem is and - limited to negative responses due to so-called self-selection of participants.

82079-1 Ed.1 © IEC:2009 – 59 – 82079-1 Ed.1 © CEI:2009

Bibliography

IEC 60073, Basic and safety principles for man-machine interface, marking and identification – Coding principles for indicators and actuators

ISO 7731, Ergonomics – Danger signals for public and work areas – Auditory danger signals ISO 11429, Ergonomics – System of auditory and visual danger and information signals ISO 15006, Road vehicles – Ergonomic aspects of transport information and control systems -

Specifications and compliance procedures for in-vehicle auditory presentation ISO/TR 16352, Road vehicles – Ergonomic aspects of in-vehicle presentation for transport

information and control systems – Warning systems Web Content Accessibility Guidelines (WCAG) 2.0, B. Caldwell, M. Cooper, L. Reid, G.

Vanderheiden, Editors, W3C Recommendation, 11 December 2008

INTERNATIONAL ELECTROTECHNICAL COMMISSION …tc3.iec.ch/meetings/tc3/2010/Seattle/3Se4.pdf ·...

Documents

Transcript of INTERNATIONAL ELECTROTECHNICAL COMMISSION …tc3.iec.ch/meetings/tc3/2010/Seattle/3Se4.pdf ·...