IEC 82079-1-2012 Preparation of instructions for use - Structuring content and presentation - Part 1 General principles and detailed requirements《使用说明书的准备.结构化 内容和陈述.第1部分 总则和详细要求》.pdf

《IEC 82079-1-2012 Preparation of instructions for use - Structuring content and presentation - Part 1 General principles and detailed requirements《使用说明书的准备.结构化 内容和陈述.第1部分 总则和详细要求》.pdf》由会员分享，可在线阅读，更多相关《IEC 82079-1-2012 Preparation of instructions for use - Structuring content and presentation - Part 1 General principles and detailed requirements《使用说明书的准备.结构化 内容和陈述.第1部分 总则和详细要求》.pdf（126页珍藏版）》请在麦多课文档分享上搜索。

1、 IEC 82079-1 Edition 1.0 2012-08 INTERNATIONAL STANDARD NORME INTERNATIONALE Preparation of instructions for use Structuring, content and presentation Part 1: General principles and detailed requirements tablissement des instructions dutilisation Structure, contenu et prsentation Partie 1: Principes

2、 gnraux et exigences dtailles IEC 82079-1:2012 colour inside 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 mechanica

3、l, including photocopying and microfilm, without permission in writing from either IEC or IECs 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

4、 below or your local IEC member National Committee for further information. Droits de reproduction rservs. Sauf indication contraire, aucune partie de cette publication ne peut tre reproduite ni utilise sous quelque forme que ce soit et par aucun procd, lectronique ou mcanique, y compris la photocop

5、ie et les microfilms, sans laccord 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 dsirez obtenir des droits supplmentaires sur cette publication, utilisez les coordonnes ci-aprs ou contactez le Comit national de la

6、 CEI de votre pays de rsidence. IEC Central Office Tel.: +41 22 919 02 11 3, rue de Varemb Fax: +41 22 919 03 00 CH-1211 Geneva 20 infoiec.ch Switzerland www.iec.ch About the IEC The International Electrotechnical Commission (IEC) is the leading global organization that prepares and publishes Intern

7、ational 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 link

8、s: IEC publications search - www.iec.ch/searchpub The advanced search enables you to find IEC publications by a variety of criteria (reference number, text, technical committee,). It also gives information on projects, replaced and withdrawn publications. IEC Just Published - webstore.iec.ch/justpub

9、lished Stay up to date on all new IEC publications. Just Published details all new publications released. Available on-line and also once a month by email. Electropedia - www.electropedia.org The worlds leading online dictionary of electronic and electrical terms containing more than 30 000 terms an

10、d definitions in English and French, with equivalent terms in additional languages. Also known as the International Electrotechnical Vocabulary (IEV) on-line. Customer Service Centre - webstore.iec.ch/csc If you wish to give us your feedback on this publication or need further assistance, please con

11、tact the Customer Service Centre: csciec.ch. A propos de la CEI La Commission Electrotechnique Internationale (CEI) est la premire organisation mondiale qui labore et publie des Normes internationales pour tout ce qui a trait llectricit, llectronique et aux technologies apparentes. A propos des publ

12、ications CEI Le contenu technique des publications de la CEI est constamment revu. Veuillez vous assurer que vous possdez ldition la plus rcente, un corrigendum ou amendement peut avoir t publi. Liens utiles: Recherche de publications CEI - www.iec.ch/searchpub La recherche avance vous permet de tro

13、uver des publications CEI en utilisant diffrents critres (numro de rfrence, texte, comit dtudes,). Elle donne aussi des informations sur les projets et les publications remplaces ou retires. Just Published CEI - webstore.iec.ch/justpublished Restez inform sur les nouvelles publications de la CEI. Ju

14、st Published dtaille les nouvelles publications parues. Disponible en ligne et aussi une fois par mois par email. Electropedia - www.electropedia.org Le premier dictionnaire en ligne au monde de termes lectroniques et lectriques. Il contient plus de 30 000 termes et dfinitions en anglais et en frana

15、is, ainsi que les termes quivalents dans les langues additionnelles. Egalement appel Vocabulaire Electrotechnique International (VEI) en ligne. Service Clients - webstore.iec.ch/csc Si vous dsirez nous donner des commentaires sur cette publication ou si vous avez des questions contactez-nous: csciec

16、.ch. IEC 82079-1 Edition 1.0 2012-08 INTERNATIONAL STANDARD NORME INTERNATIONALE Preparation of instructions for use Structuring, content and presentation Part 1: General principles and detailed requirements tablissement des instructions dutilisation Structure, contenu et prsentation Partie 1: Princ

17、ipes gnraux et exigences dtailles INTERNATIONAL ELECTROTECHNICAL COMMISSION COMMISSION ELECTROTECHNIQUE INTERNATIONALE XB ICS 01.110: 29.020 PRICE CODE CODE PRIX ISBN 978-2-83220-096-4 Warning! Make sure that you obtained this publication from an authorized distributor. Attention! Veuillez vous assu

18、rer que vous avez obtenu cette publication via un distributeur agr. colour inside 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

19、 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 produc

20、ts . 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

21、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 inform

22、ation . 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 produc

23、ts for use 24 5.8.1 Transportation and storage 24 5.8.2 Installation . 24 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

24、 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 .

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

26、erials . 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 p

27、roduct 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

28、 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 Co

29、nsistent 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 4 82079-1 IEC:2012 6.1.10 Keeping the attention of the readers 33 6.1.11 Proof reading . 3

30、3 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 Foll

31、owing 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 Gra

32、phical 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 Requirem

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

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

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

36、E (informative) Empirical methods supporting the preparation of instructions for use 55 Bibliography 58 82079-1 IEC:2012 5 Table 1 Writing style examples 33 Table 2 Minimum recommended text font sizes and graphical symbol heights 35 6 82079-1 IEC:2012 INTERNATIONAL ELECTROTECHNICAL COMMISSION _ PREP

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

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

39、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- government

40、al 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 tec

41、hnical 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

42、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 unif

43、ormity, 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)

44、 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 ensu

45、re 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 a

46、ny 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 ref

47、erenced 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. Inte

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

49、 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. 82079-1 IEC:2012 7 This publication has been drafted in accordance with the ISO/IEC Directives, Part 2. The committee has decide