IEC 82079-1:2012

IEC 82079-1


Edition 1.0 2012-08



INTERNATIONAL



STANDARD



NORME
INTERNATIONALE
colour
inside


Preparation of instructions for use – Structuring, content and presentation –
Part 1: General principles and detailed requirements

Établissement des instructions d’utilisation – Structure, contenu
et présentation –
Partie 1: Principes généraux et exigences détaillées


IEC 82079-1:2012

---------------------- Page: 1 ----------------------
THIS PUBLICATION IS COPYRIGHT PROTECTED


Copyright © 2012 IEC, Geneva, Switzerland


All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized in any form

or by any means, electronic or mechanical, including photocopying and microfilm, without permission in writing from
either IEC or IEC's member National Committee in the country of the requester.
If you have any questions about IEC copyright or have an enquiry about obtaining additional rights to this publication,

please contact the address below or your local IEC member National Committee for further information.



Droits de reproduction réservés. Sauf indication contraire, aucune partie de cette publication ne peut être reproduite ni
utilisée sous quelque forme que ce soit et par aucun procédé, électronique ou mécanique, y compris la photocopie et les

microfilms, sans l'accord écrit de la CEI ou du Comité national de la CEI du pays du demandeur.

Si vous avez des questions sur le copyright de la CEI ou si vous désirez obtenir des droits supplémentaires sur cette

publication, utilisez les coordonnées ci-après ou contactez le Comité national de la CEI de votre pays de résidence.

IEC Central Office Tel.: +41 22 919 02 11
3, rue de Varembé Fax: +41 22 919 03 00
CH-1211 Geneva 20 info@iec.ch
Switzerland www.iec.ch

About the IEC
The International Electrotechnical Commission (IEC) is the leading global organization that prepares and publishes
International Standards for all electrical, electronic and related technologies.

About IEC publications
The technical content of IEC publications is kept under constant review by the IEC. Please make sure that you have the
latest edition, a corrigenda or an amendment might have been published.

Useful links:

IEC publications search - www.iec.ch/searchpub Electropedia - www.electropedia.org
The advanced search enables you to find IEC publications The world's leading online dictionary of electronic and
by a variety of criteria (reference number, text, technical electrical terms containing more than 30 000 terms and
committee,…). definitions in English and French, with equivalent terms in
It also gives information on projects, replaced and additional languages. Also known as the International
withdrawn publications. Electrotechnical Vocabulary (IEV) on-line.

IEC Just Published - webstore.iec.ch/justpublished Customer Service Centre - webstore.iec.ch/csc
Stay up to date on all new IEC publications. Just Published If you wish to give us your feedback on this publication
details all new publications released. Available on-line and or need further assistance, please contact the
also once a month by email. Customer Service Centre: csc@iec.ch.


A propos de la CEI
La Commission Electrotechnique Internationale (CEI) est la première organisation mondiale qui élabore et publie des
Normes internationales pour tout ce qui a trait à l'électricité, à l'électronique et aux technologies apparentées.

A propos des publications CEI
Le contenu technique des publications de la CEI est constamment revu. Veuillez vous assurer que vous possédez
l’édition la plus récente, un corrigendum ou amendement peut avoir été publié.


Liens utiles:

Recherche de publications CEI - www.iec.ch/searchpub Electropedia - www.electropedia.org
La recherche avancée vous permet de trouver des Le premier dictionnaire en ligne au monde de termes
publications CEI en utilisant différents critères (numéro de électroniques et électriques. Il contient plus de 30 000
référence, texte, comité d’études,…). termes et définitions en anglais et en français, ainsi que
Elle donne aussi des informations sur les projets et les les termes équivalents dans les langues additionnelles.
publications remplacées ou retirées. Egalement appelé Vocabulaire Electrotechnique
International (VEI) en ligne.
Just Published CEI - webstore.iec.ch/justpublished
Service Clients - webstore.iec.ch/csc
Restez informé sur les nouvelles publications de la CEI.
Just Published détaille les nouvelles publications parues. Si vous désirez nous donner des commentaires sur
Disponible en ligne et aussi une fois par mois par email. cette publication ou si vous avez des questions
contactez-nous: csc@iec.ch.

---------------------- Page: 2 ----------------------
IEC 82079-1





Edition 1.0 2012-08







INTERNATIONAL





STANDARD







NORME



INTERNATIONALE
colour

