General principles for preparation of instructions for use of industrial products
Some standard content:
ICS 01. 110
National Standard of the People's Republic of China
GB/T9969—2008
Representative GB9969.1-1998wwW.bzxz.Net
Instructions for use of industrial products
General principles for preparation of instructions foruse of industrial products
Published on 2008-11-13
General Administration of Quality Supervision, Inspection and Quarantine of the People's Republic of China Administration of Standardization of the People's Republic of China
Implemented on 2009-05-01
GB/T 9969—2008
Scope··
Normative referenced documents
Basic requirements
Compilation requirements
Text, language
Principles of expression
4.3 Figures, tables, symbols, terms
Section (index table)
Safety warnings
4.8 Arrangement of contents
Main contents of the instruction manual
Appendix A (Normative appendix)
TKA-
GB/T 9969—2008
This standard makes reference to ISO/IEC 3747 Guide: 1995 Instructions for Use of Consumer Products (English version) and revises GB 9969.[—1998]. This standard replaces GB 9969.1—1998 “General principles for instructions for use of industrial products”. Compared with GB9969.1-1998, the main changes of this standard are as follows: "This standard may also be applied to other forms of instructions for use" is added to chapter 1; 3.1 is revised to "Instructions for use are an essential part of the delivered product"; -3.3 is added to chapter 3 "The contents of instructions for use should be concise, accurate, easy to read and understand: instructions for use should not be used to cover up design defects"; -3.4 Compared with 3.3 in GB9969.1-1998, "for products involving the environment and energy" is deleted; -3.7 Compared with 3.6 in GB9969.1-1998, "The instructions for use should clearly indicate the product, the model, style or type of the product, and should not be different due to differences between one model and its improved version or between two different models" is added. The user's instructions for use shall not be inconsistent with the actual product used due to confusion between different models (no matter how small the difference is), or between different specifications under the same model.
-3.10 Compared with 3.V in GB9969.1·1998, "\version\" is added; -3.12 Compared with 3.11 in GB9969.1-1998, "\installation" is deleted; 3.13 Compared with 3.12 in GB9969.1-1998, it is revised to "products that implement product standard numbering should be marked with valid product standard numbers in the instruction manual"; - The title of Chapter 4 is revised to "Compilation Requirements": - In Chapter 4, according to GB5296.11997 "General Principles for Instructions for Use of Consumer Products", 1.1 and 4.4 are revised. Modifications: - 4.5.2 in GB9969.1-1998 was deleted
--1.5.3 Compared with 4.5.4 in GB9969.1-1998, the instruction manual of *exported products should be preceded by "People's Republic of China\"; 1.6.1 was changed to "the format of the instruction manual can be A4 or other formats"; "Warning\" in 4.7 was changed to "Warning", - 4.8.1 was added "under the premise of ensuring safety and correct use"; Chapter A.2 "Precautions for safe use" was added; Chapter A.9 was compared with Appendix AA,8 of GB9969.1-1998, "c) Emergency measures in case of emergencies\" was added; Chapter A, 13 was compared with GB9969. ! Compared with Appendix AA.12 of 1998, the title "Other" is changed to "Environmental protection and others", "Manufacturer guarantee, after-sales service matters, contact methods, etc." and "Other matters that need to be explained to users" are deleted, and "Regulations on disposal and treatment" are added.
Appendix A of this standard is a normative appendix.
This standard is proposed and managed by the National Technical Committee for Service Standardization. The drafting units of this standard are: China National Institute of Standardization, Ningbo Gaoda Electric Co., Ltd. The main drafters of this standard are: Liu Chengyang, Zun Lili, Lu Lili, Li Han, Wang Wenfei, Zheng Shichuan. The previous versions of the standards replaced by this standard are: GB9969.1—1998;
-GB9969.11988.
1 Scope
Industrial product instructions
GB/T9969--2008
This standard specifies the basic requirements and preparation methods for the instructions for use of industrial products (hereinafter referred to as instructions for use3). This standard applies to the preparation of instructions for use of industrial products other than consumer products. This standard may also be applied to other forms of instructions for use. Note: The preparation of instructions for use of consumer products shall be carried out in accordance with CB5296.11997 "General Principles for Instructions for Use of Consumer Products". 2 Normative references
The clauses in the following documents become the clauses of this standard through reference in this standard. For any dated referenced document, all subsequent amendments (excluding errata) or revisions are not applicable to this standard. However, the parties to an agreement based on this standard are encouraged to study whether to use the latest versions of these documents. For any undated referenced document, the latest version shall apply to this standard. GB5296.11997 General Principles for Instructions for Use of Consumer Products 3 Basic Requirements
3.1 The instruction manual is an essential part of the delivered product. 3.2 The content of the instruction manual should be concise, accurate, easy to read and understand; the instruction manual should not try to cover up design defects. 3.3 The instruction manual should clearly state the purpose and scope of application of the product, and give the main structure, performance, model, specifications and correct lifting, installation, use, operation, repair, maintenance and storage methods according to the characteristics and needs of the product, as well as safety measures to protect the operation of each product. For details, see Appendix A. If necessary, installation and maintenance instructions can be provided. 3.4 The instruction manual should provide necessary content on environmental protection and energy conservation. 3.5 For products with flammable, explosive, noisy, corrosive, radioactive and other properties, the instructions should include precautions, protective measures and emergency treatment methods in case of accidents. 3.6 When the product structure and performance are changed, the relevant content of the instruction manual must be modified accordingly in a timely manner according to the prescribed procedures. The producer (the concept in the quality law) should provide the user with the instruction manual corresponding to the product. 3.7 The instruction manual can be compiled according to the product model, or according to the product series and complete set of products. When compiling by series or complete sets of products, the parts with different contents and parameters must be clearly distinguished. For complex products and complete sets of equipment, the instruction manuals can be compiled separately by functional units and complete machines, and then combined into a system instruction manual by product model and purpose. When the chapter is brief, a list of complete sets of documents can be provided. The instruction manual should clearly indicate the product, explain the model, style or type of the product, and should not cause confusion between a model and its improved version or between two different models (no matter how small the difference is), or between different specifications under the same model, which may cause the instructions in the hands of the user to be inconsistent with the actual product used. 3.8 For raw material products such as metallurgy, mining, building materials, and chemicals, and components used for supporting the main engine factory, if their product manuals and other technical documents can meet the user's needs for the instructions, they can be used instead of the instruction manual. 3.9 For products with safety restrictions or validity periods, the production date and validity period of the product should be provided. 3.10 The publication period or version of the instruction manual should be indicated. 3.11 The technical content of the same product should be consistent in the manufacturer's instruction manual and other materials (such as advertisements or packaging).
When necessary, the packaging or cover of the instruction manual should be marked with the following: "Please read the instruction manual before using the product". 3.12
For products subject to production license management, the valid production license number should be marked on the packaging. 3.133
kAoNrkAca=
GB/T 9969--2008
4 Preparation requirements
4.1 Text, language
4.1.1 Domestically sold industrial products must provide Chinese instruction manuals. Note: Industrial products exported abroad must provide instructions in the official legal language abbreviation of the place of sale. 4.1.2 For domestically sold industrial products, when it is necessary to provide instructions in more than one language, the Chinese instructions must be placed before the foreign language instructions, the Chinese title should be eye-catching and prominent, and the instructions in each language should be clearly separated. 4.1.3 Chinese instructions must use standard Chinese characters. For industrial products sold to Hong Kong, Macau, Taiwan or overseas, the instruction manual may use traditional Chinese characters if the buyer requires it. 4.1.4 When the Chinese manual is translated into other languages with the same content and provided at the same time, all contents including annotations shall be translated; for diagrams without legends, the diagram titles may be translated and the original instructions may be quoted. 4.2 Principles of Expression
4.2.1 The expression of the contents of the manual shall be scientific, reasonable, and in accordance with the operating procedures, so that users can quickly understand and master them. For example, the instructions for the use of fire extinguishers must ensure that readers can read and use them in the shortest possible time. 4.2.2 For complex operating procedures, the manual shall use more diagrams, charts and operating procedure diagrams to help users master them smoothly.
4.2.3 For products with only a few different and independent functions, the manual shall first introduce the basic and common functions of the product, and then introduce other functions.
4.2.4 The manual shall try to imagine the problems that users may encounter. For example, the problems that the product may encounter at different times (seasons), different locations, and different environmental conditions, and provide prevention and solution methods. 4.2.5 Concise titles and annotations shall be used to help users quickly find the required content. 4.2.6 The statement should contain one requirement, or at most several closely related requirements. For the sake of clarity: it is better to use active voice instead of passive voice; a requirement should be decisive and powerful, not weak; it is better to use action verbs instead of abstract nouns; the statement should be direct and straightforward, not euphemistic.
The voice statement examples are shown in Table 1.
Examples of statements in the manual
Language expressions
Dynamic in use
Powerful
Use action verbs
Straightforward
4.3 Figures, tables, symbols, terms
Should be expressed like this
Turn off the power
Do not use the wristband
Avoid accidents
Pull the operating lever
Should not be expressed like this
So that the power is interrupted
The wristband should not be passive
Avoid accidents
The user pulls the operating lever back from the machine
4. 3.1 The tables and figures in the manual should be printed together with the main text, and the figures and tables should be numbered in sequence. 4.3.2 When citing figures and tables in the previous text, the figure number and table number should be marked, and the page number where they first appeared should be indicated. 4.3.3 The derivative symbols, codes, terms and measurement units in the instruction manual shall comply with the latest national laws, regulations and relevant standards, and maintain consistency. Definitions shall be given for terms that need to be explained. 4.3.4 Illustrations, line numbers and abbreviations shall be annotated when they appear for the first time in the instruction manual. 4.4 Table of Contents (Index Table)
4.4.1 When the instruction manual exceeds: pages (including folding forms), all pages shall be numbered. When the number of pages of loose-leaf materials, manuals, etc. exceeds 4 pages, there shall be:-day (index table). 2
GR/T9969—2008
4.4.2 When the instruction manual is long, a keyword citation shall be given in the order of Chinese pinyin, and the table of contents shall include an index. 4.4.3 The instruction manual for complex products or complete equipment composed of kinetic energy units or complete machines shall have a general table of contents, and the instructions for each functional unit and the complete machine shall have a detailed table of contents.
4.5 Printing
4.5.1 The printed material of the instruction manual should be strong and durable, and ensure the usability of the instruction manual during the life of the product. The text, symbols, diagrams, tables, photos, etc. in the instruction manual should be clear and neat. If printed on both sides, the reading should not be affected by the back see-through and other reasons.
The cover of the instruction manual should have a name that can accurately identify the product type (such as product model, brand, series, etc.), the product name and the words "Instructions for Use". It should also have the name of the manufacturer (factory name). 4.5.4 The instruction manual must have the manufacturer's detailed address, zip code, telephone number, etc. on the back cover or the front cover. 4.5.5 Photos, graphics, trademarks or other certification marks are allowed to be printed on the cover. 4.6 Text
4.6.1 The format of the instruction manual can be A4 Or other formats. 4.6.2 Figures, tables, etc. may be extended horizontally, and vertically if necessary. 4.6.3 The instruction manual may be single page, folded page or multiple pages depending on the content. Multiple pages should be bound into a book. 4.7 Safety warnings
4.7.1 The instruction manual should give safety warnings for safety-related content. 4.7.2 The content of the safety warning should be expressed in larger letters or different fonts, and emphasized with special symbols or colors. 3 To achieve the best effect, the format and writing of the safety warning should consider the following points: 4. 7. 3
The content and illustrations should be concise and clear;
The location, content and form of the safety warning should be eye-catching; ensure that the user can see the danger warning from the use position when the product is used normally; explain the nature of the hazard (if necessary, explain the cause of the hazard); give clear instructions on how to operate correctly; ... - give clear instructions on how to avoid danger; the language, graphic symbols and graphic instructions used should be clear and accurate; ... - if safety and health instructions are required at the same time, safety instructions should be given priority; all notes Frequent repetition of warnings and wrong warnings will weaken the effectiveness of necessary warnings. 4.7.4 When reminding users, the safety warning title of the instruction manual should use the following classification method and warning terms according to different hazard levels:
"Danger" means to be vigilant to high hazards; - "Warning" means to be vigilant to moderate hazards; - "Caution" means to pay attention to minor hazards. 4.7.5 For products with high and medium hazards, safety warnings should be permanently installed on the product so that users can clearly see them during the life of the product. The instruction manual shall indicate the location of the safety warning to draw the user's attention. 4.7.6 In order to convey important information such as hazard warnings, standardized terms or safety signs or graphic symbols shall be used at appropriate locations. These terms and signs and their location requirements shall be specified in the instructions for use of the relevant products. 4.7.7 The instructions for use shall specify the location of visual and auditory warnings, the management and maintenance of replacement devices, safety protection products and equipment, etc.
4.8 Content arrangement
4.8.1 The arrangement of the contents of the instruction manual can be based on the characteristics and usage requirements of the specific products and can be reasonably arranged according to the selection of Appendix A.
4.8.2 a), b), and c) in each chapter of Appendix A only indicate the included contents. It also indicates that the content should be stated in a certain chapter without specifying the title and arrangement order of the articles. 3
rKAONTKAca-
GB/T 9969—2008
A.1 Overview
a) Product features:
Appendix A
(Normative appendix)
Main contents of instruction manual
b) Main uses and applicable scope (including inapplicable scope when necessary): Variety and specifications:
d) Model composition and its representative significance;
Use environment conditions:
Working conditions;
g) Impact on environment and energy;
h) Safety.
Precautions for safe use
Safe use period, production date, validity period; a)
General safe use methods;
c) Methods of use or misoperation that are prone to errors; d)
Possible harm caused by incorrect use and operation; e) Emergency treatment measures under abnormal conditions; Precautions under special circumstances (power outages, movement, etc.); Other safety warnings.
3 Structural characteristics and working principles
Overall structure and its working principle, working characteristics; Structure, function and working principle of key components or functional units; b
Electromechanical connection between each unit structure, system working principle, fault alarm system, etc. d) Auxiliary device's energy structure and its working principle, working characteristics. A.4 Technical characteristics
Main performance;
b) Main parameters.
Dimensions, weight
Appearance and installation dimensions (separable);
b) Weight.
A.6 Installation, adjustment (or debugging)
Equipment foundation, installation conditions and technical requirements for installation; a
Installation procedures, methods and precautions;
Adjustment (or debugging) procedures, methods and precautions: 4
Acceptance test items after installation, adjustment (or debugging), methods and judgment basis: d)
Preparation before trial operation, trial operation start-up, trial operation. Use, operation
Preparation and inspection before use;
Safety and safety protection, safety signs and instructions before and during use; GB/T9969—2008
Operation procedures, methods, precautions and easy-to-occur erroneous operations and preventive measures during startup and operation; Monitoring and recording during operation;
Operation procedures, methods and precautions for shutdown. A.8 Fault analysis and troubleshooting
Fault phenomenon;
Cause analysis;
Troubleshooting methods.
It is recommended to use the form of Table A.1.
Table A.1 Fault analysis and troubleshooting examples
Fault phenomenon
Cause analysis
Safety protection devices and accident handling (including fire protection) A.9:
Safety protection devices and precautions:
Handling procedures and methods when a fault occurs; b
c) Emergency measures in case of emergencies.
A.10 Maintenance and repair
Daily maintenance, maintenance, calibration;
Maintenance and maintenance during operation;
Repair cycle;
d) Normal maintenance procedures:
Maintenance and maintenance during long-term outage.
Transportation and storage
a) Precautions for lifting and transportation;
b) Storage conditions, storage period and precautions. A.12 Unpacking and inspection
a) Unpacking precautions;
b) Inspection contents,
A.13 Environmental protection and other
regulations on disposal and treatment.
KAONTKAca=
Elimination methods
GB/T 9969—2008
Figures, tables, photos (can also be listed in the above chapters)a)
Appearance (appearance) drawing, installation drawing, layout drawing: structure drawing;
Principle diagram, system diagram, circuit diagram, logic diagram, schematic diagram, wiring diagram, construction drawing, etc.; various appendixes, attachment list, special tool (instrument) list; photos.
GB/T 9969-2008
People's Republic of China
National Standard
Industrial Product Instructions
GB/T9969—2008
Published and distributed by China Standards Press
No. 16 Hebei Street, Lanli, Fuxingmenwai, Beijing
Postal Code: 100045
Website: www, spe, net, cn
Tel: 6852394668537548
China Standards Press Qinhuangdao Printing! Printed and distributed by Xinhua Bookstores all over the country
Binary edition 880×1230 1/16
Sheet 0.75 Number of students 141 thousand
February 2009
:- Edition First printing in February 2009
Book number: 155066·1-35606 Price 14.00 yuan If there is any printing error
report it to our publishing center for replacement
Copyright exclusive infringement will be investigated
Report phone number: (010) 68533533
TKAONTKAca-
8002-69663
Tip: This standard content only shows part of the intercepted content of the complete standard. If you need the complete standard, please go to the top to download the complete standard document for free.