BS EN 82079-1-2012 Preparation of instructions for use Structuring content and presentation General principles and detailed requirements《使用说明书的编制 结构 内容和呈现方法 一般原则和详细要求》.pdf

1、raising standards worldwideNO COPYING WITHOUT BSI PERMISSION EXCEPT AS PERMITTED BY COPYRIGHT LAWBSI Standards PublicationBS EN 82079-1:2012Preparation of instructions for use Structuring, content and presentationPart 1: General principles and detailed r e q u i r e m e n t sBS EN 82079-1:2012 BRITI

2、SH STANDARDNational forewordThis British Standard is the UK implementation of EN 82079-1:2012. It supersedes BS 4884-1:1992, BS 4884-2:1993, BS 4884-3:1993 and BS EN 62079:2001 which are withdrawn.The UK participation in its preparation was entrusted to Technical Committee GEL/3, Documentation and g

3、raphical symbols.A list of organizations represented on this committee can be obtained on request to its secretary.This publication does not purport to include all the necessary provisions of a contract. Users are responsible for its correct application. The British Standards Institution 2012. Publi

4、shed by BSI Standards Limited 2012ISBN 978 0 580 61751 5 ICS 01.110 Compliance with a British Standard cannot confer immunity from legal obligations.This British Standard was published under the authority of the Standards Policy and Strategy Committee on 31 October 2012.Amendments issued since publi

5、cationDate Text affectedBS EN 82079-1:2012EUROPEAN STANDARD EN 82079-1 NORME EUROPENNE EUROPISCHE NORM September 2012 CENELEC European Committee for Electrotechnical Standardization Comit Europen de Normalisation Electrotechnique Europisches Komitee fr Elektrotechnische Normung Management Centre: Av

6、enue Marnix 17, B - 1000 Brussels 2012 CENELEC - All rights of exploitation in any form and by any means reserved worldwide for CENELEC members. Ref. No. EN 82079-1:2012 E ICS 01.110; 29.020 Supersedes EN 62079:2001English version Preparation of instructions for use - Structuring, content and presen

7、tation - Part 1: General principles and detailed requirements (IEC 82079-1:2012) Etablissement des instructions dutilisation - Structure, contenu et prsentation - Partie 1: Principes gnraux et exigences dtailles (CEI 82079-1:2012) Erstellen von Gebrauchsanleitungen - Gliederung, Inhalt und Darstellu

8、ng - Teil 1: Allgemeine Grundstze und ausfhrliche Anforderungen (IEC 82079-1:2012) This European Standard was approved by CENELEC on 2012-09-12. CENELEC members are bound to comply with the CEN/CENELEC Internal Regulations which stipulate the conditions for giving this European Standard the status o

9、f a national standard without any alteration. Up-to-date lists and bibliographical references concerning such national standards may be obtained on application to the CEN-CENELEC Management Centre or to any CENELEC member. This European Standard exists in three official versions (English, French, Ge

10、rman). A version in any other language made by translation under the responsibility of a CENELEC member into its own language and notified to the CEN-CENELEC Management Centre has the same status as the official versions. CENELEC members are the national electrotechnical committees of Austria, Belgi

11、um, Bulgaria, Croatia, Cyprus, the Czech Republic, Denmark, Estonia, Finland, Former Yugoslav Republic of Macedonia, France, Germany, Greece, Hungary, Iceland, Ireland, Italy, Latvia, Lithuania, Luxembourg, Malta, the Netherlands, Norway, Poland, Portugal, Romania, Slovakia, Slovenia, Spain, Sweden,

12、 Switzerland, Turkey and the United Kingdom. BS EN 82079-1:2012 - 2 - Foreword The text of document 3/1093/FDIS, future edition 1 of IEC 82079-1, prepared by IEC/TC 3 “Information structures, documentation and graphical symbols“ was submitted to the IEC-CENELEC parallel vote and approved by CENELEC

13、as EN 82079-1:2012. The following dates are fixed: latest date by which the document has to be implemented at national level by publication of an identical national standard or by endorsement (dop) 2013-06-12 latest date by which the national standards conflicting with the document have to be withdr

