BS EN 82079-1:2012
$198.66
Preparation of instructions for use. Structuring, content and presentation – General principles and detailed requirements
| Published By | Publication Date | Number of Pages |
| BSI | 2012 | 64 |
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.
PDF Catalog
| PDF Pages | PDF Title |
|---|---|
| 6 | English CONTENTS |
| 10 | FOREWORD |
| 12 | 1 Scope 2 Normative references |
| 13 | 3 Terms and definitions |
| 18 | 4 Principles 4.1 Provision of instructions for use 4.1.1 General 4.1.2 Instructions for use are part of the product 4.1.3 Consistency of information 4.1.4 Product warranty 4.1.5 Information provided after sale of products |
| 19 | 4.1.6 Security aspects 4.2 Quality of communication 4.3 Minimizing risks 4.4 Target group(s) |
| 20 | 4.5 Special precautions 4.6 Short-life products 4.7 Considerations to the nature of instructions for use 4.7.1 General 4.7.2 Location 4.7.3 Means of communication and media |
| 21 | 4.7.4 Durability 4.7.5 Availability 4.7.6 Electronic guidance systems |
| 22 | 4.7.7 User training 4.8 Creating instructions for use 4.8.1 Conformity with the product |
| 23 | 4.8.2 Consideration of needs of target groups |
| 24 | 4.8.3 Languages |
| 25 | 5 Content of instructions for use 5.1 General 5.2 Identification of instructions for use 5.3 Identification of the product |
| 26 | 5.4 Modification of products 5.5 Safety-related information 5.5.1 General |
| 27 | 5.5.2 Safety notes 5.5.3 Warning messages |
| 28 | 5.5.4 Safety-related information for industrial plants 5.5.5 Safety related information in quick-start guides 5.6 Product compliance 5.7 Importance of retaining instructions for use 5.8 Preparing products for use 5.8.1 Transportation and storage 5.8.2 Installation |
| 29 | 5.8.3 Commissioning 5.9 Operation of products 5.9.1 General 5.9.2 Normal operation 5.9.3 Additional information for automatic and remotely controlled products |
| 30 | 5.9.4 Indications of faults and warning device signals 5.9.5 Exceptional/emergency situations 5.9.6 Troubleshooting and repair by non-skilled persons 5.9.7 Troubleshooting and repair by skilled persons |
| 31 | 5.10 Maintenance of the product 5.10.1 General 5.10.2 Product maintenance by non-skilled persons 5.10.3 Product maintenance by skilled persons |
| 32 | 5.10.4 Planned maintenance of industrial plants 5.11 Supplied accessories, consumables and spare parts 5.11.1 Accessories 5.11.2 Consumables 5.11.3 Spare/replacement parts |
| 33 | 5.12 Information on special tools, equipment and materials 5.13 Information on repair of products and replacement of parts 5.13.1 Information on repair of products and replacement of parts by non-skilled persons 5.13.2 Information on repair of products and replacement of parts by skilled persons 5.14 Information required when the product is no longer needed 5.14.1 General 5.14.2 Disassembly |
| 34 | 5.14.3 Recycling 5.14.4 Disposal 5.15 Structure of instruction for use 5.15.1 General 5.15.2 Page numbering 5.15.3 Table of contents 5.15.4 Index 5.15.5 Technical terms, acronyms and abbreviations |
| 35 | 5.15.6 Graphical and tactile symbols and tactile dots 5.15.7 Presentational conventions 5.15.8 User controls and indicators 6 Presentation of instructions for use 6.1 Comprehensibility 6.1.1 Recognized communication principles 6.1.2 Style guide |
| 36 | 6.1.3 Structure 6.1.4 Consistent terminology 6.1.5 Simple and brief 6.1.6 One sentence, one command 6.1.7 Rules for simple wording |
| 37 | 6.1.8 Standardized safety signs and graphical symbols 6.1.9 Ergonomic principles 6.1.10 Keeping the attention of the readers 6.1.11 Proof reading Table 1 – Writing style examples |
| 38 | 6.2 Legibility 6.2.1 Text font sizes and graphical symbol heights |
| 39 | Table 2 – Minimum recommended text font sizes and graphical symbol heights |
| 40 | 6.2.2 Maximum brightness contrast 6.2.3 Legibility standards 6.2.4 Layout |
| 41 | 6.2.5 Instructions for use on surfaces of products or packaging 6.3 Illustrations and supporting text 6.3.1 Quality 6.3.2 Following a sequence of operations 6.3.3 Illustrations with captions |
| 42 | 6.3.4 One illustration, one item of information 6.4 Graphical symbols, including safety signs 6.4.1 Graphical symbols for use on equipment, including safety signs 6.4.2 Explanation of graphical symbols 6.4.3 Graphical symbols for diagrams 6.4.4 Minimum sizes of graphical symbols 6.5 Use of tables 6.6 Use of appropriate document types |
| 43 | 6.7 Use of electronic media 6.7.1 General 6.7.2 Didactic requirements |
| 44 | 6.7.3 Requirements for downloadable instructions for use 6.7.4 Requirements for user interaction |
| 45 | 6.8 Making safety-related information prominent and conspicuous 6.8.1 Making text conspicuous 6.8.2 Making illustrations conspicuous 6.8.3 Design and placement of warning messages 6.8.4 Permanence and visibility 6.8.5 Making warning messages prominent 6.8.6 Signal words |
| 46 | 6.9 Colours 6.9.1 Consistency 6.9.2 Colour perception considerations 6.9.3 Photocopying/printing considerations 7 Evaluation of conformity to this part of the 82079 series 7.1 Claiming conformity to this part of the 82079 series |
| 47 | 7.2 Documentary evidence of evaluation |
| 48 | Annex A (normative) Evaluation of instructions for use |
| 49 | Annex B (informative) Checklist for conformity and comments Table B.1 – Checklist for conformity and comments |
| 52 | Annex C (informative) Checklist for communication effectiveness Table C.1 – Checklist for communication effectiveness |
| 55 | Annex D (informative) Planning the preparation of instructions for use |
| 59 | Annex E (informative) Empirical methods supporting the preparation of instructions for use |
| 62 | Bibliography |
Related products
-
IEC/IEEE 82079-1:2019
Preparation of information for use (instructions for use) of products – Part 1: Principles and…
-
BS EN IEC/IEEE 82079-1:2020
Preparation of information for use (instructions for use) of products – Principles and general requirements…