inside










Preparation of instructions for use – Structuring, content and presentation –

Part 1: General principles and detailed requirements




Établissement des instructions d’utilisation – Structure, contenu

et présentation –

Partie 1: Principes généraux et exigences détaillées
















INTERNATIONAL

ELECTROTECHNICAL

COMMISSION


COMMISSION

ELECTROTECHNIQUE

PRICE CODE
INTERNATIONALE

CODE PRIX XB


ICS 01.110: 29.020 ISBN 978-2-83220-096-4



Warning! Make sure that you obtained this publication from an authorized distributor.

Attention! Veuillez vous assurer que vous avez obtenu cette publication via un distributeur agréé.

---------------------- Page: 3 ----------------------
– 2 – 82079-1 © IEC:2012




CONTENTS


FOREWORD . 6


1 Scope . 8

2 Normative references . 8

3 Terms and definitions . 9

4 Principles . 14

4.1 Provision of instructions for use . 14

4.1.1 General . 14
4.1.2 Instructions for use are part of the product . 14
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 . 15
4.2 Quality of communication . 15
4.3 Minimizing risks . 15
4.4 Target group(s) . 15
4.5 Special precautions . 16
4.6 Short-life products . 16
4.7 Considerations to the nature of instructions for use . 16
4.7.1 General . 16
4.7.2 Location . 16
4.7.3 Means of communication and media . 16
4.7.4 Durability . 17
4.7.5 Availability . 17
4.7.6 Electronic guidance systems . 17
4.7.7 User training . 18
4.8 Creating instructions for use . 18
4.8.1 Conformity with the product . 18
4.8.2 Consideration of needs of target groups . 19
4.8.3 Languages. 20
5 Content of instructions for use . 21
5.1 General . 21
5.2 Identification of instructions for use . 21
5.3 Identification of the product . 21
5.4 Modification of products . 22
5.5 Safety-related information . 22
5.5.1 General . 22
5.5.2 Safety notes . 23
5.5.3 Warning messages . 23
5.5.4 Safety-related information for industrial plants . 24
5.5.5 Safety related information in quick-start guides . 24
5.6 Product compliance . 24
5.7 Importance of retaining instructions for use . 24
5.8 Preparing products for use . 24
5.8.1 Transportation and storage . 24
5.8.2 Installation . 24

---------------------- Page: 4 ----------------------
82079-1 © IEC:2012 – 3 –


5.8.3 Commissioning . 25

5.9 Operation of products . 25

5.9.1 General . 25

5.9.2 Normal operation . 25

5.9.3 Additional information for automatic and remotely controlled products . 25

5.9.4 Indications of faults and warning device signals . 26

5.9.5 Exceptional/emergency situations . 26

5.9.6 Troubleshooting and repair by non-skilled persons . 26

5.9.7 Troubleshooting and repair by skilled persons . 26

5.10 Maintenance of the product . 27

5.10.1 General . 27
5.10.2 Product maintenance by non-skilled persons . 27
5.10.3 Product maintenance by skilled persons . 27
5.10.4 Planned maintenance of industrial plants . 28
5.11 Supplied accessories, consumables and spare parts . 28
5.11.1 Accessories . 28
5.11.2 Consumables. 28
5.11.3 Spare/replacement parts . 28
5.12 Information on special tools, equipment and materials . 29
5.13 Information on repair of products and replacement of parts . 29
5.13.1 Information on repair of products and replacement of parts by non-
skilled persons . 29
5.13.2 Information on repair of products and replacement of parts by skilled
persons . 29
5.14 Information required when the product is no longer needed . 29
5.14.1 General . 29
5.14.2 Disassembly . 29
5.14.3 Recycling . 30
5.14.4 Disposal . 30
5.15 Structure of instruction for use . 30
5.15.1 General . 30
5.15.2 Page numbering . 30
5.15.3 Table of contents . 30
5.15.4 Index . 30
5.15.5 Technical terms, acronyms and abbreviations. 30
5.15.6 Graphical and tactile symbols and tactile dots . 31
5.15.7 Presentational conventions . 31
5.15.8 User controls and indicators . 31
6 Presentation of instructions for use . 31
6.1 Comprehensibility . 31
6.1.1 Recognized communication principles . 31
6.1.2 Style guide . 31
6.1.3 Structure . 32
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 safety signs and graphical symbols . 33
6.1.9 Ergonomic principles . 33

