I’ve written about the Hierarchy of Controls in past posts. I’ve focused on the engineering side of the control equation: Physical changes to machine design to eliminate hazards and mechanical or electrical control systems that can reduce risk.
The first two levels of the Hierarchy, Elimination/Substitution and Engineering Controls are typically more challenging to apply for most people because expert knowledge is required. These levels are also more effective in controlling risk than the subsequent levels.
The Third Level
The third level of the Hierarchy is Information for Use, sometimes abbreviated as ‘IFU.’ This level is deceptively simple and is frequently the level people want to jump to when the other controls seem too difficult to implement. Done well, information for use can significantly contribute to risk control. Unfortunately, it’s done poorly more often than it’s done well.
Information for use includes:
- Instructions and Manuals;
- Operator Device tags and Legend Plates;
- HMI screens;
- Hazard Warning signs and labels;
- Training Materials (text, video, audio) and Training (face-to-face, webinars, self-directed);
- Sales and marketing materials.
Information for use is needed in all the stages of the product life cycle: Transportation, Installation, Commissioning, Use, Maintenance, Service, Decommissioning and Disposal . The information and presentation may differ at each life cycle stage. In every stage, it can significantly contribute to risk reduction by communicating the safe approach to the tasks in that stage and the related risks. The information should include the intended use and foreseeable product misuse. This is a legal requirement in the EU  and is a best practice in North America.
In this article, I’m going to focus on instruction manuals. If you’re interested in Hazard Warnings, including signs, labels, and integration into manuals and instructions, watch for a future post on this topic.
Legal requirements and standards
In the European Union, the legal obligation to provide information with a product is enshrined in law .
No North American jurisdictions make an explicit requirement for instructions or information for use in law, but many product-specific standards include requirements for the content of manuals.
CSA Z432  outlines requirements for content in Clause 17 and in EN 60204-1 . IEC 62079 , provides guidance on the design and presentation of instructions. ANSI Z535.6 , provides specific instructions on the inclusion of hazard warnings in manuals and instructions.
Training requirements are also discussed in CSA Z432 , Clause 18.
In the USA, providing information for use with a product is considered to be sound “due diligence,” however, providing information on residual risk is often seen by liability lawyers as dangerous since manufacturers are providing information, in writing, that their product is not “perfectly safe.” If you’ve read anything I’ve written on risk assessment, you’ll know there is no such state as “perfectly safe.” If a hazard exists, a potential for harm exists, a probability can be assessed and thus risk exists, however remote that risk may be. I think that this argument by some liability lawyers is fatuous at best.
Kenneth Ross, one of the leading product liability lawyers in the USA, discusses the requirements for warnings and instructions in an article published in 2007 . In the article, he explains the US requirements:
Product sellers must provide “reasonable warnings and instructions” about their products’ risks. The law differentiates warnings and instructions as follows:
Warnings alert users and consumers to the existence and nature of product risks so that they can prevent harm either by appropriate conduct during use or consumption or by choosing not to use or consume.
Instructions inform persons how to use and consume products safely.
A court has held that warnings, standing alone, may have no practical relevance without instructions and that instructions without warnings may not be adequate.
Therefore, when the law talks about the “duty to warn,” it includes warnings on products in the form of warning labels; safety information in instructions; instructions that affirmatively describe how to use a product safely; and safety information in other means of communication such as videos, advertising, catalogs and websites.
The law says that a manufacturer has a duty to warn where: (1) the product is dangerous; (2) the danger is or should be known by the manufacturer; (3) the danger is present when the product is used in the usual and expected manner; and (4) the danger is not obvious or well known to the user.?Kenneth Ross
This practical and sensible approach is very similar to that in the EU. Note the requirement that instructions affirmatively describe how to use a product safely. The old list of “don’ts” doesn’t cut it – you must tell your user how to use the product affirmatively.
So why is it that so many manufacturers settle for manuals that are barely second best? In many companies, the documentation function is:
- not seen to add value to the product;
- not understood to have legal import in limiting product liability;
- given little effort.
The perception seems that manuals are produced primarily to fill filing cabinets and that customers don’t use the information provided. This leads to manuals written after the fact by engineers, or worse, the role of “technical writer” is seen to be an entry-level position often filled by interns or co-op students, with little oversight by qualified people. Technical writing requires a specific skill set beyond the ability to write well and can include instructional and graphic design elements.
End-user training is frequently given even less thought than the manuals. When designed together, the manual will support the training program, and the trainers can use the manual as one of the primary training tools. This provides continuity and ensures that the training process is properly documented.
My experience is that few engineers are excellent writers. There are some, no doubt. Writing manuals takes a sound understanding of educational theory, including an understanding of the audience to whom the material is directed. The level of technical sophistication required for a simple household product is completely different from that required for the technical support manual for an industrial welding laser.
The engineers designing and integrating an industrial system are often too close to the product’s design to write effectively to the target audience. Assumptions about the level of education the user will have are often incorrect, and key steps may be skipped because they are assumed to be “common knowledge.”
Quality documentation is also a customer service issue. Products that are well documented require less customer service support, and when customers do need support, they are generally more satisfied with the result.
New Delivery Methods
The delivery methods for technical documents have changed considerably in recent years. Large, ring-bound paper manuals are being displaced by online, interactive documentation that can be accessed at the user interface. The use of PDF-format manuals has jumped. PDF and ebook formats bring the ability to link error messages generated by the control system to the manual sections related to that aspect of the system. Video and animations can be added that provide an at-a-glance understanding of the operation of the machinery. WiFi networks in industrial facilities, along with the acceptance of mobile pad-computing devices like the Apple iPad, mean users can have the instructions where they need them, and technicians and service personnel can take the manual with them to the area where a problem exists and can use the documents even in very low-light conditions.
Finding technical writing resources can be challenging, particularly if you want to move away from paper to electronic documentation. The standards mentioned in this article are a good place to start.
Documentation can range from writing to technical illustrations, animation and video production. Finding individuals who can provide you with professional services in these areas promptly and at a reasonable price is not easy. If you need assistance ranging from a few questions that need answers to hiring a technical writer, Compliance InSight Consulting can help. Contact me for more information!
Are your product manuals as good as they could be? What challenges have you had with getting them written or used? Add your comments below!
© 2012 – 2022, Compliance inSight Consulting Inc.
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.