14、awn (dow) 2015-09-12 This document supersedes EN 62079:2001. Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. CENELEC and/or CEN shall not be held responsible for identifying any or all such patent rights. Endorsement notice The te

15、xt of the International Standard IEC 82079-1:2012 was approved by CENELEC as a European Standard without any modification. In the official version, for Bibliography, the following notes have to be added for the standards indicated: IEC 60073 NOTE Harmonized as EN 60073. IEC 60848 IEC 61082-1:2006 IE

16、C 61310-1 IEC 61355-1:2008 IEC 80416-1:2008 IEC 81346-1 ISO 9000:2005 ISO 10628 ISO 15006 NOTE Harmonized as EN 60848. NOTE Harmonized as EN 61082-1:2006 (not modified). NOTE Harmonized as EN 61310-1. NOTE Harmonized as EN 61355-1:2008 (not modified). NOTE Harmonized as EN 80416-1:2009 (not modified

17、). NOTE Harmonized as EN 81346-1. NOTE Harmonized as EN ISO 9000:2005 (not modified). NOTE Harmonized as EN ISO 10628. NOTE Harmonized as EN ISO 15006. EN 82079-1:2012BS EN 82079-1:2012- 3 - EN 82079-1:2012 Annex ZA (normative) Normative references to international publications with their correspond

18、ing European publications 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 am

19、endments) applies. NOTE When an international publication has been modified by common modifications, indicated by (mod), the relevant EN/HD applies. Publication Year Title EN/HD YearIEC 60204-1 (mod) 2005 Safety of machinery - Electrical equipment of machines - Part 1: General requirements EN 60204-

20、1 + corr. February 2006 2010 IEC 60417 Data base Graphical symbols for use on equipment - - IEC 60529 - Degrees of protection provided by enclosures (IP Code) - - IEC 60617 Data base Graphical symbols for diagrams - - IEC 62507-1 - Identification systems enabling unambiguous information interchange

21、- Requirements - Part 1: Principles and methods EN 62507-1 - IEC/PAS 62569-1 2009 Generic specification of information on products - Part 1: Principles and methods - - ISO/IEC Guide 51 1999 Safety aspects - Guidelines for their inclusion in standards - - ISO/IEC Guide 71 2001 Guidelines for standard

22、s developers to address the needs of older persons and persons with disabilities - - ISO 3864 Series 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 - - ISO 7000 - Graphical

23、 symbols for use on equipment - Index and synopsis - - ISO 7010 - Graphical symbols - Safety colours and safety signs - Registered safety signs EN ISO 7010 - ISO 9241 Series Ergonomic requirements for office work with visual display terminals (VDTs) EN ISO 9241 Series ISO 11683 - Packaging - Tactile

24、 warnings of danger - Requirements EN ISO 11683 - ISO 12100 - Safety of machinery - General principles for design - Risk assessment and risk reduction EN ISO 12100 - ISO 14617 Series Graphical symbols for diagrams - - 2 82079-1 IEC:2012 CONTENTS FOREWORD . 6 1 Scope . 8 2 Normative references . 8 3

25、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

26、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 Durabilit

27、y . 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 Iden

28、tification 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 infor

29、mation 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 BS EN 82079-1:201282079-1 IEC:2012 3 5.8.3 Commissioning 25 5.9 Operation of products 25 5

30、.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 Troubl

31、eshooting 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 an

32、d 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

33、 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

34、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 Presentat

35、ion 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

36、signs and graphical symbols 33 6.1.9 Ergonomic principles . 33 BS EN 82079-1:2012 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 Legibilit

37、y 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

38、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 docum

39、ent 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 .

40、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 Photocopyin

41、g/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 confor

42、mity 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 BS EN 82079-1:201282079-

43、1 IEC:2012 5 Table 1 Writing style examples 33 Table 2 Minimum recommended text font sizes and graphical symbol heights 35 BS EN 82079-1:2012 6 82079-1 IEC:2012 INTERNATIONAL ELECTROTECHNICAL COMMISSION _ PREPARATION OF INSTRUCTIONS FOR USE STRUCTURING, CONTENT AND PRESENTATION Part 1: General princ

44、iples 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 c

45、oncerning 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)”).

46、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 collaborate

47、s 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

48、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

49、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 its