---------------------- Page: 5 ----------------------
– 4 – 82079-1 © IEC:2012


6.1.10 Keeping the attention of the readers . 33

6.1.11 Proof reading . 33

6.2 Legibility . 34

6.2.1 Text font sizes and graphical symbol heights . 34

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

6.3 Illustrations and supporting text . 37

6.3.1 Quality . 37

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. 38
6.4 Graphical symbols, including safety signs . 38
6.4.1 Graphical symbols for use on equipment, including safety signs . 38
6.4.2 Explanation of graphical symbols . 38
6.4.3 Graphical symbols for diagrams . 38
6.4.4 Minimum sizes of graphical symbols . 38
6.5 Use of tables . 38
6.6 Use of appropriate document types . 38
6.7 Use of electronic media . 39
6.7.1 General . 39
6.7.2 Didactic requirements . 39
6.7.3 Requirements for downloadable instructions for use . 40
6.7.4 Requirements for user interaction . 40
6.8 Making safety-related information prominent and conspicuous . 41
6.8.1 Making text conspicuous . 41
6.8.2 Making illustrations conspicuous . 41
6.8.3 Design and placement of warning messages . 41
6.8.4 Permanence and visibility . 41
6.8.5 Making warning messages prominent . 41
6.8.6 Signal words . 41
6.9 Colours . 42
6.9.1 Consistency . 42
6.9.2 Colour perception considerations . 42

6.9.3 Photocopying/printing considerations. 42
7 Evaluation of conformity to this part of the 82079 series . 42
7.1 Claiming conformity to this part of the 82079 series. 42
7.2 Documentary evidence of evaluation . 43
Annex A (normative) Evaluation of instructions for use . 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
Annex E (informative) Empirical methods supporting the preparation of instructions for use 55
Bibliography . 58

---------------------- Page: 6 ----------------------
82079-1 © IEC:2012 – 5 –


Table 1 – Writing style examples . 33

Table 2 – Minimum recommended text font sizes and graphical symbol heights . 35

---------------------- Page: 7 ----------------------
– 6 – 82079-1 © IEC:2012


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 with the ISO Committee on consumer
policy (COPOLCO).
This first edition cancels and replaces IEC 62079 published in 2001.It constitutes a technical
revision.
The text of this standard is based on the following documents:
FDIS Report on voting
3/1093/FDIS 3/1103/RVD

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

---------------------- Page: 8 ----------------------
82079-1 © IEC:2012 – 7 –


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 stability date 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.



IMPORTANT – The 'colour inside' logo on the cover page of this publication indicates
that it contains colours which are considered to be useful for the correct
understanding of its contents. Users should therefore print this document using a
colour printer.

---------------------- Page: 9 ----------------------
– 8 – 82079-1 © IEC:2012


PREPARATION OF INSTRUCTIONS FOR USE –

STRUCTURING, CONTENT AND PRESENTATION –



Part 1: General principles and detailed requirements








1 Scope


This part of IEC 82079 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 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 IEC 82079 does not specify a fixed amount of documentation that has to be
delivered with a product. This is obviously not possible because this part 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 intended users.
2 Normative references
The following documents, in whole or in part, are normatively referenced in this document and
are indispensable for its application. For dated references, only the edition cited applies. For
undated references, the latest edition of the referenced document (including any
amendments) applies.
IEC 60204-1:2005, 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 (IP Code)
IEC 60617, Graphical symbols for diagrams
IEC 62507-1, Identification systems enabling unambiguous information interchange –
Requirements – Part 1: Principles and methods
IEC/PAS 62569-1:2009, Generic specification of information on products – Part 1: Principles
and methods
ISO 3864 (all parts), Graphical symbols – Safety colours and safety signs
ISO 3864-2, Graphical symbols – Safety colours and safety signs – Part 2: Design principles
for product safety labels

---------------------- Page: 10 ----------------------
82079-1 © IEC:2012 – 9 –


ISO 7000, Graphical symbols for use on equipment – Index and synopsis


ISO 7010, Graphical symbols – Safety colours and safety signs – Registered safety signs


ISO 9241 (all parts), Ergonomics of human-system interaction


ISO 11683, Packaging – Tactile warnings of danger – Requirements


ISO 12100, Safety of machinery – General principles for design – Risk assessment and risk
reduction.
...