SIST EN 62079:2002
(Main)Preparation of instructions - Structuring, content and presentation
Preparation of instructions - Structuring, content and presentation
Provides general principles and detailed requirements for the design and formulation of all types of instructions that will be necessary or helpful for products of all kinds ranging from small, simple ones, such as tin of paint, to large or highly complex ones, such as a large industrial installation. If the paper version of this standard is ordered, a diskette is provided with fill-in tables corresponding to annexes B and C. If the standard is downloaded directly from the WEB, it consists of 2 files: The standard as a PDF file and the fill-in tables as a WORD file.
Erstellen von Anleitungen - Gliederung, Inhalt und Darstellung
Etablissement des instructions - Structure, contenu et présentation
Fournit les principes généraux et les prescriptions détaillées pour la conception et la formulation de tous les types d'instructions qui seront necessaires ou utiles pour les produits allant des produits de petites tailles et des produits simples comme les pots de peintures, à des produits de grande taille ou très complexe, comme les installations industrielles importantes. Si la version papier de la norme est commandée, une disquette est fournie avec les tableaux à remplir correspondant aux annexes B et C. Si la norme est déchargée depuis le WEB, elle est constituée de 2 fichiers: La norme au format PDF et les tableaux à remplir en format WORD
Preparation of instructions - Structuring, content and presentation (IEC 62079:2001)
General Information
Relations
Standards Content (Sample)
SLOVENSKI SIST EN 62079:2002
prva izdaja
STANDARD
oktober 2002
Preparation of instructions - Structuring, content and presentation (IEC 62079:2001)
ICS 01.110; 29.020 Referenčna številka
SIST EN 62079:2002(en)
© Standard je založil in izdal Slovenski inštitut za standardizacijo. Razmnoževanje ali kopiranje celote ali delov tega dokumenta ni dovoljeno
---------------------- Page: 1 ----------------------
EUROPEAN STANDARD EN 62079
NORME EUROPÉENNE
EUROPÄISCHE NORM April 2001
ICS 29.020;01.110
English version
Preparation of instructions -
Structuring, content and presentation
(IEC 62079:2001)
Etablissement des instructions - Erstellen von Anleitungen -
Structure, contenu et présentation Gliederung, Inhalt und Darstellung
(CEI 62079:2001) (IEC 62079:2001)
This European Standard was approved by CENELEC on 2000-11-01. CENELEC members are bound to
comply with the CEN/CENELEC Internal Regulations which stipulate the conditions for giving this European
Standard the status of a national standard without any alteration.
Up-to-date lists and bibliographical references concerning such national standards may be obtained on
application to the Central Secretariat or to any CENELEC member.
This European Standard exists in three official versions (English, French, German). A version in any other
language made by translation under the responsibility of a CENELEC member into its own language and
notified to the Central Secretariat has the same status as the official versions.
CENELEC members are the national electrotechnical committees of Austria, Belgium, Czech Republic,
Denmark, Finland, France, Germany, Greece, Iceland, Ireland, Italy, Luxembourg, Netherlands, Norway,
Portugal, Spain, Sweden, Switzerland and United Kingdom.
CENELEC
European Committee for Electrotechnical Standardization
Comité Européen de Normalisation Electrotechnique
Europäisches Komitee für Elektrotechnische Normung
Central Secretariat: rue de Stassart 35, B - 1050 Brussels
© 2001 CENELEC - All rights of exploitation in any form and by any means reserved worldwide for CENELEC members.
Ref. No. EN 62079:2001 E
---------------------- Page: 2 ----------------------
EN 62079:2001 - 2 -
Foreword
The text of document 3B/300/FDIS, future edition 1 of IEC 62079, prepared by SC 3B, Documentation,
of IEC TC 3, Documentation and graphical symbols, was submitted to the IEC-CENELEC parallel vote
and was approved by CENELEC as EN 62079 on 2000-11-01.
The following dates were fixed:
– latest date by which the EN has to be implemented
at national level by publication of an identical
national standard or by endorsement (dop) 2001-11-01
– latest date by which the national standards conflicting
with the EN have to be withdrawn (dow) 2003-11-01
Annexes designated "normative" are part of the body of the standard.
Annexes designated "informative" are given for information only.
In this standard, annex ZA is normative and annexes A to D are informative.
Annex ZA has been added by CENELEC.
__________
Endorsement notice
The text of the International Standard IEC 62079:2001 was approved by CENELEC as a European
Standard without any modification.
__________
---------------------- Page: 3 ----------------------
- 3 - EN 62079:2001
Annex ZA
(normative)
Normative references to international publications
with their corresponding European publications
This European Standard incorporates by dated or undated reference, provisions from other
publications. These normative references are cited at the appropriate places in the text and the
publications are listed hereafter. For dated references, subsequent amendments to or revisions of any
of these publications apply to this European Standard only when incorporated in it by amendment or
revision. For undated references the latest edition of the publication referred to applies (including
amendments).
NOTE When an international publication has been modified by common modifications, indicated by (mod), the relevant
EN/HD applies.
Publication Year Title EN/HD Year
IEC 60050-191 1990 International Electrotechnical --
Vocabulary (IEV)
Chapter 191: Dependability and quality
of service
IEC 60050-195 1998 Chapter 195: Earthing and protection--
against electric shock
IEC 60073 1996 Basic and safety principles for man- EN 60073 1996
machine interface, marking and
identification - Coding principles for
indication devices and actuators
IEC 60204-1 1997 Safety of machinery - Electrical EN 60204-1 199
equipment of machines + corr. September 1998
Part 1: General requirements
IEC 60417 Series Graphical symbols for use on equipment EN 60417 Series
IEC 60617 Series Graphical symbols for diagrams EN 60617 Series
IEC 60664-1 1992 Insulation coordination for equipment HD 625.1 S1 1996
(mod) within low-voltage systems + corr. November 1996
Part 1: Principles, requirements and
tests
IEC 60848 1988 Preparation of function charts for control--
systems
IEC 61082-1 1991 Preparation of documents used in EN 61082-1 1993
electrotechnology
Part 1: General requirements
IEC 61082-3 1993 Part 3: Connection diagrams, tables and EN 61082-3 1994
lists
IEC 61082-4 1996 Part 4: Location and installation EN 61082-4 1996
documents
---------------------- Page: 4 ----------------------
EN 62079:2001 - 4 -
Publication Year Title EN/HD Year
IEC 61310-1 1995 Safety of machinery - Indication, EN 61310-1 1995
marking and actuation
Part 1: Requirements for visual, auditory
and tactile signals
IEC 61346-1 1996 Industrial systems, installations and EN 61346-1 1996
equipment and industrial products -
Structuring principles and reference
designations
Part 1: Basic rules
IEC 61355 1997 Classification and designation of EN 61355 1997
documents for plants, systems and
equipment
IEC 61506 1997 Industrial-process measurement and--
control - Documentation of application
softwear
IEC 81714-2 1998 Design of graphical symbols for use in EN 81714-2 1998
the technical documentation of products
Part 2: Specification for graphical
symbols in a computer sensible form,
including graphical symbols for a
reference library, and requirements for
their interchange
ISO 1000 1992 SI units and recommendations for the--
use of their multiples and of certain
other units
ISO 3864 1984 Safety colours and safety signs - -
ISO 7000 1989 Graphical symbols for use on equipment--
- Index and synopsis
ISO 7001 1990 Public information symbols - -
ISO 9241 Series Ergonomic requirements for office work--
with visual display terminals (VDTs)
ISO 10303-203 1994 Industrial automation systems and ENV ISO 1995
integration 10303-203
Product data representation and
exchange -- Part 203: Application
protocol: Configuration controlled
design
ISO 10628 1997 Flow diagrams for process plants --
General rules
ISO/TR 12100-1 1992 Safety of machinery - Basic concepts,--
general principles for design
Part 1: Basic terminology, methodology
ISO/14617 Series Graphical symbols for diagrams - -
---------------------- Page: 5 ----------------------
- 5 - EN 62079:2001
Publication Year Title EN/HD Year
ISO/IEC Guide 14 1977 Product information for consumers - -
ISO/IEC Guide 50 1987 Safety aspects --
Guidelines for child safety
ISO/IEC Guide 51 1990 Guidelines for the inclusion of safety--
aspects in standards
---------------------- Page: 6 ----------------------
NORME
CEI
INTERNATIONALE IEC
62079
INTERNATIONAL
Première édition
STANDARD
First edition
2001-02
Etablissement des instructions –
Structure, contenu et présentation
Preparation of instructions –
Structuring, content and presentation
© IEC 2001 Droits de reproduction réservés ⎯ Copyright - all rights reserved
Aucune partie de cette publication ne peut être reproduite ni No part of this publication may be reproduced or utilized in
utilisée sous quelque forme que ce soit et par aucun procédé, any form or by any means, electronic or mechanical,
électronique ou mécanique, y compris la photocopie et les including photocopying and microfilm, without permission in
microfilms, sans l'accord écrit de l'éditeur. writing from the publisher.
International Electrotechnical Commission 3, rue de Varembé Geneva, Switzerland
Telefax: +41 22 919 0300 e-mail: inmail@iec.ch IEC web site http://www.iec.ch
CODE PRIX
Commission Electrotechnique Internationale
X
PRICE CODE
International Electrotechnical Commission
Pour prix, voir catalogue en vigueur
For price, see current catalogue
---------------------- Page: 7 ----------------------
62079 © IEC:2001 – 3 –
CONTENTS
Page
FOREWORD . 9
INTRODUCTION . 13
Clause
1 Scope . 15
2 Normative references. 15
3 Definitions. 19
4 Principles. 23
4.1 Instructions are part of the product . 23
4.2 Minimizing risks . 23
4.3 Special handling . 23
4.4 Special target groups. 25
4.5 Short-life products . 25
4.6 Considerations as to the nature of instructions. 25
4.6.1 Location. 25
4.6.2 Media. 27
4.6.3 Durability . 27
4.6.4 Availability of instructions. 27
4.6.5 User guidance systems . 29
4.6.6 User training . 29
4.7 Creating instructions . 29
4.7.1 Actuality and conformance . 29
4.7.2 Target group considerations. 31
4.7.3 Languages . 31
5 Content of instructions . 33
5.1 General. 33
5.2 Identification and specification of the product, general warnings . 35
5.3 Identification of instruction documents . 35
5.4 Modification of products . 37
5.5 Safety notes . 37
5.6 Intended environment . 37
5.7 Declaration of conformity . 39
5.8 How to use the instruction materials . 39
5.9 Preparing the product for use. 39
5.9.1 Transportation. 39
5.9.2 Storage. 39
5.9.3 Installation . 41
5.9.4 Commissioning . 41
5.10 Operating instructions. 41
5.10.1 Normal and safe operation . 43
5.10.2 Automatic and remote controlled products. 43
5.10.3 Exceptional functions/situations . 45
5.10.4 Indications to be observed . 45
---------------------- Page: 8 ----------------------
62079 © IEC:2001 – 5 –
Clause Page
5.10.5 Instructions for fault detection . 45
5.10.6 Protection of persons . 47
5.11 Maintenance instructions . 47
5.11.1 General. 47
5.11.2 Maintenance instructions for unskilled persons . 47
5.11.3 Instructions for maintenance and troubleshooting for skilled persons . 49
5.12 List of spare parts . 49
5.13 Instructions for special tools, equipment and materials . 51
5.13.1 Special tools and equipment . 51
5.13.2 Materials. 51
5.14 Instructions for repair and replacement of parts . 51
5.15 Taking the product out of operation (decommissioning). 51
5.15.1 Destruction . 51
5.15.2 5.15.2 Recycling . 53
5.15.3 Disposal. 53
5.16 Table of contents, index and other lists, definitions, and meta-syntax . 53
5.16.1 Page numbering. 53
5.16.2 Table of contents . 53
5.16.3 Index. 53
5.16.4 List of controls . 53
5.16.5 Definition of technical terms. 53
5.16.6 Definition of symbols. 53
5.16.7 Explanation of presentation conventions . 55
6 Presentation of instructions. 55
6.1 Communication principles . 55
6.1.1 Following standard communication principles. 55
6.1.2 Continuously improved understanding. 55
6.1.3 Basic functions first. 55
6.1.4 Simple and brief. 55
6.1.5 Anticipating user questions . 55
6.1.6 Headings and notes in the margin . 55
6.1.7 One sentence, one command. 55
6.1.8 Style . 57
6.1.9 Standardized phases and signs. 55
6.1.10 Ergonomic principles. 57
6.2 Legibility . 57
6.2.1 Print type and size . 57
6.2.2 Vertical view plane. 59
6.2.3 Maximum brightness contrast. 59
6.2.4 Instructions on the surface of the product. 59
6.2.5 Standards . 59
6.3 Illustrations . 59
6.3.1 Quality of pictures . 59
6.3.2 Illustrations supporting text . 59
6.3.3 Following sequence of operation. 59
6.3.4 Illustrations with captions . 59
---------------------- Page: 9 ----------------------
62079 © IEC:2001 – 7 –
Clause Page
6.3.5 One illustration, one item of information . 61
6.3.6 Additional pictures for user convenience . 61
6.3.7 Fold-out . 61
6.4 Graphical symbols . 61
6.4.1 Using standard symbols on the product and in instructions . 61
6.4.2 Explanation of symbols . 61
6.4.3 Symbols in diagrams. 61
6.5 Tables . 61
6.6 Charts and diagrams. 63
6.7 Flow-charts and flow diagrams. 63
6.8 Electronic media, audio, video . 63
6.9 Bringing warning notices into prominence . 65
6.9.1 Making text conspicuous . 65
6.9.2 Design of written warning notices. 65
6.9.3 Signal words for alerting . 65
6.9.4 Permanence and visibility. 65
6.9.5 Giving prominence to warnings . 65
6.10 Colours and colour coding . 65
6.10.1 Where to use colour? . 67
6.10.2 Standard colours. 67
6.10.3 Perception of colours . 67
6.11 Explanation of visual and audible indications . 67
6.11.1 Application of indications . 67
6.11.2 Indication description and checking facilities . 67
6.11.3 List of indicating devices . 67
6.11.4 Standards . 67
Annex A (informative) Assessment of instructions for use. 69
Annex B (informative) Compliance checklist; technical review . 73
Annex C (informative) Evaluation checklist; presentation review. 81
Annex D (informative) Example of a table of contents of a user manual. 91
Bibliography . 95
---------------------- Page: 10 ----------------------
62079 © IEC:2001 – 9 –
INTERNATIONAL ELECTROTECHNICAL COMMISSION
____________
PREPARATION OF INSTRUCTIONS –
STRUCTURING, CONTENT AND PRESENTATION
FOREWORD
1) The IEC (International Electrotechnical Commission) is a worldwide organization for standardization comprising
all national electrotechnical committees (IEC National Committees). The object of the 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, the IEC publishes International Standards. 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. The 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 the 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 National Committees.
3) The documents produced have the form of recommendations for international use and are published in the form
of standards, technical specifications, technical reports or guides and they are accepted by the National
Committees in that sense.
4) In order to promote international unification, IEC National Committees undertake to apply IEC International
Standards transparently to the maximum extent possible in their national and regional standards. Any
divergence between the IEC Standard and the corresponding national or regional standard shall be clearly
indicated in the latter.
5) The IEC provides no marking procedure to indicate its approval and cannot be rendered responsible for any
equipment declared to be in conformity with one of its standards.
6) Attention is drawn to the possibility that some of the elements of this International Standard may be the subject
of patent rights. The IEC shall not be held responsible for identifying any or all such patent rights.
International Standard IEC 62079 has been prepared by subcommittee 3B: Documentation, of
IEC technical committee 3: Documentation and graphical symbols, and ISO technical
committee 10: Technical drawings, product definitions and related documentation.
The text of this standard is based on the following documents:
FDIS Report on voting
3B/300/FDIS 3B/308/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.
This publication had been drafted in accordance with the ISO/IEC Directives, Part 3.
Annexes A, B, C and D are for information only.
The committee has decided that the contents of this publication will remain unchanged until
2005. At this date, the publication will be
• reconfirmed;
• withdrawn;
• replaced by a revised edition, or
• amended.
---------------------- Page: 11 ----------------------
62079 © IEC:2001 – 11 –
For the convenience of the users, an electronic template in a revisable format, consistuting
annexes B and C of this standard is included in a pocket affixed to the back cover. The
template has been created in the form of a checklist, i.e. selection of the relevant issues by
tick boxes. It is intended as a tool to check the quality of work when preparing documents
such as those specified in this standard. The application of the checklist supports the
conformity to this standard.
The template is also downloadable from the IEC WEB store.
Subcommittee 3B has set up a maintenance team (MT 21 ) for this standard which can be
accessed through the IEC WEB site (home page / search the databases / information about a
technical committee / 3B / maintenance teams ) Any questions relating to this standard should
be addressed to this team.
---------------------- Page: 12 ----------------------
62079 © IEC:2001 – 13 –
INTRODUCTION
The purpose of this International Standard is to provide a compilation of requirements and
methodological rules to be followed when creating instructions for users of products.
Instructions are the means of conveying information to the user on how to use the product in a
correct and safe manner. As a means of communication, texts, words, signs, symbols,
diagrams, illustrations and audible or visible information are used, separately or in
combination.
Depending on product characteristics, complexity, risk and legal requirements, the information
for users may be on the product itself or its packaging or in accompanying materials; for
example leaflets, manuals, audio and video tapes, and computer-based presentation,
separately or in combination.
No general standard can provide comprehensive information covering each special case. This
standard, therefore, is to be used in conjunction with the requirements of specific product
standards or, where no such standards exist, with the relevant requirements of standards for
similar products. Users of this standard are reminded that some products and the
accompanying instructions for their use are subject to statutory regulations that may include
special requirements for safety and disposal. This standard serves, therefore, as a frame of
reference for future product-specific standards.
The instructions that will be delivered for a product in many cases result from negotiations
between manufacturer/supplier and customer. For such negotiations, this standard can serve
as a framework listing all possible kinds of instructions.
It should also be mentioned that in many countries the amount of instructions that have to be
delivered depends on regional or national legal regulations, for example the machine directive
of the European Union.
Assessment of the quality of instructions should follow common criteria. This standard,
therefore, has informative annexes containing some practical recommendations and a
proposed methodology for assessment. The annexes A, B, and C are addressed primarily to
experts engaged in such assessment work but they may also be helpful to the standard's
principal target groups named above.
---------------------- Page: 13 ----------------------
62079 © IEC:2001 – 15 –
PREPARATION OF INSTRUCTIONS –
STRUCTURING, CONTENT AND PRESENTATION
1 Scope
This International Standard provides general principles and detailed requirements for the
design and formulation of all types of instructions that will be necessary or helpful for products
of all kinds ranging from small, simple ones, such as a tin of paint, to large or highly complex
ones, such as a large industrial installation. It is intended for application by
− product manufacturers, technical writers, technical illustrators, software designers,
translators or other people engaged in the work of conceiving and drafting such
instructions;
authorized representatives of the product manufacturer in the country of product
−
installation and/or usage.
It will also be helpful in contract negotiations between the product supplier and the customer.
This standard does not establish a fixed amount of documentation that has to be delivered
together with a product. This would obviously not be possible because this standard has to be
valid for all kinds of products but the amount of documentation very much depends on the
complexity of the product. Therefore, this standard lists all possible kinds of instructions one
can think of. What this standard does aim to standardize is how such instructions are to be
prepared.
2 Normative references
The following normative documents contain provisio
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.