《BS-EN-62079-2001 IEC-62079-2001.pdf》由会员分享，可在线阅读，更多相关《BS-EN-62079-2001 IEC-62079-2001.pdf（54页珍藏版）》请在三一文库上搜索。
1、BRITISH STANDARD BS EN 62079:2001 IEC 62079:2001 Preparation of instructions Structuring, content and presentation The European Standard EN 62079:2001 has the status of a British Standard ICS 29.020; 01.110 NO COPYING WITHOUT BSI PERMISSION EXCEPT AS PERMITTED BY COPYRIGHT LAW BS EN 62079:2001 This
2、British Standard, having been prepared under the direction of the Electrotechnical Sector Committee, was published under the authority of the Standards Committee and comes into effect on 15 September 2001 BSI 07-2001 ISBN 0 580 38240 0 National foreword This British Standard is the official English
3、language version of EN 62709:2001. It is identical with IEC 62079:2001 The UK participation in its preparation was entrusted to Technical Committee GEL/3, Documentation and graphical symbols, which has the responsibility to: A list of organizations represented on this committee can be obtained on re
4、quest to its secretary. Cross-references The British Standards which implement international or European publications referred to in this document may be found in the BSI Standards Catalogue under the section entitled “International Standards Correspondence Index”, or by using the “Find” facility of
5、 the BSI Standards Electronic Catalogue. A British Standard does not purport to include all the necessary provisions of a contract. Users of British Standards are responsible for their correct application. Compliance with a British Standard does not of itself confer immunity from legal obligations.
6、aid enquirers to understand the text; present to the responsible European committee any enquiries on the interpretation, or proposals for change, and keep the UK interests informed; monitor related international and European developments and promulgate them in the UK. Summary of pages This document
7、comprises a front cover, an inside front cover, the EN title page, pages 2 to 51, and a back cover. The BSI copyright date displayed in this document indicates when the document was last issued. Amendments issued since publication Amd. No. DateComments EUROPEAN STANDARDEN 62079 NORME EUROPENNE EUROP
8、ISCHE NORMApril 2001 CENELEC European Committee for Electrotechnical Standardization Comit Europen de Normalisation Electrotechnique Europisches Komitee fr Elektrotechnische Normung Central Secretariat: rue de Stassart 35, B - 1050 Brussels 2001 CENELEC -All rights of exploitation in any form and by
9、 any means reserved worldwide for CENELEC members. Ref. No. EN 62079:2001 E ICS 29.020;01.110 English version Preparation of instructions - Structuring, content and presentation (IEC 62079:2001) Etablissement des instructions - Structure, contenu et prsentation (CEI 62079:2001) Erstellen von Anleitu
10、ngen - Gliederung, Inhalt und Darstellung (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 wi
11、thout 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 lang
12、uage 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
13、, Germany, Greece, Iceland, Ireland, Italy, Luxembourg, Netherlands, Norway, Portugal, Spain, Sweden, Switzerland and United Kingdom. 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 graphica
14、l 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 late
15、st 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 in
16、formative. 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. _ 1002:97026 CEI NE 100270 ISB 2 EN IEC 62079:2001 BSI 0720012 62079 IEC:2001 3 CONTENTS Page INTRODUCTIO
17、N 6 Clause 1Scope 7 2Normative references. 7 3Definitions . 9 4Principles11 4.1Instructions are part of the product 11 4.2Minimizing risks.11 4.3Special handling 11 4.4Special target groups.12 4.5Short-life products .12 4.6Considerations as to the nature of instructions 12 4.6.1Location.12 4.6.2Medi
18、a 13 4.6.3Durability .13 4.6.4Availability of instructions 13 4.6.5User guidance systems14 4.6.6User training14 4.7Creating instructions14 4.7.1Actuality and conformance.14 4.7.2Target group considerations 15 4.7.3Languages.15 5Content of instructions16 5.1General .16 5.2Identification and specifica
19、tion of the product, general warnings17 5.3Identification of instruction documents .17 5.4Modification of products.18 5.5Safety notes 18 5.6Intended environment 18 5.7Declaration of conformity.19 5.8How to use the instruction materials 19 5.9Preparing the product for use 19 5.9.1Transportation .19 5
20、.9.2Storage19 5.9.3Installation.20 5.9.4Commissioning 20 5.10 Operating instructions20 5.10.1 Normal and safe operation.21 5.10.2 Automatic and remote controlled products .21 5.10.3 Exceptional functions/situations .22 5.10.4 Indications to be observed .22 1002:97026 CEI NE 100270 ISB 3 EN IEC 62079
21、:2001 BSI 0720013 62079 IEC:2001 4 ClausePage 5.10.5 Instructions for fault detection22 5.10.6 Protection of persons.23 5.11 Maintenance instructions .23 5.11.1 General23 5.11.2 Maintenance instructions for unskilled persons 23 5.11.3 Instructions for maintenance and troubleshooting for skilled pers
22、ons .24 5.12 List of spare parts24 5.13 Instructions for special tools, equipment and materials 25 5.13.1 Special tools and equipment 25 5.13.2 Materials25 5.14 Instructions for repair and replacement of parts .25 5.15 Taking the product out of operation (decommissioning) .25 5.15.1 Destruction 25 5
23、.15.2 5.15.2 Recycling 26 5.15.3 Disposal.26 5.16 Table of contents, index and other lists, definitions, and meta-syntax 26 5.16.1 Page numbering.26 5.16.2 Table of contents .26 5.16.3 Index .26 5.16.4 List of controls .26 5.16.5 Definition of technical terms.26 5.16.6 Definition of symbols26 5.16.7
24、 Explanation of presentation conventions27 6Presentation of instructions.27 6.1Communication principles27 6.1.1Following standard communication principles.27 6.1.2Continuously improved understanding27 6.1.3Basic functions first27 6.1.4Simple and brief.27 6.1.5Anticipating user questions 27 6.1.6Head
25、ings and notes in the margin27 6.1.7One sentence, one command.27 6.1.8Style 28 6.1.9Standardized phases and signs .55 6.1.10 Ergonomic principles28 6.2Legibility28 6.2.1Print type and size .28 6.2.2Vertical view plane.29 6.2.3Maximum brightness contrast.29 6.2.4Instructions on the surface of the pro
26、duct 29 6.2.5Standards 29 6.3Illustrations29 6.3.1Quality of pictures29 6.3.2Illustrations supporting text29 6.3.3Following sequence of operation29 6.3.4Illustrations with captions.29 1002:97026 CEI NE 100270 ISB 4 EN IEC 62079:2001 BSI 0720014 62079 IEC:2001 5 ClausePage 6.3.5One illustration, one
27、item of information.30 6.3.6Additional pictures for user convenience30 6.3.7Fold-out .30 6.4Graphical symbols .30 6.4.1Using standard symbols on the product and in instructions 30 6.4.2Explanation of symbols 30 6.4.3Symbols in diagrams30 6.5Tables .30 6.6Charts and diagrams .31 6.7Flow-charts and fl
28、ow diagrams 31 6.8Electronic media, audio, video .31 6.9Bringing warning notices into prominence32 6.9.1Making text conspicuous32 6.9.2Design of written warning notices.32 6.9.3Signal words for alerting 32 6.9.4Permanence and visibility 32 6.9.5Giving prominence to warnings 32 6.10 Colours and colou
29、r coding .32 6.10.1 Where to use colour?.33 6.10.2 Standard colours33 6.10.3 Perception of colours .33 6.11 Explanation of visual and audible indications.33 6.11.1 Application of indications .33 6.11.2 Indication description and checking facilities33 6.11.3 List of indicating devices33 6.11.4 Standa
30、rds 33 Annex A (informative) Assessment of instructions for use 34 Annex B (informative) Compliance checklist; technical review36 Annex C (informative) Evaluation checklist; presentation review 40 Annex D (informative) Example of a table of contents of a user manual .45 Annex ZA (normative) Normativ
31、e references to international publications with their corresponding European publications .48 Bibliography47 EN IEC 62079:2001 BSI 0720015 62079 IEC:2001 6 INTRODUCTION The purpose of this International Standard is to provide a compilation of requirements and methodological rules to be followed when
32、 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, separa
33、tely 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, separate
34、ly 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 si
35、milar 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-speci
36、fic 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 c
37、ountries 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 contain
38、ing 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 standards principal target groups named above. 1002:97026 CEI NE 100270 ISB 6 EN IEC 62079:2001
39、 BSI 0720016 62079 IEC:2001 7 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
40、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
41、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 amou
42、nt 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 k
43、inds 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 provisions which, through reference in this text, constitute provisions of this International Standard. For
44、dated references, subsequent amendments to, or revisions of, any of these publications do not apply. However, parties to agreements based on this International Standard are encouraged to investigate the possibility of applying the most recent editions of the normative documents indicated below. For
45、undated references, the latest edition of the normative document referred to applies. Members of ISO and IEC maintain registers of currently valid International Standards. IEC 60050(191):1990, International Electrotechnical Vocabulary (IEV) Chapter 191: Depend- ability and quality of service IEC 600
46、50-195:1998, International Electrotechnical Vocabulary (IEV) Part 195: Earthing and protection against electric shock IEC 60073:1996, Basic and safety principles for man-machine interface, marking and identification Coding principles for indication devices and actuators IEC 60204-1:1997, Electrical
47、equipment of industrial machines Part 1: General requirements IEC 60417 (all parts), Graphical symbols for use on equipment IEC 60617 (all parts), Graphical symbols for diagrams IEC 60664-1:1992, Insulation coordination for equipment within low-voltage systems Part 1: Principles, requirements and te
48、sts IEC 60848:1988, Preparation of function charts for control systems 1002:97026 CEI NE 100270 ISB 7 EN IEC 62079:2001 BSI 0720017 62079 IEC:2001 8 IEC 61082-1:1991, Preparation of documents used in electrotechnology Part 1: General requirements IEC 61082-3:1993, Preparation of documents used in el
49、ectrotechnology Part 3: Connection diagrams, tables and lists IEC 61082-4:1996, Preparation of documents used in electrotechnology Part 4: Location and installation documents IEC 61310-1:1995, Safety of machinery Indication, marking and actuation Part 1: Requirements for visual, auditory and tactile signals IEC 61346-1:1996, Industrial systems, installations and equipment and industrial products Structuring principles and reference designations Part 1: Basic rules IEC 61